WaveFrontSensor
Bases: Camera_Type
Represents the XML element WaveFrontSensor.
A two dimensional sensor for measuring the location of the wavefront, typically used in Adaptive Optics.
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 Wavefront Sensor.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
WFSType_Type
|
The value to set |
required |
getType()
Returns the value of the Type attribute.
This field records the type of this Wavefront Sensor.
Returns:
| Type | Description |
|---|---|
WFSType_Type
|
The value of the attribute |
resetType()
Resets the Type attribute to an unset state.
This field records the type of this Wavefront Sensor.
hasType()
Checks whether the optional Type attribute is present.
This field records the type of this Wavefront Sensor.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setAccuracy(value)
Sets the value of the Accuracy attribute.
This field records the specified Wavefront Accuracy of this sensor at Peak Wavelength (expressed as a fraction of the Wavelength).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
PercentFraction_Type
|
The value to set |
required |
getAccuracy()
Returns the value of the Accuracy attribute.
This field records the specified Wavefront Accuracy of this sensor at Peak Wavelength (expressed as a fraction of the Wavelength).
Returns:
| Type | Description |
|---|---|
PercentFraction_Type
|
The value of the attribute |
resetAccuracy()
Resets the Accuracy attribute to an unset state.
This field records the specified Wavefront Accuracy of this sensor at Peak Wavelength (expressed as a fraction of the Wavelength).
hasAccuracy()
Checks whether the optional Accuracy attribute is present.
This field records the specified Wavefront Accuracy of this sensor at Peak Wavelength (expressed as a fraction of the Wavelength).
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setSensitivity(value)
Sets the value of the Sensitivity attribute.
This field records the specified Wavefront Sensitivity of this sensor at Peak Wavelength (expressed as a fraction of the Wvelength).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
PercentFraction_Type
|
The value to set |
required |
getSensitivity()
Returns the value of the Sensitivity attribute.
This field records the specified Wavefront Sensitivity of this sensor at Peak Wavelength (expressed as a fraction of the Wvelength).
Returns:
| Type | Description |
|---|---|
PercentFraction_Type
|
The value of the attribute |
resetSensitivity()
Resets the Sensitivity attribute to an unset state.
This field records the specified Wavefront Sensitivity of this sensor at Peak Wavelength (expressed as a fraction of the Wvelength).
hasSensitivity()
Checks whether the optional Sensitivity attribute is present.
This field records the specified Wavefront Sensitivity of this sensor at Peak Wavelength (expressed as a fraction of the Wvelength).
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |