ReflectanceRangeType_Type
Bases: NBOBaseClass
Represents the XML complex type ReflectanceRangeType.
This field records the key Wavelength that characterizes this Reflectance Range (also known as Reflection band). In most cases, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) but it might also refer to the CutOff wavelength (i.e., above which there is less than 50% transmittance) or the Center Wavelength of the Reflectance Band.
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 Reflectance Range (also known as Reflection band). In most cases, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) but it might also refer to the CutOff wavelength (i.e., above which there is less than 50% transmittance) or the Center Wavelength of the Reflectance Band.
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 Reflectance Range (also known as Reflection band). In most cases, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) but it might also refer to the CutOff wavelength (i.e., above which there is less than 50% transmittance) or the Center Wavelength of the Reflectance Band.
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 Reflectance Range (also known as Reflection band). In most cases, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) but it might also refer to the CutOff wavelength (i.e., above which there is less than 50% transmittance) or the Center Wavelength of the Reflectance Band.
hasWavelength()
Checks whether the optional Wavelength attribute is present.
This field records the key Wavelength that characterizes this Reflectance Range (also known as Reflection band). In most cases, Wavelength refers to the CutOn Wavelength (i.e., below which there is less than 50% transmittance) but it might also refer to the CutOff wavelength (i.e., above which there is less than 50% transmittance) or the Center Wavelength of the Reflectance Band.
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 Reflectance Range (also known as Reflection 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 Reflectance Range (also known as Reflection 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 Reflectance Range (also known as Reflection 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 Reflectance Range (also known as Reflection 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 |
setReflectance(value)
Sets the value of the Reflectance attribute.
This field records the maximum amount of light this optical component is capable of reflecting 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 |
getReflectance()
Returns the value of the Reflectance attribute.
This field records the maximum amount of light this optical component is capable of reflecting 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 |
resetReflectance()
Resets the Reflectance attribute to an unset state.
This field records the maximum amount of light this optical component is capable of reflecting in this Wavelength Range, at the peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.
hasReflectance()
Checks whether the optional Reflectance attribute is present.
This field records the maximum amount of light this optical component is capable of reflecting 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 |