PolarizationOptics

Bases: ManufacturerSpec_Type

Represents the XML element PolarizationOptics.

This element describes a Polarization device positioned in the Ligth Path for this Instrument. A Polarization device is an optical filter rotatable through 360° that lets light waves of a specific polarization pass through while blocking light waves of other polarizations. This element can be associated with an optional Optics Turret.

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

getID()

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

Type	Description
PolarizationOpticsID_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

setFunction(value)

Sets the value of the Function attribute.

This field records whether this Polarization Optics is used to generate (Polarizer) or to analyze (Analyzer) polarized light.

Parameters:

Name	Type	Description	Default
value	PolarizationOpticsFunction_Type	The value to set	required

getFunction()

Returns the value of the Function attribute.

This field records whether this Polarization Optics is used to generate (Polarizer) or to analyze (Analyzer) polarized light.

Returns:

Type	Description
PolarizationOpticsFunction_Type	The value of the attribute

resetFunction()

Resets the Function attribute to an unset state.

This field records whether this Polarization Optics is used to generate (Polarizer) or to analyze (Analyzer) polarized light.

hasFunction()

Checks whether the optional Function attribute is present.

This field records whether this Polarization Optics is used to generate (Polarizer) or to analyze (Analyzer) polarized light.

Returns:

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

setCrossPolarizer(value)

Sets the value of the CrossPolarizer attribute.

This field records whether (True) or not (False) this Polarization Optics is a combination of an Analyzer and a Polarizer positioned orthogonal to each other.

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getCrossPolarizer()

Returns the value of the CrossPolarizer attribute.

This field records whether (True) or not (False) this Polarization Optics is a combination of an Analyzer and a Polarizer positioned orthogonal to each other.

Returns:

Type	Description
boolean	The value of the attribute

setDIC(value)

Sets the value of the DIC attribute.

This field records whether (True) or not (False) this PolarizationOptics is used for Differential Interference Contrast (DIC) microscopy.

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getDIC()

Returns the value of the DIC attribute.

This field records whether (True) or not (False) this PolarizationOptics is used for Differential Interference Contrast (DIC) microscopy.

Returns:

Type	Description
boolean	The value of the attribute

setBeamSplitter(value)

Sets the value of the BeamSplitter attribute.

This field records whether (True) or not (False) this is PolarizationOptics has a beam splitter function.

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getBeamSplitter()

Returns the value of the BeamSplitter attribute.

This field records whether (True) or not (False) this is PolarizationOptics has a beam splitter function.

Returns:

Type	Description
boolean	The value of the attribute

resetBeamSplitter()

Resets the BeamSplitter attribute to an unset state.

This field records whether (True) or not (False) this is PolarizationOptics has a beam splitter function.

hasBeamSplitter()

Checks whether the optional BeamSplitter attribute is present.

This field records whether (True) or not (False) this is PolarizationOptics has a beam splitter function.

Returns:

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

setFaradayIsolator(value)

Sets the value of the FaradayIsolator attribute.

This field records whether (True) or not (False) this PolarizationOptics is a Fraday Isolator. A Faraday Isolator is an optical component which allows light to pass through in only ONE direction and therefore protects laser systems against back reflection. It uses the Faraday magneto-optical effect to turn the polarization of light between various polarizers.

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getFaradayIsolator()

Returns the value of the FaradayIsolator attribute.

This field records whether (True) or not (False) this PolarizationOptics is a Fraday Isolator. A Faraday Isolator is an optical component which allows light to pass through in only ONE direction and therefore protects laser systems against back reflection. It uses the Faraday magneto-optical effect to turn the polarization of light between various polarizers.

Returns:

Type	Description
boolean	The value of the attribute

resetFaradayIsolator()

Resets the FaradayIsolator attribute to an unset state.

This field records whether (True) or not (False) this PolarizationOptics is a Fraday Isolator. A Faraday Isolator is an optical component which allows light to pass through in only ONE direction and therefore protects laser systems against back reflection. It uses the Faraday magneto-optical effect to turn the polarization of light between various polarizers.

hasFaradayIsolator()

Checks whether the optional FaradayIsolator attribute is present.

This field records whether (True) or not (False) this PolarizationOptics is a Fraday Isolator. A Faraday Isolator is an optical component which allows light to pass through in only ONE direction and therefore protects laser systems against back reflection. It uses the Faraday magneto-optical effect to turn the polarization of light between various polarizers.

Returns:

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

setConstruction(value)

Sets the value of the Construction attribute.

This field records the modality with which this PolarizationOptics is constructed.

