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
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 )
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
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 )
resetExcitationFilterRef ()
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
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
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 )