AcoustoOpticalDevice_Type

Bases: ManufacturerSpec_Type

Represents the XML complex type AcoustoOpticalDevice.

This is a device that performs spatial, temporal, and spectral modulations of light on the basis of acousto-optic (AO) diffraction. AO diffraction is a phenomenon whereby an acoustic wave propagating in an optically transparent medium, produces a periodic modulation of the index of refraction of the medium via the elasto-optical effect and might therefore diffract portions of an incident light into one or more directions.

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

setID(value)

Sets the value of the ID attribute.

A Unique Identifier for this component.

Parameters:

Name	Type	Description	Default
value	AcoustoOpticalDeviceID_Type	The value to set	required

getID()

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

Type	Description
AcoustoOpticalDeviceID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

hasID()

Checks whether the optional ID attribute is present.

A Unique Identifier for this component.

Returns:

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

setName(value)

Sets the value of the Name attribute.

A User-defined Name for this component.

Parameters:

Name	Type	Description	Default
value	Denomination_Type	The value to set	required

getName()

Returns the value of the Name attribute.

A User-defined Name for this component.

Returns:

Type	Description
Denomination_Type	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

A User-defined Name for this component.

hasName()

Checks whether the optional Name attribute is present.

A User-defined Name for this component.

Returns:

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

setContrastRatio(value)

Sets the value of the ContrastRatio attribute.

This field records the reports on the ratio of maximum versus minimum transmittance.

Parameters:

Name	Type	Description	Default
value	PercentFraction_Type	The value to set	required

getContrastRatio()

Returns the value of the ContrastRatio attribute.

This field records the reports on the ratio of maximum versus minimum transmittance.

Returns:

Type	Description
PercentFraction_Type	The value of the attribute

resetContrastRatio()

Resets the ContrastRatio attribute to an unset state.

This field records the reports on the ratio of maximum versus minimum transmittance.

hasContrastRatio()

Checks whether the optional ContrastRatio attribute is present.

This field records the reports on the ratio of maximum versus minimum transmittance.

Returns:

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

setCoating(value)

Sets the value of the Coating attribute.

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the thin-film material used to coat the non linear crystal and reduce surface reflection.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getCoating()

Returns the value of the Coating attribute.

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the thin-film material used to coat the non linear crystal and reduce surface reflection.

Returns:

Type	Description
string	The value of the attribute

resetCoating()

Resets the Coating attribute to an unset state.

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the thin-film material used to coat the non linear crystal and reduce surface reflection.

hasCoating()

Checks whether the optional Coating attribute is present.

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the thin-film material used to coat the non linear crystal and reduce surface reflection.

Returns:

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

setAttenuationMethod(value)

Sets the value of the AttenuationMethod attribute.

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

Parameters:

Name	Type	Description	Default
value	AttenuationMethodType_Type	The value to set	required

getAttenuationMethod()

Returns the value of the AttenuationMethod attribute.

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

Returns:

Type	Description
AttenuationMethodType_Type	The value of the attribute

resetAttenuationMethod()

Resets the AttenuationMethod attribute to an unset state.

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

hasAttenuationMethod()

Checks whether the optional AttenuationMethod attribute is present.

This field records the mean by which this optical element achieves out-of-band transmission attenuation.

Returns:

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

setAttenuationCoefficient(value)

Sets the value of the AttenuationCoefficient attribute.

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getAttenuationCoefficient()

Returns the value of the AttenuationCoefficient attribute.

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD

Returns:

Type	Description
float	The value of the attribute

resetAttenuationCoefficient()

Resets the AttenuationCoefficient attribute to an unset state.

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD

hasAttenuationCoefficient()

Checks whether the optional AttenuationCoefficient attribute is present.

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD

Returns:

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

setTuningAccuracy(value)

Sets the value of the TuningAccuracy attribute.

This field measures the accuracy with which the wavelength discriminating capacity of this device can be tuned or changed.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getTuningAccuracy()

Returns the value of the TuningAccuracy attribute.

This field measures the accuracy with which the wavelength discriminating capacity of this device can be tuned or changed.

Returns:

Type	Description
float	The value of the attribute

setTuningAccuracyUnit(value)

Sets the value of the TuningAccuracyUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getTuningAccuracyUnit()

Returns the value of the TuningAccuracyUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetTuningAccuracyUnit()

Resets the TuningAccuracyUnit attribute to an unset state.

No description available in the XSD standard.

hasTuningAccuracyUnit()

Checks whether the optional TuningAccuracyUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setPolarization(value)

Sets the value of the Polarization attribute.

This field records the polarization effect of this optical element. Dichroic beamsplitters (and, in fact, any thin-film interference coating that is used at non-normal angles-of-incidence) will cause some amount of polarization, the precise effect varying greatly with wavelength and with the particular coating design.

Parameters:

Name	Type	Description	Default
value	PolarizationMode_Type	The value to set	required

getPolarization()

Returns the value of the Polarization attribute.

This field records the polarization effect of this optical element. Dichroic beamsplitters (and, in fact, any thin-film interference coating that is used at non-normal angles-of-incidence) will cause some amount of polarization, the precise effect varying greatly with wavelength and with the particular coating design.

Returns:

Type	Description
PolarizationMode_Type	The value of the attribute

resetPolarization()

Resets the Polarization attribute to an unset state.

This field records the polarization effect of this optical element. Dichroic beamsplitters (and, in fact, any thin-film interference coating that is used at non-normal angles-of-incidence) will cause some amount of polarization, the precise effect varying greatly with wavelength and with the particular coating design.

hasPolarization()

Checks whether the optional Polarization attribute is present.

This field records the polarization effect of this optical element. Dichroic beamsplitters (and, in fact, any thin-film interference coating that is used at non-normal angles-of-incidence) will cause some amount of polarization, the precise effect varying greatly with wavelength and with the particular coating design.

Returns:

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

setBragg(value)

Sets the value of the Bragg attribute.

This indicates whether this device is operated under Bragg regime (True) or not. In Bragg regime, at one particular incidence angle , only one diffraction order is produced - the others are annihilated by destructive interference.

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getBragg()

Returns the value of the Bragg attribute.

This indicates whether this device is operated under Bragg regime (True) or not. In Bragg regime, at one particular incidence angle , only one diffraction order is produced - the others are annihilated by destructive interference.

Returns:

Type	Description
boolean	The value of the attribute

setTuningResolution(value)

Sets the value of the TuningResolution attribute.

This field measures the wavelength discriminating capacity of this device and it is defined as the full width at half-maximum (FWHM) of the main lobe from the selected optical output, and is a function of both wavelength and device configuration.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getTuningResolution()

Returns the value of the TuningResolution attribute.

This field measures the wavelength discriminating capacity of this device and it is defined as the full width at half-maximum (FWHM) of the main lobe from the selected optical output, and is a function of both wavelength and device configuration.

Returns:

Type	Description
float	The value of the attribute

resetTuningResolution()

Resets the TuningResolution attribute to an unset state.

This field measures the wavelength discriminating capacity of this device and it is defined as the full width at half-maximum (FWHM) of the main lobe from the selected optical output, and is a function of both wavelength and device configuration.

hasTuningResolution()

Checks whether the optional TuningResolution attribute is present.

This field measures the wavelength discriminating capacity of this device and it is defined as the full width at half-maximum (FWHM) of the main lobe from the selected optical output, and is a function of both wavelength and device configuration.

Returns:

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

setTuningResolutionUnit(value)

Sets the value of the TuningResolutionUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getTuningResolutionUnit()

Returns the value of the TuningResolutionUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetTuningResolutionUnit()

Resets the TuningResolutionUnit attribute to an unset state.

No description available in the XSD standard.

hasTuningResolutionUnit()

Checks whether the optional TuningResolutionUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setTuningRate(value)

Sets the value of the TuningRate attribute.

This field records the time it takes for this device to be tuned without degrading resolution. This time is determined by the velocity of the acoustic wage as it traverses the aperture of this device.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getTuningRate()

Returns the value of the TuningRate attribute.

