SpatialLightModulator¶

Bases: ElectroOpticalDevice_Type

Represents the XML element SpatialLightModulator.

A Spatial Light Modulator (SLM) is device that imposes a changeable spatially varying modulation on a beam of light. The modulation can be in Intensity or in Phase or both.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a SpatialLightModulator.

Parameters:

Name	Type	Description	Default
`base`	`NBOBaseClass`	The base class to cast	required

Returns:

Type	Description
`SpatialLightModulator`	The casted element, or nullptr if the cast fails

`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, validate=True)` ¶

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the JSON file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromJsonString(json_string, validate=True)` ¶

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
`json_string`	`string`	The JSON content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlFile(path, validate=True)` ¶

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlString(xml_string, validate=True)` ¶

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
`xml_string`	`string`	The XML content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlFile(filename, validate=True)` ¶

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
`filename`	`string`	The path to the output XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlString(validate=True)` ¶

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

Returns:

Type	Description
`string`	A string containing the XML representation of this object

`setType(value, validate=True)` ¶

Sets the value of the Type attribute.

This field records the category to which this Spatial Light Modulator belongs.

Parameters:

Name	Type	Description	Default
`value`	`SLMType_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getType()` ¶

Returns the value of the Type attribute.

This field records the category to which this Spatial Light Modulator belongs.

Returns:

Type	Description
`SLMType_Type`	The value of the attribute

`resetType()` ¶

`hasType()` ¶

Checks whether the optional Type attribute is present.

This field records the category to which this Spatial Light Modulator belongs.

Returns:

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

`setArrayWidth(value, validate=True)` ¶

Sets the value of the ArrayWidth attribute.

This field records the number of spatial elements (pixels) this Spatial Light Modulator contains in the X direction.

Parameters:

Name	Type	Description	Default
`value`	`NonNegativeInt_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getArrayWidth()` ¶

Returns the value of the ArrayWidth attribute.

This field records the number of spatial elements (pixels) this Spatial Light Modulator contains in the X direction.

Returns:

Type	Description
`NonNegativeInt_Type`	The value of the attribute

`resetArrayWidth()` ¶

`hasArrayWidth()` ¶

Checks whether the optional ArrayWidth attribute is present.

This field records the number of spatial elements (pixels) this Spatial Light Modulator contains in the X direction.

Returns:

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

`setArrayHeight(value, validate=True)` ¶

Sets the value of the ArrayHeight attribute.

This field records the number of spatial elements (pixels) this Spatial Light Modulator contains in the Y direction.

Parameters:

Name	Type	Description	Default
`value`	`NonNegativeInt_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getArrayHeight()` ¶

Returns the value of the ArrayHeight attribute.

This field records the number of spatial elements (pixels) this Spatial Light Modulator contains in the Y direction.

Returns:

Type	Description
`NonNegativeInt_Type`	The value of the attribute

`resetArrayHeight()` ¶

`hasArrayHeight()` ¶

Checks whether the optional ArrayHeight attribute is present.

This field records the number of spatial elements (pixels) this Spatial Light Modulator contains in the Y direction.

Returns:

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

`setResponseTime(value, validate=True)` ¶

Sets the value of the ResponseTime attribute.

This field records the rate at which this Spatial Light Modulator can change patterns.

Parameters:

Name	Type	Description	Default
`value`	`float`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getResponseTime()` ¶

Returns the value of the ResponseTime attribute.

This field records the rate at which this Spatial Light Modulator can change patterns.

Returns:

Type	Description
`float`	The value of the attribute

`resetResponseTime()` ¶

`hasResponseTime()` ¶

Checks whether the ResponseTime attribute is present.

This field records the rate at which this Spatial Light Modulator can change patterns.

Returns:

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

`setResponseTimeUnit(value, validate=True)` ¶

Sets the value of the ResponseTimeUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
`value`	`UnitsTime_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getResponseTimeUnit()` ¶

Returns the value of the ResponseTimeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
`UnitsTime_Type`	The value of the attribute

`resetResponseTimeUnit()` ¶

`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

SpatialLightModulator¶

fromBase(base) staticmethod ¶

getTypeName() ¶

getXMLName() ¶

getNBOType() ¶

getChildren() ¶

getSubElements() ¶

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) ¶

setType(value, validate=True) ¶

getType() ¶

resetType() ¶

hasType() ¶

setArrayWidth(value, validate=True) ¶

getArrayWidth() ¶

resetArrayWidth() ¶

hasArrayWidth() ¶

setArrayHeight(value, validate=True) ¶

getArrayHeight() ¶

resetArrayHeight() ¶

hasArrayHeight() ¶

setResponseTime(value, validate=True) ¶

getResponseTime() ¶

resetResponseTime() ¶

hasResponseTime() ¶

setResponseTimeUnit(value, validate=True) ¶

getResponseTimeUnit() ¶

resetResponseTimeUnit() ¶

hasResponseTimeUnit() ¶

`fromBase(base)` `staticmethod` ¶

`getTypeName()` ¶

`getXMLName()` ¶

`getNBOType()` ¶

`getChildren()` ¶

`getSubElements()` ¶

`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)` ¶

`setType(value, validate=True)` ¶

`getType()` ¶

`resetType()` ¶

`hasType()` ¶

`setArrayWidth(value, validate=True)` ¶

`getArrayWidth()` ¶

`resetArrayWidth()` ¶

`hasArrayWidth()` ¶

`setArrayHeight(value, validate=True)` ¶

`getArrayHeight()` ¶

`resetArrayHeight()` ¶

`hasArrayHeight()` ¶

`setResponseTime(value, validate=True)` ¶

`getResponseTime()` ¶

`resetResponseTime()` ¶

`hasResponseTime()` ¶

`setResponseTimeUnit(value, validate=True)` ¶

`getResponseTimeUnit()` ¶

`resetResponseTimeUnit()` ¶

`hasResponseTimeUnit()` ¶