ConfocalScanner_Type

Bases: NBOBaseClass

Represents the XML complex type ConfocalScanner.

According to ISO-10934-2-2007, a confocal microscope is a microscope in which, ideally, a point in the object plane is illuminated by a diffraction-limited spot of light, and light emanating from this point is focused upon and detected from an area smaller than the central area of the diffraction disc. The confocal principle leads to improved axial resolution by suppression of light from out-of-focus planes. In order to utilize this modality, a Confocal Scanner is used to form an Image of an extended Specimen region by controlling the direction of an outgoing Laser beam, the position of the Specimen or the location of the illuminated and detected spots simultaneously. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

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.

A Unique Identifier for this component.

Parameters:

Name	Type	Description	Default
value	ConfocalScannerID_Type	The value to set	required

getID()

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

Type	Description
ConfocalScannerID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

hasID()

Checks whether the optional ID attribute is present.

A Unique Identifier for this component.

Returns:

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

setName(value)

Sets the value of the Name attribute.

A User-defined Name for this component.

Parameters:

Name	Type	Description	Default
value	Denomination_Type	The value to set	required

getName()

Returns the value of the Name attribute.

A User-defined Name for this component.

Returns:

Type	Description
Denomination_Type	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

A User-defined Name for this component.

hasName()

Checks whether the optional Name attribute is present.

A User-defined Name for this component.

Returns:

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

setNrOfScanPoints(value)

Sets the value of the NrOfScanPoints attribute.

This field records the number of scanning points available for this scan head.

Parameters:

Name	Type	Description	Default
value	int	The value to set	required

getNrOfScanPoints()

Returns the value of the NrOfScanPoints attribute.

This field records the number of scanning points available for this scan head.

Returns:

Type	Description
int	The value of the attribute

setMaxFrameRate(value)

Sets the value of the MaxFrameRate attribute.

This field captures the Maximum full Frame Rate available for this device, as specificed by the Manufacturer.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getMaxFrameRate()

Returns the value of the MaxFrameRate attribute.

This field captures the Maximum full Frame Rate available for this device, as specificed by the Manufacturer.

Returns:

Type	Description
float	The value of the attribute

resetMaxFrameRate()

Resets the MaxFrameRate attribute to an unset state.

This field captures the Maximum full Frame Rate available for this device, as specificed by the Manufacturer.

hasMaxFrameRate()

Checks whether the optional MaxFrameRate attribute is present.

This field captures the Maximum full Frame Rate available for this device, as specificed by the Manufacturer.

Returns:

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

setMaxFrameRateUnit(value)

Sets the value of the MaxFrameRateUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsFrequency_Type	The value to set	required

getMaxFrameRateUnit()

Returns the value of the MaxFrameRateUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsFrequency_Type	The value of the attribute

resetMaxFrameRateUnit()

Resets the MaxFrameRateUnit attribute to an unset state.

No description available in the XSD standard.

hasMaxFrameRateUnit()

Checks whether the optional MaxFrameRateUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setPointsConfiguration(value)

Sets the value of the PointsConfiguration attribute.

This field records a description of the arrangement of scan points (can be spiral, linear, grid, other)

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getPointsConfiguration()

Returns the value of the PointsConfiguration attribute.

This field records a description of the arrangement of scan points (can be spiral, linear, grid, other)

Returns:

Type	Description
string	The value of the attribute

resetPointsConfiguration()

Resets the PointsConfiguration attribute to an unset state.

This field records a description of the arrangement of scan points (can be spiral, linear, grid, other)

hasPointsConfiguration()

Checks whether the optional PointsConfiguration attribute is present.

This field records a description of the arrangement of scan points (can be spiral, linear, grid, other)

Returns:

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

setAnnotationRef(value)

Sets the value of the AnnotationRef element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	AnnotationRef	The value to set	required

getAnnotationRef()

Returns the value of the AnnotationRef element.

No description available in the XSD standard.

Returns:

Type	Description
AnnotationRef	The value of the element

resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

No description available in the XSD standard.

hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

No description available in the XSD standard.

Returns:

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