Prism

Bases: ManufacturerSpec_Type

Represents the XML element Prism.

This element describes a Prism positioned in the Light Path for one or more Channels available for this Instrument. A Prism is a block of glass or other transparent material with at least two intersecting flat, polished surfaces, used to disperse light or deviate it through an angle. A Prism can be viewed as an ensemble of different rigidly mounted Mirrors, with each face having a permanent orientation with respect to others. A Prism can be employed to deflect or deviate a light beam, rotate or invert an Image, separate polarization states, or disperse light into its component Wavelengths. An Instrument may have several Prisms with different functionality such as Polarizing, Reflecting, or Refracting (or Dispersing). Polarizing Prisms are birefringent crystals that divide incident non-polarized light into separate components polarized orthogonally to each other. Reflecting Prisms are useful for redirecting light beams by total internal reflection. Refracting (or Dispersing) Prisms can be employed to bend and separate light into its component colors. 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	PrismID_Type	The value to set	required

getID()

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

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

setDIC(value)

Sets the value of the DIC attribute.

This field records whether this Prism is used for Differential Interference Contrast (DIC) microscopy and, if so, what DIC-compatible type it is (i.e., deSenarmont, Nomarski or Wollaston).

Parameters:

Name	Type	Description	Default
value	DICPrismType_Type	The value to set	required

getDIC()

Returns the value of the DIC attribute.

This field records whether this Prism is used for Differential Interference Contrast (DIC) microscopy and, if so, what DIC-compatible type it is (i.e., deSenarmont, Nomarski or Wollaston).

Returns:

Type	Description
DICPrismType_Type	The value of the attribute

resetDIC()

Resets the DIC attribute to an unset state.

This field records whether this Prism is used for Differential Interference Contrast (DIC) microscopy and, if so, what DIC-compatible type it is (i.e., deSenarmont, Nomarski or Wollaston).

hasDIC()

Checks whether the optional DIC attribute is present.

This field records whether this Prism is used for Differential Interference Contrast (DIC) microscopy and, if so, what DIC-compatible type it is (i.e., deSenarmont, Nomarski or Wollaston).

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 the function of this Prism. Beam-shaping (i.e., Anamorphic) Prism pairs are used for reshaping the profile of a laser beam. For example, the elliptical beam from a laser diode can be transformed into a beam with circular cross-section, by magnifying the elliptical beam in one dimension. They can also be used to convert a circular beam into an elliptical beam. Dispersing prisms can be employed to bend and separate light into its component wavelengths. Polarizing prisms (i.e., Glan–Thompson, Nomarski, Wollaston) are birefringent crystals, which divide incident non-polarized light into separate components polarized orthogonally to each other. Reflecting prisms are useful for redirecting (i.e., flip, invert, rotate, etc.) light beams by total internal reflection or for dividing them into two or more separate beams (i.e., beam-splitting) one.

Parameters:

Name	Type	Description	Default
value	PrismFunction_Type	The value to set	required

getFunction()

Returns the value of the Function attribute.

This field records the function of this Prism. Beam-shaping (i.e., Anamorphic) Prism pairs are used for reshaping the profile of a laser beam. For example, the elliptical beam from a laser diode can be transformed into a beam with circular cross-section, by magnifying the elliptical beam in one dimension. They can also be used to convert a circular beam into an elliptical beam. Dispersing prisms can be employed to bend and separate light into its component wavelengths. Polarizing prisms (i.e., Glan–Thompson, Nomarski, Wollaston) are birefringent crystals, which divide incident non-polarized light into separate components polarized orthogonally to each other. Reflecting prisms are useful for redirecting (i.e., flip, invert, rotate, etc.) light beams by total internal reflection or for dividing them into two or more separate beams (i.e., beam-splitting) one.

Returns:

Type	Description
PrismFunction_Type	The value of the attribute

resetFunction()

Resets the Function attribute to an unset state.

This field records the function of this Prism. Beam-shaping (i.e., Anamorphic) Prism pairs are used for reshaping the profile of a laser beam. For example, the elliptical beam from a laser diode can be transformed into a beam with circular cross-section, by magnifying the elliptical beam in one dimension. They can also be used to convert a circular beam into an elliptical beam. Dispersing prisms can be employed to bend and separate light into its component wavelengths. Polarizing prisms (i.e., Glan–Thompson, Nomarski, Wollaston) are birefringent crystals, which divide incident non-polarized light into separate components polarized orthogonally to each other. Reflecting prisms are useful for redirecting (i.e., flip, invert, rotate, etc.) light beams by total internal reflection or for dividing them into two or more separate beams (i.e., beam-splitting) one.

hasFunction()

Checks whether the optional Function attribute is present.

