Laser

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.

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

setType(value)

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	The value to set	required

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)

Sets the value of the Tuneable attribute.

This field records whether (True) or not (False) this Laser is Tunable to different Wavelengths

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getTuneable()

Returns the value of the Tuneable attribute.

This field records whether (True) or not (False) this Laser is Tunable to different Wavelengths

Returns:

Type	Description
boolean	The value of the attribute

setModulationMechanism(value)

Sets the value of the ModulationMechanism attribute.

This field captures the Modulation Mechanism used for this Laser.

Parameters:

Name	Type	Description	Default
value	LaserModulation_Type	The value to set	required

getModulationMechanism()

Returns the value of the ModulationMechanism attribute.

This field captures the Modulation Mechanism used for this Laser.

Returns:

Type	Description
LaserModulation_Type	The value of the attribute

resetModulationMechanism()

Resets the ModulationMechanism attribute to an unset state.

This field captures the Modulation Mechanism used for this Laser.

hasModulationMechanism()

Checks whether the optional ModulationMechanism attribute is present.

This field captures the Modulation Mechanism used for this Laser.

Returns:

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

setPulse(value)

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	The value to set	required

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

setLaserClass(value)

Sets the value of the LaserClass attribute.

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.

Parameters:

Name	Type	Description	Default
value	LaserClass_Type	The value to set	required

getLaserClass()

Returns the value of the LaserClass attribute.

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
LaserClass_Type	The value of the attribute

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)

Sets the value of the LaserMedium attribute.

This field captures the material out of which this Laser is constructed.

Parameters:

Name	Type	Description	Default
value	LaserMedium_Type	The value to set	required

getLaserMedium()

Returns the value of the LaserMedium attribute.

This field captures the material out of which this Laser is constructed.

Returns:

Type	Description
LaserMedium_Type	The value of the attribute

resetLaserMedium()

Resets the LaserMedium attribute to an unset state.

This field captures the material out of which this Laser is constructed.

hasLaserMedium()

Checks whether the optional LaserMedium attribute is present.

This field captures the material out of which this Laser is constructed.

Returns:

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

setIsPumped(value)

Sets the value of the IsPumped attribute.

Whether (True) or not (False) this is a pumped Laser.

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getIsPumped()

Returns the value of the IsPumped attribute.

Whether (True) or not (False) this is a pumped Laser.

Returns:

Type	Description
boolean	The value of the attribute

setIsPump(value)

Sets the value of the IsPump attribute.

Whether (True) or not (False) this laser serves as a Pump for a downstream laser.

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getIsPump()

Returns the value of the IsPump attribute.

Whether (True) or not (False) this laser serves as a Pump for a downstream laser.

Returns:

Type	Description
boolean	The value of the attribute

setPosition(value)

Sets the value of the Position attribute.

This field captures the position of this Laser on a Multi Laser Engine.

Parameters:

Name	Type	Description	Default
value	int	The value to set	required

getPosition()

Returns the value of the Position attribute.

This field captures the position of this Laser on a Multi Laser Engine.

Returns:

Type	Description
int	The value of the attribute

resetPosition()

Resets the Position attribute to an unset state.

This field captures the position of this Laser on a Multi Laser Engine.

hasPosition()

Checks whether the optional Position attribute is present.

This field captures the position of this Laser on a Multi Laser Engine.

Returns:

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

setRepetitionRate(value)

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	The value to set	required

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 optional 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 optional attribute has been set, false otherwise

setRepetitionRateUnit(value)

Sets the value of the RepetitionRateUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsFrequency_Type	The value to set	required

getRepetitionRateUnit()

Returns the value of the RepetitionRateUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsFrequency_Type	The value of the attribute

resetRepetitionRateUnit()

Resets the RepetitionRateUnit attribute to an unset state.

No description available in the XSD standard.

hasRepetitionRateUnit()

Checks whether the optional RepetitionRateUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setPulseDuration(value)

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	The value to set	required

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 optional 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 optional attribute has been set, false otherwise

