ConfocalScannerSettings¶

Bases: Settings_Type

Represents the XML element ConfocalScannerSettings.

This element holds the Setting applied to a Confocal Scanner used during the Acquisiton of this Channel as well as a reference (the ID attribute) to the Confocal Scanner in question.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a ConfocalScannerSettings.

Parameters:

Name	Type	Description	Default
`base`	`NBOBaseClass`	The base class to cast	required

Returns:

Type	Description
`ConfocalScannerSettings`	The casted element, or nullptr if the cast fails

`getTypeName()` ¶

Returns the class type name.

Returns:

Type	Description
`string`	The class type name

`getXMLName()` ¶

Returns the XML element name corresponding to this class.

Returns:

Type	Description
`string`	The XML element name

`getNBOType()` ¶

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
`int`	The NBO Type value

`getChildren()` ¶

Returns a list of all classes derived from this class.

Returns:

Type	Description
`List[NBOBaseClass]`	The list of derived classes

`getSubElements()` ¶

Returns a list of all child elements contained in this class.

Returns:

Type	Description
`List[NBOBaseClass]`	The list of child classes

`fromJsonFile(path, validate=True)` ¶

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the JSON file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromJsonString(json_string, validate=True)` ¶

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
`json_string`	`string`	The JSON content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlFile(path, validate=True)` ¶

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlString(xml_string, validate=True)` ¶

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
`xml_string`	`string`	The XML content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlFile(filename, validate=True)` ¶

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
`filename`	`string`	The path to the output XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlString(validate=True)` ¶

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

Returns:

Type	Description
`string`	A string containing the XML representation of this object

`setID(value, validate=True)` ¶

Sets the value of the ID attribute.

This is the Unique Identifier of the device used in this case.

Parameters:

Name	Type	Description	Default
`value`	`ConfocalScannerID_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getID()` ¶

Returns the value of the ID attribute.

This is the Unique Identifier of the device used in this case.

Returns:

Type	Description
`ConfocalScannerID_Type`	The value of the attribute

`resetID()` ¶

`hasID()` ¶

Checks whether the optional ID attribute is present.

This is the Unique Identifier of the device used in this case.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setPresetPinholeSize(value, validate=True)` ¶

Sets the value of the PresetPinholeSize attribute.

In case this Confocal Scanner (i.e., Spinning disk, Swept-field, or other Multi-point scanners) has several fixed Pinhole Sizes to choose from, this field records the Pinhole Size that was set during the Acquisition of this Channel.

Parameters:

Name	Type	Description	Default
`value`	`float`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getPresetPinholeSize()` ¶

Returns the value of the PresetPinholeSize attribute.

In case this Confocal Scanner (i.e., Spinning disk, Swept-field, or other Multi-point scanners) has several fixed Pinhole Sizes to choose from, this field records the Pinhole Size that was set during the Acquisition of this Channel.

Returns:

Type	Description
`float`	The value of the attribute

`resetPresetPinholeSize()` ¶

`hasPresetPinholeSize()` ¶

Checks whether the PresetPinholeSize attribute is present.

In case this Confocal Scanner (i.e., Spinning disk, Swept-field, or other Multi-point scanners) has several fixed Pinhole Sizes to choose from, this field records the Pinhole Size that was set during the Acquisition of this Channel.

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`setPresetPinholeSizeUnit(value, validate=True)` ¶

Sets the value of the PresetPinholeSizeUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
`value`	`UnitsLength_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getPresetPinholeSizeUnit()` ¶

Returns the value of the PresetPinholeSizeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
`UnitsLength_Type`	The value of the attribute

`resetPresetPinholeSizeUnit()` ¶

`hasPresetPinholeSizeUnit()` ¶

Checks whether the optional PresetPinholeSizeUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setPinholeSpacing(value, validate=True)` ¶

Sets the value of the PinholeSpacing attribute.

If applicable, this field records the Spacing between individual Pinholes that was set during the Acquisition of this Channel.

Parameters:

Name	Type	Description	Default
`value`	`float`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getPinholeSpacing()` ¶

Returns the value of the PinholeSpacing attribute.

If applicable, this field records the Spacing between individual Pinholes that was set during the Acquisition of this Channel.

Returns:

Type	Description
`float`	The value of the attribute

`resetPinholeSpacing()` ¶

`hasPinholeSpacing()` ¶

Checks whether the PinholeSpacing attribute is present.

If applicable, this field records the Spacing between individual Pinholes that was set during the Acquisition of this Channel.

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`setPinholeSpacingUnit(value, validate=True)` ¶

Sets the value of the PinholeSpacingUnit attribute.

If applicable, this field records the Spacing between individual Pinholes that was set during the Acquisition of this Channel.

Parameters:

Name	Type	Description	Default
`value`	`UnitsLength_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getPinholeSpacingUnit()` ¶

Returns the value of the PinholeSpacingUnit attribute.

If applicable, this field records the Spacing between individual Pinholes that was set during the Acquisition of this Channel.

Returns:

Type	Description
`UnitsLength_Type`	The value of the attribute

`resetPinholeSpacingUnit()` ¶

`hasPinholeSpacingUnit()` ¶

Checks whether the optional PinholeSpacingUnit attribute is present.

If applicable, this field records the Spacing between individual Pinholes that was set during the Acquisition of this Channel.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setScanDirectionality(value, validate=True)` ¶

Sets the value of the ScanDirectionality attribute.

This field records the ScanDirectionality that was set for this device during Acquisition. In Unidirectional scan mode, data are only acquired while the laser beam moves in one direction. In Bidirectional scan mode, one line is scanned in one direction, and the next line in the opposite direction. In other words, the return run, or flyback, of the laser beam is used for recording data as well, thus increasing the scanning frequency when using bidirectional scan mode. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Parameters:

Name	Type	Description	Default
`value`	`ConfocalScanDirectionality_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getScanDirectionality()` ¶

Returns the value of the ScanDirectionality attribute.

This field records the ScanDirectionality that was set for this device during Acquisition. In Unidirectional scan mode, data are only acquired while the laser beam moves in one direction. In Bidirectional scan mode, one line is scanned in one direction, and the next line in the opposite direction. In other words, the return run, or flyback, of the laser beam is used for recording data as well, thus increasing the scanning frequency when using bidirectional scan mode. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Returns:

Type	Description
`ConfocalScanDirectionality_Type`	The value of the attribute

`resetScanDirectionality()` ¶

`hasScanDirectionality()` ¶

Checks whether the optional ScanDirectionality attribute is present.

This field records the ScanDirectionality that was set for this device during Acquisition. In Unidirectional scan mode, data are only acquired while the laser beam moves in one direction. In Bidirectional scan mode, one line is scanned in one direction, and the next line in the opposite direction. In other words, the return run, or flyback, of the laser beam is used for recording data as well, thus increasing the scanning frequency when using bidirectional scan mode. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setIntegrationNumber(value, validate=True)` ¶

Sets the value of the IntegrationNumber attribute.

Signal integration is generally utilized to improve the overall signal-to-noise ratio of the resulting Image. This field records the number of sequential Scanning Units (Line, Frame or Stack) that have been integrated for the Acquisition of this Channel.

Parameters:

Name	Type	Description	Default
`value`	`PositiveInt_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getIntegrationNumber()` ¶

Returns the value of the IntegrationNumber attribute.

Signal integration is generally utilized to improve the overall signal-to-noise ratio of the resulting Image. This field records the number of sequential Scanning Units (Line, Frame or Stack) that have been integrated for the Acquisition of this Channel.

Returns:

Type	Description
`PositiveInt_Type`	The value of the attribute

`resetIntegrationNumber()` ¶

`hasIntegrationNumber()` ¶

Checks whether the optional IntegrationNumber attribute is present.

Signal integration is generally utilized to improve the overall signal-to-noise ratio of the resulting Image. This field records the number of sequential Scanning Units (Line, Frame or Stack) that have been integrated for the Acquisition of this Channel.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setIntegrationUnit(value, validate=True)` ¶

Sets the value of the IntegrationUnit attribute.

Signal integration is generally utilized to improve the overall signal-to-noise ratio of the resulting Image. This field refers to the nature of the Scanning Units used as the basis of signal integration. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Parameters:

Name	Type	Description	Default
`value`	`ScanIntegrationMode_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getIntegrationUnit()` ¶

Returns the value of the IntegrationUnit attribute.

Signal integration is generally utilized to improve the overall signal-to-noise ratio of the resulting Image. This field refers to the nature of the Scanning Units used as the basis of signal integration. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Returns:

Type	Description
`ScanIntegrationMode_Type`	The value of the attribute

`resetIntegrationUnit()` ¶

`hasIntegrationUnit()` ¶

Checks whether the optional IntegrationUnit attribute is present.

Signal integration is generally utilized to improve the overall signal-to-noise ratio of the resulting Image. This field refers to the nature of the Scanning Units used as the basis of signal integration. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setIntegrationMethod(value, validate=True)` ¶

Sets the value of the IntegrationMethod attribute.

Signal integration is generally utilized to improve the overall signal-to-noise ratio of the resulting Image. This field defines the signal Integration Method utilized for the Acquisition of this Channel.

Parameters:

Name	Type	Description	Default
`value`	`ScanIntegrationMethod_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getIntegrationMethod()` ¶

Returns the value of the IntegrationMethod attribute.

Signal integration is generally utilized to improve the overall signal-to-noise ratio of the resulting Image. This field defines the signal Integration Method utilized for the Acquisition of this Channel.

Returns:

Type	Description
`ScanIntegrationMethod_Type`	The value of the attribute

`resetIntegrationMethod()` ¶

`hasIntegrationMethod()` ¶

Checks whether the optional IntegrationMethod attribute is present.

Signal integration is generally utilized to improve the overall signal-to-noise ratio of the resulting Image. This field defines the signal Integration Method utilized for the Acquisition of this Channel.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setEffectiveZoom(value, validate=True)` ¶

Sets the value of the EffectiveZoom attribute.

This field describes the Effective Zoom factor that was utilized for the acquisition of this Image (e.g., zoom = 1.3). In confocal microscopy, it is possible to set a given hardware-based Zoom factor, aka "Confocal Zoom" or "Scan Zoom", by reducing the angle at which the scanning mirrors operate. As a result, the scanned area will be reduced in size, which (because the pixel areas associated with the scan are kept constant) will decrease the effective size of the portion of the sample that is projected on each pixel thus increasing the effective resolving power of the system. For example, with a 512x512 pixel area, and with a 40x objective, zoom 1 we result in a pixel size of 732nm, while zoom 10 will reduce the pixel size to 73nm).In confocal microscopy, it is possible to set a given hardware-based Zoom factor, aka "Confocal Zoom" or "Scan Zoom", by reducing the angle at which the scanning mirrors operate. As a result, the scanned area will be reduced in size, which (because the pixel areas associated with the scan are kept constant) will decrease the effective size of the portion of the sample that is projected on each pixel thus increasing the effective resolving power of the system. For example, with a 512x512 pixel area, and with a 40x objective, zoom 1 we result in a pixel size of 732nm, while zoom 10 will reduce the pixel size to 73nm).

Parameters:

