DeformableMirror

Bases: ElectroOpticalDevice_Type

Represents the XML element DeformableMirror.

A Deformable Mirror (DM) is a Mechano Electro-Optical Device that has a controllable spatially varying mirror surface to modulate the wavefront of a beam of light impinging on it. This type of device is 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 Deformable Mirror.

Parameters:

Name	Type	Description	Default
value	DeformableMirrorType_Type	The value to set	required

getType()

Returns the value of the Type attribute.

This field records the type of this Deformable Mirror.

Returns:

Type	Description
DeformableMirrorType_Type	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

This field records the type of this Deformable Mirror.

hasType()

Checks whether the optional Type attribute is present.

This field records the type of this Deformable Mirror.

Returns:

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

setActuators(value)

Sets the value of the Actuators attribute.

This field records the number of Actuators available for this device.

Parameters:

Name	Type	Description	Default
value	int	The value to set	required

getActuators()

Returns the value of the Actuators attribute.

This field records the number of Actuators available for this device.

Returns:

Type	Description
int	The value of the attribute

resetActuators()

Resets the Actuators attribute to an unset state.

This field records the number of Actuators available for this device.

hasActuators()

Checks whether the optional Actuators attribute is present.

This field records the number of Actuators available for this device.

Returns:

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

setActuatorPitch(value)

Sets the value of the ActuatorPitch attribute.

This field records the distance between the center of each Actuator in this device.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getActuatorPitch()

Returns the value of the ActuatorPitch attribute.

This field records the distance between the center of each Actuator in this device.

Returns:

Type	Description
float	The value of the attribute

resetActuatorPitch()

Resets the ActuatorPitch attribute to an unset state.

This field records the distance between the center of each Actuator in this device.

hasActuatorPitch()

Checks whether the optional ActuatorPitch attribute is present.

This field records the distance between the center of each Actuator in this device.

Returns:

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

setActuatorPitchUnit(value)

Sets the value of the ActuatorPitchUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getActuatorPitchUnit()

Returns the value of the ActuatorPitchUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetActuatorPitchUnit()

Resets the ActuatorPitchUnit attribute to an unset state.

No description available in the XSD standard.

hasActuatorPitchUnit()

Checks whether the optional ActuatorPitchUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setActuatorStroke(value)

Sets the value of the ActuatorStroke attribute.

This field records the maximum possible Actuator displacement available for this device.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getActuatorStroke()

Returns the value of the ActuatorStroke attribute.

This field records the maximum possible Actuator displacement available for this device.

Returns:

Type	Description
float	The value of the attribute

resetActuatorStroke()

Resets the ActuatorStroke attribute to an unset state.

This field records the maximum possible Actuator displacement available for this device.

hasActuatorStroke()

Checks whether the optional ActuatorStroke attribute is present.

This field records the maximum possible Actuator displacement available for this device.

Returns:

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

setActuatorStrokeUnit(value)

Sets the value of the ActuatorStrokeUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getActuatorStrokeUnit()

Returns the value of the ActuatorStrokeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetActuatorStrokeUnit()

Resets the ActuatorStrokeUnit attribute to an unset state.

No description available in the XSD standard.

hasActuatorStrokeUnit()

Checks whether the optional ActuatorStrokeUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setResponseTime(value)

Sets the value of the ResponseTime attribute.

This field records the rate at which this Deformable Mirror can change patterns.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getResponseTime()

Returns the value of the ResponseTime attribute.

This field records the rate at which this Deformable Mirror can change patterns.

Returns:

Type	Description
float	The value of the attribute

resetResponseTime()

Resets the ResponseTime attribute to an unset state.

This field records the rate at which this Deformable Mirror can change patterns.

hasResponseTime()

Checks whether the optional ResponseTime attribute is present.

This field records the rate at which this Deformable Mirror can change patterns.

Returns:

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

setResponseTimeUnit(value)

Sets the value of the ResponseTimeUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getResponseTimeUnit()

Returns the value of the ResponseTimeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
string	The value of the attribute

resetResponseTimeUnit()

Resets the ResponseTimeUnit attribute to an unset state.

No description available in the XSD standard.

hasResponseTimeUnit()

Checks whether the optional ResponseTimeUnit attribute is present.

No description available in the XSD standard.

Returns:

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