setPulseDurationUnit(value)

Sets the value of the PulseDurationUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsTime_Type	The value to set	required

getPulseDurationUnit()

Returns the value of the PulseDurationUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTime_Type	The value of the attribute

resetPulseDurationUnit()

Resets the PulseDurationUnit attribute to an unset state.

No description available in the XSD standard.

hasPulseDurationUnit()

Checks whether the optional PulseDurationUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setFrequencyMultiplication(value)

Sets the value of the FrequencyMultiplication attribute.

This field captures the optical frequency multiplication factor that may be specified for this Laser.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getFrequencyMultiplication()

Returns the value of the FrequencyMultiplication attribute.

This field captures the optical frequency multiplication factor that may be specified for this Laser.

Returns:

Type	Description
float	The value of the attribute

resetFrequencyMultiplication()

Resets the FrequencyMultiplication attribute to an unset state.

This field captures the optical frequency multiplication factor that may be specified for this Laser.

hasFrequencyMultiplication()

Checks whether the optional FrequencyMultiplication attribute is present.

This field captures the optical frequency multiplication factor that may be specified for this Laser.

Returns:

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

setUsedAcoustoOpticalDevice(value)

Sets the value of the UsedAcoustoOpticalDevice attribute.

This field records whether (True) or not (False) an AcoustoOptical Device was utilized during this Calibration Procedure.

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getUsedAcoustoOpticalDevice()

Returns the value of the UsedAcoustoOpticalDevice attribute.

This field records whether (True) or not (False) an AcoustoOptical Device was utilized during this Calibration Procedure.

Returns:

Type	Description
boolean	The value of the attribute

resetUsedAcoustoOpticalDevice()

Resets the UsedAcoustoOpticalDevice attribute to an unset state.

This field records whether (True) or not (False) an AcoustoOptical Device was utilized during this Calibration Procedure.

hasUsedAcoustoOpticalDevice()

Checks whether the optional UsedAcoustoOpticalDevice attribute is present.

This field records whether (True) or not (False) an AcoustoOptical Device was utilized during this Calibration Procedure.

Returns:

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

setIlluminationWavelengthRange_List(value)

Sets the list of IlluminationWavelengthRange elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[IlluminationWavelengthRange]	The new list of IlluminationWavelengthRange elements	required

getIlluminationWavelengthRange_List()

Returns the list of IlluminationWavelengthRange elements.

No description available in the XSD standard.

Returns:

Type	Description
List[IlluminationWavelengthRange]	The list of IlluminationWavelengthRange elements

addToIlluminationWavelengthRange_List(value)

Adds a new IlluminationWavelengthRange element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	IlluminationWavelengthRange	The element to add	required

clearIlluminationWavelengthRange_List()

Clear the list of IlluminationWavelengthRange.

No description available in the XSD standard.

setAcoustoOpticalDeviceRef_List(value)

Sets the list of AcoustoOpticalDeviceRef elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[AcoustoOpticalDeviceRef]	The new list of AcoustoOpticalDeviceRef elements	required

getAcoustoOpticalDeviceRef_List()

Returns the list of AcoustoOpticalDeviceRef elements.

No description available in the XSD standard.

Returns:

Type	Description
List[AcoustoOpticalDeviceRef]	The list of AcoustoOpticalDeviceRef elements

addToAcoustoOpticalDeviceRef_List(value)

Adds a new AcoustoOpticalDeviceRef element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	AcoustoOpticalDeviceRef	The element to add	required

clearAcoustoOpticalDeviceRef_List()

Clear the list of AcoustoOpticalDeviceRef.

No description available in the XSD standard.

setPump(value)

Sets the value of the Pump element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	Pump	The value to set	required

getPump()

Returns the value of the Pump element.

No description available in the XSD standard.

Returns:

Type	Description
Pump	The value of the element

resetPump()

Resets the Pump element to an unset state.

No description available in the XSD standard.

hasPump()

Checks whether the optional Pump element is present.

No description available in the XSD standard.

Returns:

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