TransmittanceRangeType_Type

Bases: NBOBaseClass

Represents the XML complex type TransmittanceRangeType.

This field records the key Wavelength] that characterizes this Transmittance Range (also known as Transmission band). In the case of Bandpass, Bandstop, Multipass or Notch Filters, Wavelength often refers to the Central Wavelength of each of the transmission band(s); alternatively, in case of a Longpass or a Shortpass Filters, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) or the CutOff Wavelengths (i.e., above which there is less than 50% transmittance) respectively. In the case of Dichroics, Wavelength most commonly refers to the Edge Wavelength which might be either the CutOn or the CutOff Wavelength depending on individual cases.

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

setWavelength(value)

Sets the value of the Wavelength attribute.

This field records the key Wavelength] that characterizes this Transmittance Range (also known as Transmission band). In the case of Bandpass, Bandstop, Multipass or Notch Filters, Wavelength often refers to the Central Wavelength of each of the transmission band(s); alternatively, in case of a Longpass or a Shortpass Filters, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) or the CutOff Wavelengths (i.e., above which there is less than 50% transmittance) respectively. In the case of Dichroics, Wavelength most commonly refers to the Edge Wavelength which might be either the CutOn or the CutOff Wavelength depending on individual cases.

Parameters:

Name	Type	Description	Default
value	PositiveFloat_Type	The value to set	required

getWavelength()

Returns the value of the Wavelength attribute.

This field records the key Wavelength] that characterizes this Transmittance Range (also known as Transmission band). In the case of Bandpass, Bandstop, Multipass or Notch Filters, Wavelength often refers to the Central Wavelength of each of the transmission band(s); alternatively, in case of a Longpass or a Shortpass Filters, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) or the CutOff Wavelengths (i.e., above which there is less than 50% transmittance) respectively. In the case of Dichroics, Wavelength most commonly refers to the Edge Wavelength which might be either the CutOn or the CutOff Wavelength depending on individual cases.

Returns:

Type	Description
PositiveFloat_Type	The value of the attribute

resetWavelength()

Resets the Wavelength attribute to an unset state.

This field records the key Wavelength] that characterizes this Transmittance Range (also known as Transmission band). In the case of Bandpass, Bandstop, Multipass or Notch Filters, Wavelength often refers to the Central Wavelength of each of the transmission band(s); alternatively, in case of a Longpass or a Shortpass Filters, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) or the CutOff Wavelengths (i.e., above which there is less than 50% transmittance) respectively. In the case of Dichroics, Wavelength most commonly refers to the Edge Wavelength which might be either the CutOn or the CutOff Wavelength depending on individual cases.

hasWavelength()

Checks whether the optional Wavelength attribute is present.

This field records the key Wavelength] that characterizes this Transmittance Range (also known as Transmission band). In the case of Bandpass, Bandstop, Multipass or Notch Filters, Wavelength often refers to the Central Wavelength of each of the transmission band(s); alternatively, in case of a Longpass or a Shortpass Filters, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) or the CutOff Wavelengths (i.e., above which there is less than 50% transmittance) respectively. In the case of Dichroics, Wavelength most commonly refers to the Edge Wavelength which might be either the CutOn or the CutOff Wavelength depending on individual cases.

Returns:

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

setFWHMBandwidth(value)

Sets the value of the FWHMBandwidth attribute.

This field records the width of this Transmittance Range (also known as Transmission band). Specifically, the Full Width at Half Maximum (FWHM) represents the bandwidth of the Wavelength spectrum curve measured between those points whose transmission amplitude is 50% of the maximum. In case bandwidth is not available, such as in the case of a LongPass, Notch or ShortPass configuration, please enter 000.

Parameters:

Name	Type	Description	Default
value	PositiveFloat_Type	The value to set	required

getFWHMBandwidth()

Returns the value of the FWHMBandwidth attribute.

This field records the width of this Transmittance Range (also known as Transmission band). Specifically, the Full Width at Half Maximum (FWHM) represents the bandwidth of the Wavelength spectrum curve measured between those points whose transmission amplitude is 50% of the maximum. In case bandwidth is not available, such as in the case of a LongPass, Notch or ShortPass configuration, please enter 000.

Returns:

Type	Description
PositiveFloat_Type	The value of the attribute

resetFWHMBandwidth()

Resets the FWHMBandwidth attribute to an unset state.

This field records the width of this Transmittance Range (also known as Transmission band). Specifically, the Full Width at Half Maximum (FWHM) represents the bandwidth of the Wavelength spectrum curve measured between those points whose transmission amplitude is 50% of the maximum. In case bandwidth is not available, such as in the case of a LongPass, Notch or ShortPass configuration, please enter 000.

hasFWHMBandwidth()

Checks whether the optional FWHMBandwidth attribute is present.

This field records the width of this Transmittance Range (also known as Transmission band). Specifically, the Full Width at Half Maximum (FWHM) represents the bandwidth of the Wavelength spectrum curve measured between those points whose transmission amplitude is 50% of the maximum. In case bandwidth is not available, such as in the case of a LongPass, Notch or ShortPass configuration, please enter 000.

Returns:

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

setWavelengthUnit(value)

Sets the value of the WavelengthUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getWavelengthUnit()

Returns the value of the WavelengthUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetWavelengthUnit()

Resets the WavelengthUnit attribute to an unset state.

No description available in the XSD standard.

hasWavelengthUnit()

Checks whether the optional WavelengthUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setTransmittance(value)

Sets the value of the Transmittance attribute.

This field records the maximum amount of light this optical component is capable of transmitting in this Wavelength Range, at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

Parameters:

Name	Type	Description	Default
value	PercentFraction_Type	The value to set	required

getTransmittance()

Returns the value of the Transmittance attribute.

This field records the maximum amount of light this optical component is capable of transmitting in this Wavelength Range, at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

Returns:

Type	Description
PercentFraction_Type	The value of the attribute

resetTransmittance()

Resets the Transmittance attribute to an unset state.

This field records the maximum amount of light this optical component is capable of transmitting in this Wavelength Range, at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

hasTransmittance()

Checks whether the optional Transmittance attribute is present.

This field records the maximum amount of light this optical component is capable of transmitting in this Wavelength Range, at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

Returns:

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