This field records the function of this Prism. Beam-shaping (i.e., Anamorphic) Prism pairs are used for reshaping the profile of a laser beam. For example, the elliptical beam from a laser diode can be transformed into a beam with circular cross-section, by magnifying the elliptical beam in one dimension. They can also be used to convert a circular beam into an elliptical beam. Dispersing prisms can be employed to bend and separate light into its component wavelengths. Polarizing prisms (i.e., Glan–Thompson, Nomarski, Wollaston) are birefringent crystals, which divide incident non-polarized light into separate components polarized orthogonally to each other. Reflecting prisms are useful for redirecting (i.e., flip, invert, rotate, etc.) light beams by total internal reflection or for dividing them into two or more separate beams (i.e., beam-splitting) one.

Returns:

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

setCondenser(value)

Sets the value of the Condenser attribute.

This field records whether this Prism is within the Condenser (True) or the Objective (False).

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getCondenser()

Returns the value of the Condenser attribute.

This field records whether this Prism is within the Condenser (True) or the Objective (False).

Returns:

Type	Description
boolean	The value of the attribute

setOilObjective(value)

Sets the value of the OilObjective attribute.

This field records whether this Prism is designed to work with oil Objectives (True) or not (False).

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getOilObjective()

Returns the value of the OilObjective attribute.

This field records whether this Prism is designed to work with oil Objectives (True) or not (False).

Returns:

Type	Description
boolean	The value of the attribute

setCompound(value)

Sets the value of the Compound attribute.

This field records whether this Prism is a Compound Prism (i.e., a set of multiple triangular prism elements placed in contact, and often cemented together to form a solid assembly; True) or a Simple Prism (False).

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getCompound()

Returns the value of the Compound attribute.

This field records whether this Prism is a Compound Prism (i.e., a set of multiple triangular prism elements placed in contact, and often cemented together to form a solid assembly; True) or a Simple Prism (False).

Returns:

Type	Description
boolean	The value of the attribute

resetCompound()

Resets the Compound attribute to an unset state.

This field records whether this Prism is a Compound Prism (i.e., a set of multiple triangular prism elements placed in contact, and often cemented together to form a solid assembly; True) or a Simple Prism (False).

hasCompound()

Checks whether the optional Compound attribute is present.

This field records whether this Prism is a Compound Prism (i.e., a set of multiple triangular prism elements placed in contact, and often cemented together to form a solid assembly; True) or a Simple Prism (False).

Returns:

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

setRefractiveIndex(value)

Sets the value of the RefractiveIndex attribute.

This field records the Refractive Index of the material this Prism is made of, as specified by the Manufacturer.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getRefractiveIndex()

Returns the value of the RefractiveIndex attribute.

This field records the Refractive Index of the material this Prism is made of, as specified by the Manufacturer.

Returns:

Type	Description
float	The value of the attribute

resetRefractiveIndex()

Resets the RefractiveIndex attribute to an unset state.

This field records the Refractive Index of the material this Prism is made of, as specified by the Manufacturer.

hasRefractiveIndex()

Checks whether the optional RefractiveIndex attribute is present.

This field records the Refractive Index of the material this Prism is made of, as specified by the Manufacturer.

Returns:

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

setReflectance(value)

Sets the value of the Reflectance attribute.

This field records the maximum amount of light this Prism is capable of transmitting at peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getReflectance()

Returns the value of the Reflectance attribute.

This field records the maximum amount of light this Prism is capable of transmitting at peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

Returns:

Type	Description
float	The value of the attribute

setAngleOfIncidence(value)

Sets the value of the AngleOfIncidence attribute.

This field records the Angle Of Incidence (AOI) is the angle between a beam of light incident on the Prism surface and the line perpendicular to the surface at the point of incidence, called the normal.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getAngleOfIncidence()

Returns the value of the AngleOfIncidence attribute.

This field records the Angle Of Incidence (AOI) is the angle between a beam of light incident on the Prism surface and the line perpendicular to the surface at the point of incidence, called the normal.

Returns:

Type	Description
float	The value of the attribute

resetAngleOfIncidence()

Resets the AngleOfIncidence attribute to an unset state.

This field records the Angle Of Incidence (AOI) is the angle between a beam of light incident on the Prism surface and the line perpendicular to the surface at the point of incidence, called the normal.

hasAngleOfIncidence()

Checks whether the optional AngleOfIncidence attribute is present.

This field records the Angle Of Incidence (AOI) is the angle between a beam of light incident on the Prism surface and the line perpendicular to the surface at the point of incidence, called the normal.

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

setDeviationAngle(value)

Sets the value of the DeviationAngle attribute.

This field records the Deviation Angle of this Prism. A beam passing through an object like a prism is deflected twice: once entering, and again when exiting. The sum of these two deflections is called the deviation angle and is measured with respect to the incident ray.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getDeviationAngle()

