Bases: LightSource_Type
Represents the XML element Laser.
This element describes a Light Source, which emits coherent radiation at high spectral concentrations of radiance and minimal solid angles. This includes proper Light Amplification by Stimulated Emission of Radiation (LASER) sources that emit light through a process of optical amplification based on the stimulated emission of electromagnetic radiation. It also includes Optical Parametric Oscillator (OPO) sources that use a kind of LASER resonator but based on optical gain from parametric amplification in a nonlinear crystal rather than from stimulated emission.
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 )
setType ( value , validate = True )
Sets the value of the Type attribute.
This field captures the general category of this Laser. Please note that Optical Parametric Oscillators (OPO) are listed here even though they are technically not a LASER. They produce optical gain not through stimulated emission but via parametric amplification in a non-linear crystal.
Parameters:
Name
Type
Description
Default
value
LaserType_Type
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getType ()
Returns the value of the Type attribute.
This field captures the general category of this Laser. Please note that Optical Parametric Oscillators (OPO) are listed here even though they are technically not a LASER. They produce optical gain not through stimulated emission but via parametric amplification in a non-linear crystal.
Returns:
Type
Description
LaserType_Type
The value of the attribute
resetType ()
Resets the Type attribute to an unset state.
This field captures the general category of this Laser. Please note that Optical Parametric Oscillators (OPO) are listed here even though they are technically not a LASER. They produce optical gain not through stimulated emission but via parametric amplification in a non-linear crystal.
hasType ()
Checks whether the optional Type attribute is present.
This field captures the general category of this Laser. Please note that Optical Parametric Oscillators (OPO) are listed here even though they are technically not a LASER. They produce optical gain not through stimulated emission but via parametric amplification in a non-linear crystal.
Returns:
Type
Description
boolean
true if the optional attribute has been set, false otherwise
setTuneable ( value , validate = True )
setModulationMechanism ( value , validate = True )
resetModulationMechanism ()
setPulse ( value , validate = True )
Sets the value of the Pulse attribute.
Whether this Laser emits light in the form of optical Pulses (i.e., light flashes; True) or as a Continuous Wave (CW; False).
Parameters:
Name
Type
Description
Default
value
boolean
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getPulse ()
Returns the value of the Pulse attribute.
Whether this Laser emits light in the form of optical Pulses (i.e., light flashes; True) or as a Continuous Wave (CW; False).
Returns:
Type
Description
boolean
The value of the attribute
resetPulse ()
Resets the Pulse attribute to an unset state.
Whether this Laser emits light in the form of optical Pulses (i.e., light flashes; True) or as a Continuous Wave (CW; False).
hasPulse ()
Checks whether the Pulse attribute is present.
Whether this Laser emits light in the form of optical Pulses (i.e., light flashes; True) or as a Continuous Wave (CW; False).
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setLaserClass ( value , validate = True )
resetLaserClass ()
Resets the LaserClass attribute to an unset state.
This describes the safety Class this Laser belongs to. Laser Classes are defined based on their potential for causing injury to humans’ eyes and skin.
hasLaserClass ()
Checks whether the optional LaserClass attribute is present.
This describes the safety Class this Laser belongs to. Laser Classes are defined based on their potential for causing injury to humans’ eyes and skin.
Returns:
Type
Description
boolean
true if the optional attribute has been set, false otherwise
setLaserMedium ( value , validate = True )
setIsPumped ( value , validate = True )
setIsPump ( value , validate = True )
setPosition ( value , validate = True )
setRepetitionRate ( value , validate = True )
Sets the value of the RepetitionRate attribute.
In the case this is a pulsed Laser (Pulse is True), this field (also known as Pulse Frequency) describes the frequency of laser pulses. The default unit is Hz.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getRepetitionRate ()
Returns the value of the RepetitionRate attribute.
In the case this is a pulsed Laser (Pulse is True), this field (also known as Pulse Frequency) describes the frequency of laser pulses. The default unit is Hz.
Returns:
Type
Description
float
The value of the attribute
resetRepetitionRate ()
Resets the RepetitionRate attribute to an unset state.
In the case this is a pulsed Laser (Pulse is True), this field (also known as Pulse Frequency) describes the frequency of laser pulses. The default unit is Hz.
hasRepetitionRate ()
Checks whether the RepetitionRate attribute is present.
In the case this is a pulsed Laser (Pulse is True), this field (also known as Pulse Frequency) describes the frequency of laser pulses. The default unit is Hz.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setRepetitionRateUnit ( value , validate = True )
resetRepetitionRateUnit ()
setPulseDuration ( value , validate = True )
Sets the value of the PulseDuration attribute.
In the case this is a pulsed Laser (Pulse is True), this field describes the duration of each Laser pulse.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getPulseDuration ()
Returns the value of the PulseDuration attribute.
In the case this is a pulsed Laser (Pulse is True), this field describes the duration of each Laser pulse.
Returns:
Type
Description
float
The value of the attribute
resetPulseDuration ()
Resets the PulseDuration attribute to an unset state.
In the case this is a pulsed Laser (Pulse is True), this field describes the duration of each Laser pulse.
hasPulseDuration ()
Checks whether the PulseDuration attribute is present.
In the case this is a pulsed Laser (Pulse is True), this field describes the duration of each Laser pulse.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setPulseDurationUnit ( value , validate = True )
setFrequencyMultiplication ( value , validate = True )
getFrequencyMultiplication ()
resetFrequencyMultiplication ()
hasFrequencyMultiplication ()
setUsedAcoustoOpticalDevice ( value , validate = True )
getUsedAcoustoOpticalDevice ()
resetUsedAcoustoOpticalDevice ()
hasUsedAcoustoOpticalDevice ()
setIlluminationWavelengthRange_List ( value , validate = True )
getIlluminationWavelengthRange_List ()
addToIlluminationWavelengthRange_List ( value , validate = True )
clearIlluminationWavelengthRange_List ()
setAcoustoOpticalDeviceRef_List ( value , validate = True )
getAcoustoOpticalDeviceRef_List ()
addToAcoustoOpticalDeviceRef_List ( value , validate = True )
clearAcoustoOpticalDeviceRef_List ()
setPump ( value , validate = True )