PrismSettings¶

Bases: Settings_Type

Represents the XML element PrismSettings.

This element holds the Setting applied to a Prism used in the Light Path during the acquisition of this Channel as well as a reference (the ID attribute) to the Prism in question.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a CMOS.

Parameters:

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

Returns:

Type	Description
`PrismSettings`	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

`setID(value, validate=True)` ¶

Sets the value of the ID attribute.

This is the Unique Identifier of the device used in this case.

Parameters:

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

`getID()` ¶

Returns the value of the ID attribute.

This is the Unique Identifier of the device used in this case.

Returns:

Type	Description
`PrismID_Type`	The value of the attribute

`resetID()` ¶

Resets the ID attribute to an unset state.

This is the Unique Identifier of the device used in this case.

`hasID()` ¶

Checks whether the optional ID attribute is present.

This is the Unique Identifier of the device used in this case.

Returns:

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

`setPositionSetting(value, validate=True)` ¶

Sets the value of the PositionSetting attribute.

This field refers to the Wollaston Prism position that was set during the Acquisition of this Image. The Position must match the Wollaston Prism Settings found at the base of the objective lens.

Parameters:

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

`getPositionSetting()` ¶

Returns the value of the PositionSetting attribute.

This field refers to the Wollaston Prism position that was set during the Acquisition of this Image. The Position must match the Wollaston Prism Settings found at the base of the objective lens.

Returns:

Type	Description
`PrismPositionSettingList_Type`	The value of the attribute

`resetPositionSetting()` ¶

Resets the PositionSetting attribute to an unset state.

This field refers to the Wollaston Prism position that was set during the Acquisition of this Image. The Position must match the Wollaston Prism Settings found at the base of the objective lens.

`hasPositionSetting()` ¶

Checks whether the optional PositionSetting attribute is present.

This field refers to the Wollaston Prism position that was set during the Acquisition of this Image. The Position must match the Wollaston Prism Settings found at the base of the objective lens.

Returns:

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

`setTransmittanceProfileFie_List(value, validate=True)` ¶

Sets the list of TransmittanceProfileFie elements.

This element records a File in .csv or other suitable formats containing the Transmission Wavelength profile of this hardware component.

Parameters:

Name	Type	Description	Default
`value`	`List[FileAnnotation_Type]`	The new list of TransmittanceProfileFie elements	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getTransmittanceProfileFie_List()` ¶

Returns the list of TransmittanceProfileFie elements.

This element records a File in .csv or other suitable formats containing the Transmission Wavelength profile of this hardware component.

Returns:

Type	Description
`List[FileAnnotation_Type]`	The list of TransmittanceProfileFie elements

`addToTransmittanceProfileFie_List(value, validate=True)` ¶

Adds a new TransmittanceProfileFie element to this object.

This element records a File in .csv or other suitable formats containing the Transmission Wavelength profile of this hardware component.

Parameters:

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

`clearTransmittanceProfileFie_List()` ¶

Clear the list of TransmittanceProfileFie.

This element records a File in .csv or other suitable formats containing the Transmission Wavelength profile of this hardware component.

`setReflectanceProfileFile_List(value, validate=True)` ¶

Sets the list of ReflectanceProfileFile elements.

This element records a File in .csv or other suitable formats containing the Reflection Wavelength profile of this hardware component.

Parameters:

Name	Type	Description	Default
`value`	`List[FileAnnotation_Type]`	The new list of ReflectanceProfileFile elements	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getReflectanceProfileFile_List()` ¶

Returns the list of ReflectanceProfileFile elements.

This element records a File in .csv or other suitable formats containing the Reflection Wavelength profile of this hardware component.

Returns:

Type	Description
`List[FileAnnotation_Type]`	The list of ReflectanceProfileFile elements

`addToReflectanceProfileFile_List(value, validate=True)` ¶

Adds a new ReflectanceProfileFile element to this object.

This element records a File in .csv or other suitable formats containing the Reflection Wavelength profile of this hardware component.

Parameters:

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

`clearReflectanceProfileFile_List()` ¶

Clear the list of ReflectanceProfileFile.

This element records a File in .csv or other suitable formats containing the Reflection Wavelength profile of this hardware component.