Name	Type	Description	Default
`value`	`float`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getEffectiveZoom()` ¶

Returns the value of the EffectiveZoom attribute.

This field describes the Effective Zoom factor that was utilized for the acquisition of this Image (e.g., zoom = 1.3). In confocal microscopy, it is possible to set a given hardware-based Zoom factor, aka "Confocal Zoom" or "Scan Zoom", by reducing the angle at which the scanning mirrors operate. As a result, the scanned area will be reduced in size, which (because the pixel areas associated with the scan are kept constant) will decrease the effective size of the portion of the sample that is projected on each pixel thus increasing the effective resolving power of the system. For example, with a 512x512 pixel area, and with a 40x objective, zoom 1 we result in a pixel size of 732nm, while zoom 10 will reduce the pixel size to 73nm).In confocal microscopy, it is possible to set a given hardware-based Zoom factor, aka "Confocal Zoom" or "Scan Zoom", by reducing the angle at which the scanning mirrors operate. As a result, the scanned area will be reduced in size, which (because the pixel areas associated with the scan are kept constant) will decrease the effective size of the portion of the sample that is projected on each pixel thus increasing the effective resolving power of the system. For example, with a 512x512 pixel area, and with a 40x objective, zoom 1 we result in a pixel size of 732nm, while zoom 10 will reduce the pixel size to 73nm).

Returns:

Type	Description
`float`	The value of the attribute

`resetEffectiveZoom()` ¶

Resets the EffectiveZoom attribute to an unset state.

This field describes the Effective Zoom factor that was utilized for the acquisition of this Image (e.g., zoom = 1.3). In confocal microscopy, it is possible to set a given hardware-based Zoom factor, aka "Confocal Zoom" or "Scan Zoom", by reducing the angle at which the scanning mirrors operate. As a result, the scanned area will be reduced in size, which (because the pixel areas associated with the scan are kept constant) will decrease the effective size of the portion of the sample that is projected on each pixel thus increasing the effective resolving power of the system. For example, with a 512x512 pixel area, and with a 40x objective, zoom 1 we result in a pixel size of 732nm, while zoom 10 will reduce the pixel size to 73nm).In confocal microscopy, it is possible to set a given hardware-based Zoom factor, aka "Confocal Zoom" or "Scan Zoom", by reducing the angle at which the scanning mirrors operate. As a result, the scanned area will be reduced in size, which (because the pixel areas associated with the scan are kept constant) will decrease the effective size of the portion of the sample that is projected on each pixel thus increasing the effective resolving power of the system. For example, with a 512x512 pixel area, and with a 40x objective, zoom 1 we result in a pixel size of 732nm, while zoom 10 will reduce the pixel size to 73nm).

`hasEffectiveZoom()` ¶

Checks whether the EffectiveZoom attribute is present.

This field describes the Effective Zoom factor that was utilized for the acquisition of this Image (e.g., zoom = 1.3). In confocal microscopy, it is possible to set a given hardware-based Zoom factor, aka "Confocal Zoom" or "Scan Zoom", by reducing the angle at which the scanning mirrors operate. As a result, the scanned area will be reduced in size, which (because the pixel areas associated with the scan are kept constant) will decrease the effective size of the portion of the sample that is projected on each pixel thus increasing the effective resolving power of the system. For example, with a 512x512 pixel area, and with a 40x objective, zoom 1 we result in a pixel size of 732nm, while zoom 10 will reduce the pixel size to 73nm).In confocal microscopy, it is possible to set a given hardware-based Zoom factor, aka "Confocal Zoom" or "Scan Zoom", by reducing the angle at which the scanning mirrors operate. As a result, the scanned area will be reduced in size, which (because the pixel areas associated with the scan are kept constant) will decrease the effective size of the portion of the sample that is projected on each pixel thus increasing the effective resolving power of the system. For example, with a 512x512 pixel area, and with a 40x objective, zoom 1 we result in a pixel size of 732nm, while zoom 10 will reduce the pixel size to 73nm).

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`setZoomAreaWidth(value, validate=True)` ¶

Sets the value of the ZoomAreaWidth attribute.

This field records the Width of the Zoom Area that was scanned during the Acquisition of this Channel, expressed in Pixels.

Parameters:

Name	Type	Description	Default
`value`	`PositiveInt_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getZoomAreaWidth()` ¶

Returns the value of the ZoomAreaWidth attribute.

This field records the Width of the Zoom Area that was scanned during the Acquisition of this Channel, expressed in Pixels.

Returns:

Type	Description
`PositiveInt_Type`	The value of the attribute

`resetZoomAreaWidth()` ¶

`hasZoomAreaWidth()` ¶

Checks whether the optional ZoomAreaWidth attribute is present.

This field records the Width of the Zoom Area that was scanned during the Acquisition of this Channel, expressed in Pixels.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setZoomAreaHeight(value, validate=True)` ¶

Sets the value of the ZoomAreaHeight attribute.

This field records the Height of the Zoom Area that was scanned during the Acquisition of this Channel, expressed in Pixels.

Parameters:

Name	Type	Description	Default
`value`	`PositiveInt_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getZoomAreaHeight()` ¶

Returns the value of the ZoomAreaHeight attribute.

This field records the Height of the Zoom Area that was scanned during the Acquisition of this Channel, expressed in Pixels.

Returns:

Type	Description
`PositiveInt_Type`	The value of the attribute

`resetZoomAreaHeight()` ¶

`hasZoomAreaHeight()` ¶

Checks whether the optional ZoomAreaHeight attribute is present.

This field records the Height of the Zoom Area that was scanned during the Acquisition of this Channel, expressed in Pixels.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setDescanned(value, validate=True)` ¶

Sets the value of the Descanned attribute.

This field indicates whether or not the Acquisition of this Image involved descanning.

Parameters:

Name	Type	Description	Default
`value`	`boolean`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getDescanned()` ¶

Returns the value of the Descanned attribute.

This field indicates whether or not the Acquisition of this Image involved descanning.

