Bases: OpticalApertureSettings_Type
Represents the XML element DiffractionGratingSettings.
This element holds the Setting applied to a Diffraction Grating used during the Acquisition of this Channel as well as a reference (the ID attribute) to the Diffraction Grating in question.
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 )
setDiffractionEfficiency ( value , validate = True )
Sets the value of the DiffractionEfficiency attribute.
This is a measure of the performance efficiency of this device. It's a measure of how much optical power is diffracted into a designated direction compared to the power incident onto the diffractive element.
Parameters:
Name
Type
Description
Default
value
PercentFraction_Type
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getDiffractionEfficiency ()
Returns the value of the DiffractionEfficiency attribute.
This is a measure of the performance efficiency of this device. It's a measure of how much optical power is diffracted into a designated direction compared to the power incident onto the diffractive element.
Returns:
Type
Description
PercentFraction_Type
The value of the attribute
resetDiffractionEfficiency ()
Resets the DiffractionEfficiency attribute to an unset state.
This is a measure of the performance efficiency of this device. It's a measure of how much optical power is diffracted into a designated direction compared to the power incident onto the diffractive element.
hasDiffractionEfficiency ()
Checks whether the optional DiffractionEfficiency attribute is present.
This is a measure of the performance efficiency of this device. It's a measure of how much optical power is diffracted into a designated direction compared to the power incident onto the diffractive element.
Returns:
Type
Description
boolean
true if the optional attribute has been set, false otherwise