This field records the time it takes for this device to be tuned without degrading resolution. This time is determined by the velocity of the acoustic wage as it traverses the aperture of this device.

Returns:

Type	Description
float	The value of the attribute

resetTuningRate()

Resets the TuningRate attribute to an unset state.

This field records the time it takes for this device to be tuned without degrading resolution. This time is determined by the velocity of the acoustic wage as it traverses the aperture of this device.

hasTuningRate()

Checks whether the optional TuningRate attribute is present.

This field records the time it takes for this device to be tuned without degrading resolution. This time is determined by the velocity of the acoustic wage as it traverses the aperture of this device.

Returns:

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

setTuningRateUnit(value)

Sets the value of the TuningRateUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsTime_Type	The value to set	required

getTuningRateUnit()

Returns the value of the TuningRateUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTime_Type	The value of the attribute

resetTuningRateUnit()

Resets the TuningRateUnit attribute to an unset state.

No description available in the XSD standard.

hasTuningRateUnit()

Checks whether the optional TuningRateUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setAngleOfIncidence(value)

Sets the value of the AngleOfIncidence attribute.

This field records the optimal angle of incidence (AOI) for this mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getAngleOfIncidence()

Returns the value of the AngleOfIncidence attribute.

This field records the optimal angle of incidence (AOI) for this mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

Returns:

Type	Description
float	The value of the attribute

resetAngleOfIncidence()

Resets the AngleOfIncidence attribute to an unset state.

This field records the optimal angle of incidence (AOI) for this mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

hasAngleOfIncidence()

Checks whether the optional AngleOfIncidence attribute is present.

This field records the optimal angle of incidence (AOI) for this mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

Returns:

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

setAngleOfIncidenceUnit(value)

Sets the value of the AngleOfIncidenceUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsAngle_Type	The value to set	required

getAngleOfIncidenceUnit()

Returns the value of the AngleOfIncidenceUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsAngle_Type	The value of the attribute

resetAngleOfIncidenceUnit()

Resets the AngleOfIncidenceUnit attribute to an unset state.

No description available in the XSD standard.

hasAngleOfIncidenceUnit()

Checks whether the optional AngleOfIncidenceUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setAngularAperture(value)

Sets the value of the AngularAperture attribute.

This field records the angular aperture is the half-angle of the cone of light entering the this device. It is, therefore, a measure of how much of the incident light actually passes through the device.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getAngularAperture()

Returns the value of the AngularAperture attribute.

This field records the angular aperture is the half-angle of the cone of light entering the this device. It is, therefore, a measure of how much of the incident light actually passes through the device.

Returns:

Type	Description
float	The value of the attribute

resetAngularAperture()

Resets the AngularAperture attribute to an unset state.

This field records the angular aperture is the half-angle of the cone of light entering the this device. It is, therefore, a measure of how much of the incident light actually passes through the device.

hasAngularAperture()

Checks whether the optional AngularAperture attribute is present.

This field records the angular aperture is the half-angle of the cone of light entering the this device. It is, therefore, a measure of how much of the incident light actually passes through the device.

Returns:

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

setAngularApertureUnit(value)

Sets the value of the AngularApertureUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsAngle_Type	The value to set	required

getAngularApertureUnit()

Returns the value of the AngularApertureUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsAngle_Type	The value of the attribute

resetAngularApertureUnit()

Resets the AngularApertureUnit attribute to an unset state.

No description available in the XSD standard.

hasAngularApertureUnit()

Checks whether the optional AngularApertureUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setMaterial(value)

Sets the value of the Material attribute.

This field describes the transparent crystal or glass material used to build this device, through which the light propagates and whose refractive properties can be modulated by acoustic waves of different frequencies.

Parameters:

Name	Type	Description	Default
value	AODMaterial_Type	The value to set	required

getMaterial()

Returns the value of the Material attribute.

This field describes the transparent crystal or glass material used to build this device, through which the light propagates and whose refractive properties can be modulated by acoustic waves of different frequencies.

Returns:

Type	Description
AODMaterial_Type	The value of the attribute

resetMaterial()

Resets the Material attribute to an unset state.

This field describes the transparent crystal or glass material used to build this device, through which the light propagates and whose refractive properties can be modulated by acoustic waves of different frequencies.

hasMaterial()

Checks whether the optional Material attribute is present.

This field describes the transparent crystal or glass material used to build this device, through which the light propagates and whose refractive properties can be modulated by acoustic waves of different frequencies.

Returns:

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

setDesign(value)

Sets the value of the Design attribute.

This field describes wheher the acoustic wave is absorbed or reflected by the distal surface of the crystal.

Parameters:

Name	Type	Description	Default
value	AODDesign_Type	The value to set	required

getDesign()

Returns the value of the Design attribute.

This field describes wheher the acoustic wave is absorbed or reflected by the distal surface of the crystal.

Returns:

Type	Description
AODDesign_Type	The value of the attribute

resetDesign()

Resets the Design attribute to an unset state.

This field describes wheher the acoustic wave is absorbed or reflected by the distal surface of the crystal.

hasDesign()

Checks whether the optional Design attribute is present.

This field describes wheher the acoustic wave is absorbed or reflected by the distal surface of the crystal.

Returns:

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

setGeometry(value)

Sets the value of the Geometry attribute.

This field describes the the direction of the applied electric field with respect to the light beam. Longitudinal devices have the electric field in the direction of the light beam, which passes through holes in the electrodes. Transverse devices have the electric field perpendicular to the light beam.

Parameters:

Name	Type	Description	Default
value	AODGeometry_Type	The value to set	required

getGeometry()

Returns the value of the Geometry attribute.

This field describes the the direction of the applied electric field with respect to the light beam. Longitudinal devices have the electric field in the direction of the light beam, which passes through holes in the electrodes. Transverse devices have the electric field perpendicular to the light beam.

Returns:

Type	Description
AODGeometry_Type	The value of the attribute

resetGeometry()

Resets the Geometry attribute to an unset state.

This field describes the the direction of the applied electric field with respect to the light beam. Longitudinal devices have the electric field in the direction of the light beam, which passes through holes in the electrodes. Transverse devices have the electric field perpendicular to the light beam.

hasGeometry()

Checks whether the optional Geometry attribute is present.

This field describes the the direction of the applied electric field with respect to the light beam. Longitudinal devices have the electric field in the direction of the light beam, which passes through holes in the electrodes. Transverse devices have the electric field perpendicular to the light beam.

Returns:

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

setOperatingTemperature(value)

Sets the value of the OperatingTemperature attribute.

This field records the ambient temperature at which this device is designed to operate, according to the Manufacturer.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getOperatingTemperature()

Returns the value of the OperatingTemperature attribute.

This field records the ambient temperature at which this device is designed to operate, according to the Manufacturer.

Returns:

Type	Description
float	The value of the attribute

resetOperatingTemperature()

Resets the OperatingTemperature attribute to an unset state.

This field records the ambient temperature at which this device is designed to operate, according to the Manufacturer.

hasOperatingTemperature()

Checks whether the optional OperatingTemperature attribute is present.

This field records the ambient temperature at which this device is designed to operate, according to the Manufacturer.

Returns:

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

setOperatingTemperatureUnit(value)

Sets the value of the OperatingTemperatureUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsTemperature_Type	The value to set	required

getOperatingTemperatureUnit()

Returns the value of the OperatingTemperatureUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTemperature_Type	The value of the attribute

resetOperatingTemperatureUnit()

Resets the OperatingTemperatureUnit attribute to an unset state.

No description available in the XSD standard.

hasOperatingTemperatureUnit()

Checks whether the optional OperatingTemperatureUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setAnnotationRef(value)

Sets the value of the AnnotationRef element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	AnnotationRef	The value to set	required

getAnnotationRef()

Returns the value of the AnnotationRef element.

No description available in the XSD standard.

Returns:

Type	Description
AnnotationRef	The value of the element

resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

No description available in the XSD standard.

hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

No description available in the XSD standard.

Returns:

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