Parameters:

Name	Type	Description	Default
value	PolarizationOpticsConstruction_Type	The value to set	required

getConstruction()

Returns the value of the Construction attribute.

This field records the modality with which this PolarizationOptics is constructed.

Returns:

Type	Description
PolarizationOpticsConstruction_Type	The value of the attribute

resetConstruction()

Resets the Construction attribute to an unset state.

This field records the modality with which this PolarizationOptics is constructed.

hasConstruction()

Checks whether the optional Construction attribute is present.

This field records the modality with which this PolarizationOptics is constructed.

Returns:

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

setRetardation(value)

Sets the value of the Retardation attribute.

This field records the Phase shift that exists between the polarized light component projected along the fast axis and the part projected along the slow axis.

Parameters:

Name	Type	Description	Default
value	PolarizationOpticsRetardation_Type	The value to set	required

getRetardation()

Returns the value of the Retardation attribute.

This field records the Phase shift that exists between the polarized light component projected along the fast axis and the part projected along the slow axis.

Returns:

Type	Description
PolarizationOpticsRetardation_Type	The value of the attribute

resetRetardation()

Resets the Retardation attribute to an unset state.

This field records the Phase shift that exists between the polarized light component projected along the fast axis and the part projected along the slow axis.

hasRetardation()

Checks whether the optional Retardation attribute is present.

This field records the Phase shift that exists between the polarized light component projected along the fast axis and the part projected along the slow axis.

Returns:

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

setFabrication(value)

Sets the value of the Fabrication attribute.

This field records the way in with which this PolarizationOptics is fabricated.

Parameters:

Name	Type	Description	Default
value	PolarizationOpticsFabrication_Type	The value to set	required

getFabrication()

Returns the value of the Fabrication attribute.

This field records the way in with which this PolarizationOptics is fabricated.

Returns:

Type	Description
PolarizationOpticsFabrication_Type	The value of the attribute

resetFabrication()

Resets the Fabrication attribute to an unset state.

This field records the way in with which this PolarizationOptics is fabricated.

hasFabrication()

Checks whether the optional Fabrication attribute is present.

This field records the way in with which this PolarizationOptics is fabricated.

Returns:

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

setMaterialName(value)

Sets the value of the MaterialName attribute.

This field records the chemical composition or designation of the Material this Polarization Optics is made of.

Parameters:

Name	Type	Description	Default
value	OpticalMaterialName_Type	The value to set	required

getMaterialName()

Returns the value of the MaterialName attribute.

This field records the chemical composition or designation of the Material this Polarization Optics is made of.

Returns:

Type	Description
OpticalMaterialName_Type	The value of the attribute

resetMaterialName()

Resets the MaterialName attribute to an unset state.

This field records the chemical composition or designation of the Material this Polarization Optics is made of.

hasMaterialName()

Checks whether the optional MaterialName attribute is present.

This field records the chemical composition or designation of the Material this Polarization Optics is made of.

Returns:

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

setGlassCode(value)

Sets the value of the GlassCode attribute.

If available, this field records the international Glass Code of the material that constitutes this Lens. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getGlassCode()

Returns the value of the GlassCode attribute.

If available, this field records the international Glass Code of the material that constitutes this Lens. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd

Returns:

Type	Description
string	The value of the attribute

resetGlassCode()

Resets the GlassCode attribute to an unset state.

If available, this field records the international Glass Code of the material that constitutes this Lens. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd

hasGlassCode()

Checks whether the optional GlassCode attribute is present.

If available, this field records the international Glass Code of the material that constitutes this Lens. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd

Returns:

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

setWavelengthRange_List(value)

Sets the list of WavelengthRange elements.

This element records the Range of Wavelengths this device is designed for, according to the Manufacturer. Multiple of this element may be used.

Parameters:

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

getWavelengthRange_List()

Returns the list of WavelengthRange elements.

This element records the Range of Wavelengths this device is designed for, according to the Manufacturer. Multiple of this element may be used.

Returns:

Type	Description
List[PolarizationOptics_InlineWavelengthRange]	The list of WavelengthRange elements

addToWavelengthRange_List(value)

Adds a new WavelengthRange element to this object.

This element records the Range of Wavelengths this device is designed for, according to the Manufacturer. Multiple of this element may be used.

Parameters:

Name	Type	Description	Default
value	PolarizationOptics_InlineWavelengthRange	The element to add	required

clearWavelengthRange_List()

Clear the list of WavelengthRange.

This element records the Range of Wavelengths this device is designed for, according to the Manufacturer. Multiple of this element may be used.

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