Returns the value of the DeviationAngle attribute.

This field records the Deviation Angle of this Prism. A beam passing through an object like a prism is deflected twice: once entering, and again when exiting. The sum of these two deflections is called the deviation angle and is measured with respect to the incident ray.

Returns:

Type	Description
float	The value of the attribute

resetDeviationAngle()

Resets the DeviationAngle attribute to an unset state.

This field records the Deviation Angle of this Prism. A beam passing through an object like a prism is deflected twice: once entering, and again when exiting. The sum of these two deflections is called the deviation angle and is measured with respect to the incident ray.

hasDeviationAngle()

Checks whether the optional DeviationAngle attribute is present.

This field records the Deviation Angle of this Prism. A beam passing through an object like a prism is deflected twice: once entering, and again when exiting. The sum of these two deflections is called the deviation angle and is measured with respect to the incident ray.

Returns:

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

setDevianceAngleUnit(value)

Sets the value of the DevianceAngleUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsAngle_Type	The value to set	required

getDevianceAngleUnit()

Returns the value of the DevianceAngleUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsAngle_Type	The value of the attribute

resetDevianceAngleUnit()

Resets the DevianceAngleUnit attribute to an unset state.

No description available in the XSD standard.

hasDevianceAngleUnit()

Checks whether the optional DevianceAngleUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setPrismAngle(value)

Sets the value of the PrismAngle attribute.

This field records the Angle between two surfaces of this Prism.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getPrismAngle()

Returns the value of the PrismAngle attribute.

This field records the Angle between two surfaces of this Prism.

Returns:

Type	Description
float	The value of the attribute

resetPrismAngle()

Resets the PrismAngle attribute to an unset state.

This field records the Angle between two surfaces of this Prism.

hasPrismAngle()

Checks whether the optional PrismAngle attribute is present.

This field records the Angle between two surfaces of this Prism.

Returns:

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

setPrismAngleUnit(value)

Sets the value of the PrismAngleUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsAngle_Type	The value to set	required

getPrismAngleUnit()

Returns the value of the PrismAngleUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsAngle_Type	The value of the attribute

resetPrismAngleUnit()

Resets the PrismAngleUnit attribute to an unset state.

No description available in the XSD standard.

hasPrismAngleUnit()

Checks whether the optional PrismAngleUnit attribute is present.

No description available in the XSD standard.

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 records the shape of the Prism with specific reference to the angles defined by its faces.

Parameters:

Name	Type	Description	Default
value	PrismDesign_Type	The value to set	required

getDesign()

Returns the value of the Design attribute.

This field records the shape of the Prism with specific reference to the angles defined by its faces.

Returns:

Type	Description
PrismDesign_Type	The value of the attribute

resetDesign()

Resets the Design attribute to an unset state.

This field records the shape of the Prism with specific reference to the angles defined by its faces.

hasDesign()

Checks whether the optional Design attribute is present.

This field records the shape of the Prism with specific reference to the angles defined by its faces.

Returns:

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

setAbbeNumber(value)

Sets the value of the AbbeNumber attribute.

This field records the Abbe number of this Prism. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getAbbeNumber()

Returns the value of the AbbeNumber attribute.

This field records the Abbe number of this Prism. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.

Returns:

Type	Description
float	The value of the attribute

resetAbbeNumber()

Resets the AbbeNumber attribute to an unset state.

This field records the Abbe number of this Prism. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.

hasAbbeNumber()

Checks whether the optional AbbeNumber attribute is present.

This field records the Abbe number of this Prism. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.

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 Prism 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 Prism 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 Prism is made of.

hasMaterialName()

Checks whether the optional MaterialName attribute is present.

This field records the chemical composition or designation of the Material this Prism 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 Prism. 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 Prism. 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 Prism. 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 Prism. 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

setDensity(value)

Sets the value of the Density attribute.

This field records the Density of the material this Prism is made of.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getDensity()

Returns the value of the Density attribute.

This field records the Density of the material this Prism is made of.

Returns:

Type	Description
float	The value of the attribute

resetDensity()

Resets the Density attribute to an unset state.

This field records the Density of the material this Prism is made of.

hasDensity()

Checks whether the optional Density attribute is present.

This field records the Density of the material this Prism is made of.

Returns:

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

setDensityUnit(value)

Sets the value of the DensityUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsDensity_Type	The value to set	required

getDensityUnit()

Returns the value of the DensityUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsDensity_Type	The value of the attribute

resetDensityUnit()

Resets the DensityUnit attribute to an unset state.

No description available in the XSD standard.

hasDensityUnit()

Checks whether the optional DensityUnit attribute is present.

No description available in the XSD standard.

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[Prism_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[Prism_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	Prism_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