Bases: OpticalAperture_Type
Represents the XML element DiffractionGrating.
A Diffraction Grating is an optical component with a periodic structure that splits and diffracts light into several beams travelling in different directions.
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 )
setPeriod ( value , validate = True )
setPeriodUnit ( value , validate = True )
setSpatialFrequency ( value , validate = True )
setTransmittive ( value , validate = True )
Sets the value of the Transmittive attribute.
This field records whether the periodic fine structure of this Diffraction Grating is Transmissive (True) and therefore refracts light, or is Reflective (False) and therefore reflects it.
Parameters:
Name
Type
Description
Default
value
boolean
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getTransmittive ()
Returns the value of the Transmittive attribute.
This field records whether the periodic fine structure of this Diffraction Grating is Transmissive (True) and therefore refracts light, or is Reflective (False) and therefore reflects it.
Returns:
Type
Description
boolean
The value of the attribute
resetTransmittive ()
Resets the Transmittive attribute to an unset state.
This field records whether the periodic fine structure of this Diffraction Grating is Transmissive (True) and therefore refracts light, or is Reflective (False) and therefore reflects it.
hasTransmittive ()
Checks whether the Transmittive attribute is present.
This field records whether the periodic fine structure of this Diffraction Grating is Transmissive (True) and therefore refracts light, or is Reflective (False) and therefore reflects it.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setModulationMode ( value , validate = True )
setRonchi ( value , validate = True )
Sets the value of the Ronchi attribute.
This field records whether this Diffraction Grating has a square wave profile, as defined by Ronchi (True) or a sine wave profile (False).
Parameters:
Name
Type
Description
Default
value
boolean
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getRonchi ()
Returns the value of the Ronchi attribute.
This field records whether this Diffraction Grating has a square wave profile, as defined by Ronchi (True) or a sine wave profile (False).
Returns:
Type
Description
boolean
The value of the attribute
resetRonchi ()
Resets the Ronchi attribute to an unset state.
This field records whether this Diffraction Grating has a square wave profile, as defined by Ronchi (True) or a sine wave profile (False).
hasRonchi ()
Checks whether the Ronchi attribute is present.
This field records whether this Diffraction Grating has a square wave profile, as defined by Ronchi (True) or a sine wave profile (False).
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise