Bases: NBOBaseClass
Represents the XML element FilterSet.
This element represents a FilterSet that was used for the acquisition of this Channel. A Filter Set is typically composed of one Excitation Filter, one Emission Filter and a Dichroic. They might either be pre-assembled by the Manufacturer and purchased as a whole or they can 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 )
setID ( value , validate = True )
setName ( value , validate = True )
setExcitationFilterRef ( value , validate = True )
resetExcitationFilterRef ()
setStandardDichroicRef ( value , validate = True )
Sets the value of the StandardDichroicRef element.
This refers to an available dichroic mirror, which is part of this filter set.
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 refers to an available dichroic mirror, which is part of this filter set.
Returns:
Type
Description
StandardDichroicRef
resetStandardDichroicRef ()
Resets the StandardDichroicRef element to an unset state.
This refers to an available dichroic mirror, which is part of this filter set.
hasStandardDichroicRef ()
Checks whether the optional StandardDichroicRef element is present.
This refers to an available dichroic mirror, which is part of this filter set.
Returns:
Type
Description
boolean
true if the optional attribute has been set, false otherwise
setEmissionFilterRef ( value , validate = True )
setAnnotationRef ( value , validate = True )