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.
fromBase ( base )
staticmethod
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 )
setName ( value , validate = True )
setNrOfScanPoints ( value , validate = True )
setMaxFrameRate ( value , validate = True )
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
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
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 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 attribute has been set, false otherwise
setMaxFrameRateUnit ( value , validate = True )
setPointsConfiguration ( value , validate = True )
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
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
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 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 attribute has been set, false otherwise
getPointsConfigurationAllowedValues ()
staticmethod
Returns the allowed values for this attribut.
This field records a description of the arrangement of scan points (can be spiral, linear, grid, other)
Returns:
Type
Description
std::set< str,std::less< str >,std::allocator< str > >
The list of allowed values
setAnnotationRef ( value , validate = True )