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.

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)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required

fromJsonString(json_string)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required

fromXmlFile(path)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required

fromXmlString(xml_string)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required

toXmlFile(filename)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required

toXmlString()

Serializes this object to an XML string.

Returns:

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

setID(value)

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

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()

Resets the ID attribute to an unset state.

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

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)

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

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

setPresetPinholeSizeUnit(value)

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

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()

Resets the PresetPinholeSizeUnit attribute to an unset state.

No description available in the XSD standard.

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)

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

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()

Resets the PinholeSpacing attribute to an unset state.

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

hasPinholeSpacing()

Checks whether the optional 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 optional attribute has been set, false otherwise

setPinholeSpacingUnit(value)

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

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()

Resets the PinholeSpacingUnit attribute to an unset state.

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

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)

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

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()

Resets the ScanDirectionality attribute to an unset state.

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.

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)

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

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()

Resets the IntegrationNumber attribute to an unset state.

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.

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)

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

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()

Resets the IntegrationUnit attribute to an unset state.

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.

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)

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

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()

Resets the IntegrationMethod attribute to an unset state.

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.

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)

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

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

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

Returns:

Type	Description
float	The value of the attribute

setZoomAreaWidth(value)

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

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()

Resets the ZoomAreaWidth attribute to an unset state.

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

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)

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

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()

Resets the ZoomAreaHeight attribute to an unset state.

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

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)

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

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

setScanFormat(value)

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

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()

Resets the ScanFormat attribute to an unset state.

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.

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)

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

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()

Resets the MultiChannelMode attribute to an unset state.

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.

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)

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

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

setScanTimeUnit(value)

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

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()

Resets the ScanTimeUnit attribute to an unset state.

No description available in the XSD standard.

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)

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

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()

Resets the ConfocalFieldNumber attribute to an unset state.

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.

hasConfocalFieldNumber()

Checks whether the optional 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 optional attribute has been set, false otherwise

setRotation(value)

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

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()

Resets the Rotation attribute to an unset state.

This field records the Rotation angle of the scan region.

hasRotation()

Checks whether the optional Rotation attribute is present.

This field records the Rotation angle of the scan region.

Returns:

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

setRotationUnit(value)

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

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()

Resets the RotationUnit attribute to an unset state.

No description available in the XSD standard.

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)

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

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()

Resets the ScanningFrequency attribute to an unset state.

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.

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