FilterCube

Bases: OpticsHolder_Type

Represents the XML element FilterCube.

A Filter Cube is a removable cube-shaped unit that containing the filters and mirror used in epi-fluorescence microscopy to separate fluorescence excitation and emission light. It usually holds a matched set of fluorescence filters, which might include an Excitation filter and Emission filter but always includes a Dichroic mirror. A Filter Cube might be pre-assebled by the Manufacturer and pruchased as a whole or it might be custom assembled on site depending on the needs of the user.

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
FilterCube	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

setOpticsHolderPosition(value, validate=True)

Sets the value of the OpticsHolderPosition attribute.

When relevant, this field records the position of this Filter Cube in a Optics Holder.

Parameters:

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

getOpticsHolderPosition()

Returns the value of the OpticsHolderPosition attribute.

When relevant, this field records the position of this Filter Cube in a Optics Holder.

Returns:

Type	Description
string	The value of the attribute

resetOpticsHolderPosition()

Resets the OpticsHolderPosition attribute to an unset state.

When relevant, this field records the position of this Filter Cube in a Optics Holder.

hasOpticsHolderPosition()

Checks whether the OpticsHolderPosition attribute is present.

When relevant, this field records the position of this Filter Cube in a Optics Holder.

Returns:

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

getOpticsHolderPositionAllowedValues() staticmethod

Returns the allowed values for this attribut.

When relevant, this field records the position of this Filter Cube in a Optics Holder.

Returns:

Type	Description
std::set< str,std::less< str >,std::allocator< str > >	The list of allowed values

setExcitationFilterRef(value, validate=True)

Sets the value of the ExcitationFilterRef element.

No description available in the XSD standard.

Parameters:

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

getExcitationFilterRef()

Returns the value of the ExcitationFilterRef element.

No description available in the XSD standard.

Returns:

Type	Description
ExcitationFilterRef	The value of the element

resetExcitationFilterRef()

Resets the ExcitationFilterRef element to an unset state.

No description available in the XSD standard.

hasExcitationFilterRef()

Checks whether the optional ExcitationFilterRef element is present.

No description available in the XSD standard.

Returns:

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

setStandardDichroicRef(value, validate=True)

Sets the value of the StandardDichroicRef element.

This field refers to an available Dichroic Mirror, which is part of this Filter Cube.

Parameters:

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

getStandardDichroicRef()

Returns the value of the StandardDichroicRef element.

This field refers to an available Dichroic Mirror, which is part of this Filter Cube.

Returns:

Type	Description
StandardDichroicRef	The value of the element

resetStandardDichroicRef()

Resets the StandardDichroicRef element to an unset state.

This field refers to an available Dichroic Mirror, which is part of this Filter Cube.

hasStandardDichroicRef()

Checks whether the optional StandardDichroicRef element is present.

This field refers to an available Dichroic Mirror, which is part of this Filter Cube.

Returns:

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

setEmissionFilterRef(value, validate=True)

Sets the value of the EmissionFilterRef element.

No description available in the XSD standard.

Parameters:

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

getEmissionFilterRef()

Returns the value of the EmissionFilterRef element.

No description available in the XSD standard.

Returns:

Type	Description
EmissionFilterRef	The value of the element

resetEmissionFilterRef()

Resets the EmissionFilterRef element to an unset state.

No description available in the XSD standard.

hasEmissionFilterRef()

Checks whether the optional EmissionFilterRef element is present.

No description available in the XSD standard.

Returns:

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