Returns:

Type	Description
`boolean`	The value of the attribute

`resetDescanned()` ¶

`hasDescanned()` ¶

Checks whether the Descanned attribute is present.

This field indicates whether or not the Acquisition of this Image involved descanning.

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`setScanFormat(value, validate=True)` ¶

Sets the value of the ScanFormat attribute.

This field defines the format of the scanned element utilized for this Acquisition. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Parameters:

Name	Type	Description	Default
`value`	`ConfocalScanFormat_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getScanFormat()` ¶

Returns the value of the ScanFormat attribute.

This field defines the format of the scanned element utilized for this Acquisition. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Returns:

Type	Description
`ConfocalScanFormat_Type`	The value of the attribute

`resetScanFormat()` ¶

`hasScanFormat()` ¶

Checks whether the optional ScanFormat attribute is present.

This field defines the format of the scanned element utilized for this Acquisition. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setMultiChannelMode(value, validate=True)` ¶

Sets the value of the MultiChannelMode attribute.

This field defines whether the the the Aquisiton of Multiple Channels for this Image happened in a Parallel (i.e., multiple channels acquired at the same time), or Sequentail (i.e., one channel after the other) manner.

Parameters:

Name	Type	Description	Default
`value`	`ConfocalMultiChannelMode_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getMultiChannelMode()` ¶

Returns the value of the MultiChannelMode attribute.

This field defines whether the the the Aquisiton of Multiple Channels for this Image happened in a Parallel (i.e., multiple channels acquired at the same time), or Sequentail (i.e., one channel after the other) manner.

Returns:

Type	Description
`ConfocalMultiChannelMode_Type`	The value of the attribute

`resetMultiChannelMode()` ¶

`hasMultiChannelMode()` ¶

Checks whether the optional MultiChannelMode attribute is present.

This field defines whether the the the Aquisiton of Multiple Channels for this Image happened in a Parallel (i.e., multiple channels acquired at the same time), or Sequentail (i.e., one channel after the other) manner.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setScanTime(value, validate=True)` ¶

Sets the value of the ScanTime attribute.

This records the time in seconds required to acquire a given number of lines, frames or stacks including the time required for repositioning the scanning device to the starting point. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Parameters:

Name	Type	Description	Default
`value`	`float`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getScanTime()` ¶

Returns the value of the ScanTime attribute.

This records the time in seconds required to acquire a given number of lines, frames or stacks including the time required for repositioning the scanning device to the starting point. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Returns:

Type	Description
`float`	The value of the attribute

`resetScanTime()` ¶

`hasScanTime()` ¶

Checks whether the ScanTime attribute is present.

This records the time in seconds required to acquire a given number of lines, frames or stacks including the time required for repositioning the scanning device to the starting point. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`setScanTimeUnit(value, validate=True)` ¶

Sets the value of the ScanTimeUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
`value`	`UnitsTime_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getScanTimeUnit()` ¶

Returns the value of the ScanTimeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
`UnitsTime_Type`	The value of the attribute

`resetScanTimeUnit()` ¶

`hasScanTimeUnit()` ¶

Checks whether the optional ScanTimeUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setConfocalFieldNumber(value, validate=True)` ¶

Sets the value of the ConfocalFieldNumber attribute.

This field recors the Field Number of the Confocal scan optic is expressed as the objective magnification times the maximum diameter of the scanned field; [mm], obtained without shifting the position of the specimen and without stitching single images into a total larger image. Because images generally have a square format, the diameter of the scanned field is equals to the square root of 2 times the length of X dimension of the scanned field. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Parameters:

Name	Type	Description	Default
`value`	`float`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getConfocalFieldNumber()` ¶

Returns the value of the ConfocalFieldNumber attribute.

This field recors the Field Number of the Confocal scan optic is expressed as the objective magnification times the maximum diameter of the scanned field; [mm], obtained without shifting the position of the specimen and without stitching single images into a total larger image. Because images generally have a square format, the diameter of the scanned field is equals to the square root of 2 times the length of X dimension of the scanned field. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Returns:

Type	Description
`float`	The value of the attribute

`resetConfocalFieldNumber()` ¶

`hasConfocalFieldNumber()` ¶

Checks whether the ConfocalFieldNumber attribute is present.

This field recors the Field Number of the Confocal scan optic is expressed as the objective magnification times the maximum diameter of the scanned field; [mm], obtained without shifting the position of the specimen and without stitching single images into a total larger image. Because images generally have a square format, the diameter of the scanned field is equals to the square root of 2 times the length of X dimension of the scanned field. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`setRotation(value, validate=True)` ¶

Sets the value of the Rotation attribute.

This field records the Rotation angle of the scan region.

Parameters:

Name	Type	Description	Default
`value`	`float`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getRotation()` ¶

