RasterScanner
Bases: ConfocalScanner_Type
Represents the XML element RasterScanner.
A Raster Scanner is typically used for systematic periodic scanning (raster scanning) of the Laser beam or of the Specimen position, either in one or in two dimensions. 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 |
setType(value)
Sets the value of the Type attribute.
This field records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
RasterScannerType_Type
|
The value to set |
required |
getType()
Returns the value of the Type attribute.
This field records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.
Returns:
| Type | Description |
|---|---|
RasterScannerType_Type
|
The value of the attribute |
resetType()
Resets the Type attribute to an unset state.
This field records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.
hasType()
Checks whether the optional Type attribute is present.
This field records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setHorizontalScanningSpeed(value)
Sets the value of the HorizontalScanningSpeed attribute.
This field records the maximal Horizontal Scanning Speed of this device.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getHorizontalScanningSpeed()
Returns the value of the HorizontalScanningSpeed attribute.
This field records the maximal Horizontal Scanning Speed of this device.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetHorizontalScanningSpeed()
Resets the HorizontalScanningSpeed attribute to an unset state.
This field records the maximal Horizontal Scanning Speed of this device.
hasHorizontalScanningSpeed()
Checks whether the optional HorizontalScanningSpeed attribute is present.
This field records the maximal Horizontal Scanning Speed of this device.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setHorizontalScanningSpeedUnit(value)
Sets the value of the HorizontalScanningSpeedUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UnitsVelocity_Type
|
The value to set |
required |
getHorizontalScanningSpeedUnit()
Returns the value of the HorizontalScanningSpeedUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
UnitsVelocity_Type
|
The value of the attribute |
resetHorizontalScanningSpeedUnit()
Resets the HorizontalScanningSpeedUnit attribute to an unset state.
No description available in the XSD standard.
hasHorizontalScanningSpeedUnit()
Checks whether the optional HorizontalScanningSpeedUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setVerticalScanningSpeed(value)
Sets the value of the VerticalScanningSpeed attribute.
This field records the maximal Vertical Scanning Speed of this device.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getVerticalScanningSpeed()
Returns the value of the VerticalScanningSpeed attribute.
This field records the maximal Vertical Scanning Speed of this device.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetVerticalScanningSpeed()
Resets the VerticalScanningSpeed attribute to an unset state.
This field records the maximal Vertical Scanning Speed of this device.
hasVerticalScanningSpeed()
Checks whether the optional VerticalScanningSpeed attribute is present.
This field records the maximal Vertical Scanning Speed of this device.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setVerticalScanningSpeedUnit(value)
Sets the value of the VerticalScanningSpeedUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UnitsVelocity_Type
|
The value to set |
required |
getVerticalScanningSpeedUnit()
Returns the value of the VerticalScanningSpeedUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
UnitsVelocity_Type
|
The value of the attribute |
resetVerticalScanningSpeedUnit()
Resets the VerticalScanningSpeedUnit attribute to an unset state.
No description available in the XSD standard.
hasVerticalScanningSpeedUnit()
Checks whether the optional VerticalScanningSpeedUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |