Dichroic_Type

Bases: MirroringDevice_Type

Represents the XML complex type Dichroic.

A Dichroic Mirror (also often referred to as Dichroic Beamsplitter or simply as Dichroic) is a Mirror that spectrally separate light by transmitting and reflecting light as a function of wavelength. In the context of fluorescence microscopy, they are typically used to reflect the excitation light, but transmit the emitted fluorescence. Dichroic Mirrors can be categorized in different manners. However, the most important criteria for choosing a Dichoric Mirror are the Transmittance and the Reflectance Wavelength ranges.

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)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required

fromJsonString(json_string)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required

fromXmlFile(path)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required

fromXmlString(xml_string)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required

toXmlFile(filename)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required

toXmlString()

Serializes this object to an XML string.

Returns:

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

setType(value)

Sets the value of the Type attribute.

This field captures the Type of Dichroic used in this case.

Parameters:

Name	Type	Description	Default
value	FilterType_Type	The value to set	required

getType()

Returns the value of the Type attribute.

This field captures the Type of Dichroic used in this case.

Returns:

Type	Description
FilterType_Type	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

This field captures the Type of Dichroic used in this case.

hasType()

Checks whether the optional Type attribute is present.

This field captures the Type of Dichroic used in this case.

Returns:

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

setCoatingMethod(value)

Sets the value of the CoatingMethod attribute.

This field records the type of Coating used in this case. An optical coating is one or more thin layers of material deposited on an optical component such as a Lens, Filter or Mirror, which alters the way in which the optic reflects and transmits light.

Parameters:

Name	Type	Description	Default
value	CoatingMethod_Type	The value to set	required

getCoatingMethod()

Returns the value of the CoatingMethod attribute.

This field records the type of Coating used in this case. An optical coating is one or more thin layers of material deposited on an optical component such as a Lens, Filter or Mirror, which alters the way in which the optic reflects and transmits light.

Returns:

Type	Description
CoatingMethod_Type	The value of the attribute

resetCoatingMethod()

Resets the CoatingMethod attribute to an unset state.

This field records the type of Coating used in this case. An optical coating is one or more thin layers of material deposited on an optical component such as a Lens, Filter or Mirror, which alters the way in which the optic reflects and transmits light.

hasCoatingMethod()

Checks whether the optional CoatingMethod attribute is present.

This field records the type of Coating used in this case. An optical coating is one or more thin layers of material deposited on an optical component such as a Lens, Filter or Mirror, which alters the way in which the optic reflects and transmits light.

Returns:

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

setLightPathLocation(value)

Sets the value of the LightPathLocation attribute.

This field records the location of this component in the Microscope Light Path. The most common positions are: Infinity Space, Camera Port or Illumination Port.

Parameters:

Name	Type	Description	Default
value	LightPathLocationOptions_Type	The value to set	required

getLightPathLocation()

Returns the value of the LightPathLocation attribute.

This field records the location of this component in the Microscope Light Path. The most common positions are: Infinity Space, Camera Port or Illumination Port.

Returns:

Type	Description
LightPathLocationOptions_Type	The value of the attribute

resetLightPathLocation()

Resets the LightPathLocation attribute to an unset state.

This field records the location of this component in the Microscope Light Path. The most common positions are: Infinity Space, Camera Port or Illumination Port.

hasLightPathLocation()

Checks whether the optional LightPathLocation attribute is present.

This field records the location of this component in the Microscope Light Path. The most common positions are: Infinity Space, Camera Port or Illumination Port.

Returns:

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

setTechnology(value)

Sets the value of the Technology attribute.

This field records the filtering Technology utilized for this optical element. The main types of technologies used in fluorescence analysis are Absorption (aka colored) glass, Polymer or Thin-film coating.

Parameters:

Name	Type	Description	Default
value	FilterTechnologyType_Type	The value to set	required

getTechnology()

Returns the value of the Technology attribute.

This field records the filtering Technology utilized for this optical element. The main types of technologies used in fluorescence analysis are Absorption (aka colored) glass, Polymer or Thin-film coating.

Returns:

Type	Description
FilterTechnologyType_Type	The value of the attribute

resetTechnology()

Resets the Technology attribute to an unset state.

This field records the filtering Technology utilized for this optical element. The main types of technologies used in fluorescence analysis are Absorption (aka colored) glass, Polymer or Thin-film coating.

hasTechnology()

Checks whether the optional Technology attribute is present.

This field records the filtering Technology utilized for this optical element. The main types of technologies used in fluorescence analysis are Absorption (aka colored) glass, Polymer or Thin-film coating.

Returns:

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

setAttenuationMethod(value)

Sets the value of the AttenuationMethod attribute.

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

Parameters:

Name	Type	Description	Default
value	AttenuationMethodType_Type	The value to set	required

getAttenuationMethod()

Returns the value of the AttenuationMethod attribute.

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

Returns:

Type	Description
AttenuationMethodType_Type	The value of the attribute

resetAttenuationMethod()

Resets the AttenuationMethod attribute to an unset state.

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

