AcoustoOpticalDeviceSettings_Type

Bases: Settings_Type

Represents the XML complex type AcoustoOpticalDeviceSettings.

This element refers to the Acousto Optical Device used to acquire this image and it holds the settings that were applied to it during this Acquisition.

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.

This is the Unique Identifier of the device used in this case.

Parameters:

Name	Type	Description	Default
value	AcoustoOpticalDeviceID_Type	The value to set	required

getID()

Returns the value of the ID attribute.

This is the Unique Identifier of the device used in this case.

Returns:

Type	Description
AcoustoOpticalDeviceID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

This is the Unique Identifier of the device used in this case.

hasID()

Checks whether the optional ID attribute is present.

This is the Unique Identifier of the device used in this case.

Returns:

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

setDiffractionEfficiency(value)

Sets the value of the DiffractionEfficiency attribute.

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

getDiffractionEfficiency()

Returns the value of the DiffractionEfficiency attribute.

This field records 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 field records 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 field records 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

setAcousticVelocity(value)

Sets the value of the AcousticVelocity attribute.

This field records the acoustic wave transit time across the crystal used during this Acquisition.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getAcousticVelocity()

Returns the value of the AcousticVelocity attribute.

This field records the acoustic wave transit time across the crystal used during this Acquisition.

Returns:

Type	Description
float	The value of the attribute

resetAcousticVelocity()

Resets the AcousticVelocity attribute to an unset state.

This field records the acoustic wave transit time across the crystal used during this Acquisition.

hasAcousticVelocity()

Checks whether the optional AcousticVelocity attribute is present.

This field records the acoustic wave transit time across the crystal used during this Acquisition.

Returns:

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

setAcousticVelocityUnit(value)

Sets the value of the AcousticVelocityUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsVelocity_Type	The value to set	required

getAcousticVelocityUnit()

Returns the value of the AcousticVelocityUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsVelocity_Type	The value of the attribute

resetAcousticVelocityUnit()

Resets the AcousticVelocityUnit attribute to an unset state.

No description available in the XSD standard.

hasAcousticVelocityUnit()

Checks whether the optional AcousticVelocityUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setAcousticFrequency(value)

Sets the value of the AcousticFrequency attribute.

This field records the frequency of the acoustic wave used to alter the diffraction properties of the crystal during this Acquisition. Wavelength tuning is very rapid and limited only by the acoustic transit time across the crystal.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getAcousticFrequency()

Returns the value of the AcousticFrequency attribute.

This field records the frequency of the acoustic wave used to alter the diffraction properties of the crystal during this Acquisition. Wavelength tuning is very rapid and limited only by the acoustic transit time across the crystal.

Returns:

Type	Description
float	The value of the attribute

resetAcousticFrequency()

Resets the AcousticFrequency attribute to an unset state.

This field records the frequency of the acoustic wave used to alter the diffraction properties of the crystal during this Acquisition. Wavelength tuning is very rapid and limited only by the acoustic transit time across the crystal.

hasAcousticFrequency()

Checks whether the optional AcousticFrequency attribute is present.

This field records the frequency of the acoustic wave used to alter the diffraction properties of the crystal during this Acquisition. Wavelength tuning is very rapid and limited only by the acoustic transit time across the crystal.

Returns:

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

setAcousticFrequencyUnit(value)

Sets the value of the AcousticFrequencyUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsFrequency_Type	The value to set	required

getAcousticFrequencyUnit()

Returns the value of the AcousticFrequencyUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsFrequency_Type	The value of the attribute

resetAcousticFrequencyUnit()

Resets the AcousticFrequencyUnit attribute to an unset state.

No description available in the XSD standard.

hasAcousticFrequencyUnit()

Checks whether the optional AcousticFrequencyUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setTransmittanceProfileFile_List(value)

Sets the list of TransmittanceProfileFile elements.

No description available in the XSD standard.

Parameters:

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

getTransmittanceProfileFile_List()

Returns the list of TransmittanceProfileFile elements.

No description available in the XSD standard.

Returns:

Type	Description
List[TransmittanceProfileFile]	The list of TransmittanceProfileFile elements

addToTransmittanceProfileFile_List(value)

Adds a new TransmittanceProfileFile element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	TransmittanceProfileFile	The element to add	required

clearTransmittanceProfileFile_List()

Clear the list of TransmittanceProfileFile.

No description available in the XSD standard.

setReflectanceProfileFile_List(value)

Sets the list of ReflectanceProfileFile elements.

No description available in the XSD standard.

Parameters:

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

getReflectanceProfileFile_List()

Returns the list of ReflectanceProfileFile elements.

No description available in the XSD standard.

Returns:

Type	Description
List[ReflectanceProfileFile]	The list of ReflectanceProfileFile elements

addToReflectanceProfileFile_List(value)

Adds a new ReflectanceProfileFile element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	ReflectanceProfileFile	The element to add	required

clearReflectanceProfileFile_List()

Clear the list of ReflectanceProfileFile.

No description available in the XSD standard.

setTransmissionWavelengthRangeSettings_List(value)

Sets the list of TransmissionWavelengthRangeSettings elements.

No description available in the XSD standard.

Parameters:

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

getTransmissionWavelengthRangeSettings_List()

Returns the list of TransmissionWavelengthRangeSettings elements.

No description available in the XSD standard.

Returns:

Type	Description
List[TransmissionWavelengthRangeSettings]	The list of TransmissionWavelengthRangeSettings elements

addToTransmissionWavelengthRangeSettings_List(value)

Adds a new TransmissionWavelengthRangeSettings element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	TransmissionWavelengthRangeSettings	The element to add	required

clearTransmissionWavelengthRangeSettings_List()

Clear the list of TransmissionWavelengthRangeSettings.

No description available in the XSD standard.

setReflectionWavelengthRangeSettings_List(value)

Sets the list of ReflectionWavelengthRangeSettings elements.

No description available in the XSD standard.

Parameters:

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

getReflectionWavelengthRangeSettings_List()

Returns the list of ReflectionWavelengthRangeSettings elements.

No description available in the XSD standard.

Returns:

Type	Description
List[ReflectionWavelengthRangeSettings]	The list of ReflectionWavelengthRangeSettings elements

addToReflectionWavelengthRangeSettings_List(value)

Adds a new ReflectionWavelengthRangeSettings element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	ReflectionWavelengthRangeSettings	The element to add	required

clearReflectionWavelengthRangeSettings_List()

Clear the list of ReflectionWavelengthRangeSettings.

No description available in the XSD standard.