Returns the value of the Rotation attribute.

This field records the Rotation angle of the scan region.

Returns:

Type	Description
`float`	The value of the attribute

`resetRotation()` ¶

`hasRotation()` ¶

Checks whether the Rotation attribute is present.

This field records the Rotation angle of the scan region.

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`setRotationUnit(value, validate=True)` ¶

Sets the value of the RotationUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
`value`	`UnitsAngle_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getRotationUnit()` ¶

Returns the value of the RotationUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
`UnitsAngle_Type`	The value of the attribute

`resetRotationUnit()` ¶

`hasRotationUnit()` ¶

Checks whether the optional RotationUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setScanningFrequency(value, validate=True)` ¶

Sets the value of the ScanningFrequency attribute.

This field records the Scanning Frequency is defined at the ratio between the Number of scanning element (Lines, Frames or Stacks) acquired and ScanTime. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Parameters:

Name	Type	Description	Default
`value`	`PercentFraction_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getScanningFrequency()` ¶

Returns the value of the ScanningFrequency attribute.

This field records the Scanning Frequency is defined at the ratio between the Number of scanning element (Lines, Frames or Stacks) acquired and ScanTime. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Returns:

Type	Description
`PercentFraction_Type`	The value of the attribute

`resetScanningFrequency()` ¶

`hasScanningFrequency()` ¶

Checks whether the optional ScanningFrequency attribute is present.

This field records the Scanning Frequency is defined at the ratio between the Number of scanning element (Lines, Frames or Stacks) acquired and ScanTime. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

ConfocalScannerSettings¶

fromBase(base) staticmethod ¶

getTypeName() ¶

getXMLName() ¶

getNBOType() ¶

getChildren() ¶

getSubElements() ¶

fromJsonFile(path, validate=True) ¶

fromJsonString(json_string, validate=True) ¶

fromXmlFile(path, validate=True) ¶

fromXmlString(xml_string, validate=True) ¶

toXmlFile(filename, validate=True) ¶

toXmlString(validate=True) ¶

setID(value, validate=True) ¶

getID() ¶

resetID() ¶

hasID() ¶

setPresetPinholeSize(value, validate=True) ¶

getPresetPinholeSize() ¶

resetPresetPinholeSize() ¶

hasPresetPinholeSize() ¶

setPresetPinholeSizeUnit(value, validate=True) ¶

getPresetPinholeSizeUnit() ¶

resetPresetPinholeSizeUnit() ¶

hasPresetPinholeSizeUnit() ¶

setPinholeSpacing(value, validate=True) ¶

getPinholeSpacing() ¶

resetPinholeSpacing() ¶

hasPinholeSpacing() ¶

setPinholeSpacingUnit(value, validate=True) ¶

getPinholeSpacingUnit() ¶

resetPinholeSpacingUnit() ¶

hasPinholeSpacingUnit() ¶

setScanDirectionality(value, validate=True) ¶

getScanDirectionality() ¶

resetScanDirectionality() ¶

hasScanDirectionality() ¶

setIntegrationNumber(value, validate=True) ¶

getIntegrationNumber() ¶

resetIntegrationNumber() ¶

hasIntegrationNumber() ¶

setIntegrationUnit(value, validate=True) ¶

getIntegrationUnit() ¶

resetIntegrationUnit() ¶

hasIntegrationUnit() ¶

setIntegrationMethod(value, validate=True) ¶

getIntegrationMethod() ¶

resetIntegrationMethod() ¶

hasIntegrationMethod() ¶

setEffectiveZoom(value, validate=True) ¶

getEffectiveZoom() ¶

resetEffectiveZoom() ¶

hasEffectiveZoom() ¶

setZoomAreaWidth(value, validate=True) ¶

getZoomAreaWidth() ¶

resetZoomAreaWidth() ¶

hasZoomAreaWidth() ¶

setZoomAreaHeight(value, validate=True) ¶

getZoomAreaHeight() ¶

resetZoomAreaHeight() ¶

hasZoomAreaHeight() ¶

setDescanned(value, validate=True) ¶

getDescanned() ¶

resetDescanned() ¶

hasDescanned() ¶

setScanFormat(value, validate=True) ¶

getScanFormat() ¶

resetScanFormat() ¶

hasScanFormat() ¶

setMultiChannelMode(value, validate=True) ¶

getMultiChannelMode() ¶

resetMultiChannelMode() ¶

hasMultiChannelMode() ¶

setScanTime(value, validate=True) ¶

getScanTime() ¶

resetScanTime() ¶

hasScanTime() ¶

setScanTimeUnit(value, validate=True) ¶

getScanTimeUnit() ¶

resetScanTimeUnit() ¶

`fromBase(base)` `staticmethod` ¶

`getTypeName()` ¶

`getXMLName()` ¶

`getNBOType()` ¶

`getChildren()` ¶

`getSubElements()` ¶

`fromJsonFile(path, validate=True)` ¶

`fromJsonString(json_string, validate=True)` ¶

`fromXmlFile(path, validate=True)` ¶

`fromXmlString(xml_string, validate=True)` ¶

`toXmlFile(filename, validate=True)` ¶

`toXmlString(validate=True)` ¶

`setID(value, validate=True)` ¶

`getID()` ¶

`resetID()` ¶

`hasID()` ¶

`setPresetPinholeSize(value, validate=True)` ¶

`getPresetPinholeSize()` ¶

`resetPresetPinholeSize()` ¶

`hasPresetPinholeSize()` ¶

`setPresetPinholeSizeUnit(value, validate=True)` ¶

`getPresetPinholeSizeUnit()` ¶

`resetPresetPinholeSizeUnit()` ¶

`hasPresetPinholeSizeUnit()` ¶

`setPinholeSpacing(value, validate=True)` ¶

`getPinholeSpacing()` ¶

`resetPinholeSpacing()` ¶

`hasPinholeSpacing()` ¶

`setPinholeSpacingUnit(value, validate=True)` ¶

`getPinholeSpacingUnit()` ¶

`resetPinholeSpacingUnit()` ¶

`hasPinholeSpacingUnit()` ¶

`setScanDirectionality(value, validate=True)` ¶

`getScanDirectionality()` ¶

`resetScanDirectionality()` ¶

`hasScanDirectionality()` ¶

`setIntegrationNumber(value, validate=True)` ¶

`getIntegrationNumber()` ¶

`resetIntegrationNumber()` ¶

`hasIntegrationNumber()` ¶

`setIntegrationUnit(value, validate=True)` ¶

`getIntegrationUnit()` ¶

`resetIntegrationUnit()` ¶

`hasIntegrationUnit()` ¶

`setIntegrationMethod(value, validate=True)` ¶

`getIntegrationMethod()` ¶

`resetIntegrationMethod()` ¶

`hasIntegrationMethod()` ¶

`setEffectiveZoom(value, validate=True)` ¶

`getEffectiveZoom()` ¶

`resetEffectiveZoom()` ¶

`hasEffectiveZoom()` ¶

`setZoomAreaWidth(value, validate=True)` ¶

`getZoomAreaWidth()` ¶

`resetZoomAreaWidth()` ¶

`hasZoomAreaWidth()` ¶

`setZoomAreaHeight(value, validate=True)` ¶

`getZoomAreaHeight()` ¶

`resetZoomAreaHeight()` ¶

`hasZoomAreaHeight()` ¶

`setDescanned(value, validate=True)` ¶

`getDescanned()` ¶

`resetDescanned()` ¶

`hasDescanned()` ¶

`setScanFormat(value, validate=True)` ¶

`getScanFormat()` ¶

`resetScanFormat()` ¶

`hasScanFormat()` ¶

`setMultiChannelMode(value, validate=True)` ¶

`getMultiChannelMode()` ¶

`resetMultiChannelMode()` ¶

`hasMultiChannelMode()` ¶

`setScanTime(value, validate=True)` ¶

`getScanTime()` ¶

`resetScanTime()` ¶

`hasScanTime()` ¶

`setScanTimeUnit(value, validate=True)` ¶

`getScanTimeUnit()` ¶

`resetScanTimeUnit()` ¶

`hasScanTimeUnit()` ¶