hasAttenuationMethod()

Checks whether the optional AttenuationMethod attribute is present.

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

Returns:

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

setAttenuationCoefficient(value)

Sets the value of the AttenuationCoefficient attribute.

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getAttenuationCoefficient()

Returns the value of the AttenuationCoefficient attribute.

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD

Returns:

Type	Description
float	The value of the attribute

resetAttenuationCoefficient()

Resets the AttenuationCoefficient attribute to an unset state.

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD

hasAttenuationCoefficient()

Checks whether the optional AttenuationCoefficient attribute is present.

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD

Returns:

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

setThickness(value)

Sets the value of the Thickness attribute.

This field describes the Thickness of this optical element.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getThickness()

Returns the value of the Thickness attribute.

This field describes the Thickness of this optical element.

Returns:

Type	Description
float	The value of the attribute

resetThickness()

Resets the Thickness attribute to an unset state.

This field describes the Thickness of this optical element.

hasThickness()

Checks whether the optional Thickness attribute is present.

This field describes the Thickness of this optical element.

Returns:

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

setThicknessUnit(value)

Sets the value of the ThicknessUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getThicknessUnit()

Returns the value of the ThicknessUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetThicknessUnit()

Resets the ThicknessUnit attribute to an unset state.

No description available in the XSD standard.

hasThicknessUnit()

Checks whether the optional ThicknessUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setPolarization(value)

Sets the value of the Polarization attribute.

This field records the polarization effect of this optical element. Any thin-film interference coating that is used at non-normal angles-of-incidence will cause some amount of polarization, the precise effect varying greatly with wavelength and with the particular coating design.

Parameters:

Name	Type	Description	Default
value	FilterPolarizationType_Type	The value to set	required

getPolarization()

Returns the value of the Polarization attribute.

This field records the polarization effect of this optical element. Any thin-film interference coating that is used at non-normal angles-of-incidence will cause some amount of polarization, the precise effect varying greatly with wavelength and with the particular coating design.

Returns:

Type	Description
FilterPolarizationType_Type	The value of the attribute

resetPolarization()

Resets the Polarization attribute to an unset state.

This field records the polarization effect of this optical element. Any thin-film interference coating that is used at non-normal angles-of-incidence will cause some amount of polarization, the precise effect varying greatly with wavelength and with the particular coating design.

hasPolarization()

Checks whether the optional Polarization attribute is present.

This field records the polarization effect of this optical element. Any thin-film interference coating that is used at non-normal angles-of-incidence will cause some amount of polarization, the precise effect varying greatly with wavelength and with the particular coating design.

Returns:

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

setTransmittanceProfileFile_List(value)

Sets the list of TransmittanceProfileFile elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[TransmittanceProfileFile]	The new list of TransmittanceProfileFile elements	required

getTransmittanceProfileFile_List()

Returns the list of TransmittanceProfileFile elements.

No description available in the XSD standard.

Returns:

Type	Description
List[TransmittanceProfileFile]	The list of TransmittanceProfileFile elements

addToTransmittanceProfileFile_List(value)

Adds a new TransmittanceProfileFile element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	TransmittanceProfileFile	The element to add	required

clearTransmittanceProfileFile_List()

Clear the list of TransmittanceProfileFile.

No description available in the XSD standard.

setReflectanceProfileFile_List(value)

Sets the list of ReflectanceProfileFile elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[ReflectanceProfileFile]	The new list of ReflectanceProfileFile elements	required

getReflectanceProfileFile_List()

Returns the list of ReflectanceProfileFile elements.

No description available in the XSD standard.

Returns:

Type	Description
List[ReflectanceProfileFile]	The list of ReflectanceProfileFile elements

addToReflectanceProfileFile_List(value)

Adds a new ReflectanceProfileFile element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	ReflectanceProfileFile	The element to add	required

clearReflectanceProfileFile_List()

Clear the list of ReflectanceProfileFile.

No description available in the XSD standard.

setTransmittanceRange_List(value)

Sets the list of TransmittanceRange elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[TransmittanceRange]	The new list of TransmittanceRange elements	required

getTransmittanceRange_List()

Returns the list of TransmittanceRange elements.

No description available in the XSD standard.

Returns:

Type	Description
List[TransmittanceRange]	The list of TransmittanceRange elements

addToTransmittanceRange_List(value)

Adds a new TransmittanceRange element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	TransmittanceRange	The element to add	required

clearTransmittanceRange_List()

Clear the list of TransmittanceRange.

No description available in the XSD standard.

setReflectanceRange_List(value)

Sets the list of ReflectanceRange elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[ReflectanceRange]	The new list of ReflectanceRange elements	required

getReflectanceRange_List()

Returns the list of ReflectanceRange elements.

No description available in the XSD standard.

Returns:

Type	Description
List[ReflectanceRange]	The list of ReflectanceRange elements

addToReflectanceRange_List(value)

Adds a new ReflectanceRange element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	ReflectanceRange	The element to add	required

clearReflectanceRange_List()

Clear the list of ReflectanceRange.

No description available in the XSD standard.