Bases: ManufacturerSpec_Type
Represents the XML complex type MirroringDevice.
This element describes a Mirror positioned in the Light Path for one or more Channels available for this Instrument. An Instrument may have several Mirrors of different types, such as Dichroic, Beamsplitter or Reflector. This element can be associated with an optional Optics Holder, such as a Filter Cube, Filter Turret, Filter Wheel, or Filter Slider.
fromBase ( base )
staticmethod
fromJsonFile ( path , validate = True )
fromJsonString ( json_string , validate = True )
fromXmlFile ( path , validate = True )
fromXmlString ( xml_string , validate = True )
toXmlFile ( filename , validate = True )
toXmlString ( validate = True )
setID ( value , validate = True )
setName ( value , validate = True )
setOpticsHolderPosition ( value , validate = True )
Sets the value of the OpticsHolderPosition attribute.
This field records the position of this Mirroring Device in a Optics Holder of any kind, such as a Slider, Turret or Wheel.
Parameters:
Name
Type
Description
Default
value
string
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getOpticsHolderPosition ()
Returns the value of the OpticsHolderPosition attribute.
This field records the position of this Mirroring Device in a Optics Holder of any kind, such as a Slider, Turret or Wheel.
Returns:
Type
Description
string
The value of the attribute
resetOpticsHolderPosition ()
Resets the OpticsHolderPosition attribute to an unset state.
This field records the position of this Mirroring Device in a Optics Holder of any kind, such as a Slider, Turret or Wheel.
hasOpticsHolderPosition ()
Checks whether the OpticsHolderPosition attribute is present.
This field records the position of this Mirroring Device in a Optics Holder of any kind, such as a Slider, Turret or Wheel.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
getOpticsHolderPositionAllowedValues ()
staticmethod
Returns the allowed values for this attribut.
This field records the position of this Mirroring Device in a Optics Holder of any kind, such as a Slider, Turret or Wheel.
Returns:
Type
Description
std::set< str,std::less< str >,std::allocator< str > >
The list of allowed values
setMirrorType ( value , validate = True )
setGeometry ( value , validate = True )
setDiameter ( value , validate = True )
setDiameterUnit ( value , validate = True )
setRadiusOfCurvature ( value , validate = True )
Sets the value of the RadiusOfCurvature attribute.
The radius of curvature of this Mirror. A spherical lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the radius of curvature of the surface.
Parameters:
Name
Type
Description
Default
value
float
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getRadiusOfCurvature ()
Returns the value of the RadiusOfCurvature attribute.
The radius of curvature of this Mirror. A spherical lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the radius of curvature of the surface.
Returns:
Type
Description
float
The value of the attribute
resetRadiusOfCurvature ()
Resets the RadiusOfCurvature attribute to an unset state.
The radius of curvature of this Mirror. A spherical lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the radius of curvature of the surface.
hasRadiusOfCurvature ()
Checks whether the RadiusOfCurvature attribute is present.
The radius of curvature of this Mirror. A spherical lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the radius of curvature of the surface.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setRadiusOfCurvatureUnit ( value , validate = True )
getRadiusOfCurvatureUnit ()
resetRadiusOfCurvatureUnit ()
hasRadiusOfCurvatureUnit ()
setAngleOfIncidence ( value , validate = True )
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
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
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 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 attribute has been set, false otherwise
setAngleOfIncidenceUnit ( value , validate = True )
getAngleOfIncidenceUnit ()
resetAngleOfIncidenceUnit ()
hasAngleOfIncidenceUnit ()
getAngleOfIncidenceUnitAllowedValues ()
staticmethod
setSubstrateType ( value , validate = True )
getSubstrateTypeAllowedValues ()
staticmethod
setSubstrateMaterial ( value , validate = True )
Sets the value of the SubstrateMaterial attribute.
This field records the chemical composition or the designation of the substrate of this Mirroring Device. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica or Borofloat.
Parameters:
Name
Type
Description
Default
value
OpticalMaterialName_Type
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getSubstrateMaterial ()
Returns the value of the SubstrateMaterial attribute.
This field records the chemical composition or the designation of the substrate of this Mirroring Device. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica or Borofloat.
Returns:
Type
Description
OpticalMaterialName_Type
The value of the attribute
resetSubstrateMaterial ()
Resets the SubstrateMaterial attribute to an unset state.
This field records the chemical composition or the designation of the substrate of this Mirroring Device. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica or Borofloat.
hasSubstrateMaterial ()
Checks whether the optional SubstrateMaterial attribute is present.
This field records the chemical composition or the designation of the substrate of this Mirroring Device. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica or Borofloat.
Returns:
Type
Description
boolean
true if the optional attribute has been set, false otherwise
setGlassCode ( value , validate = True )
Sets the value of the GlassCode attribute.
If available, this field records the international Glass Code of the material that constitutes this Mirror. 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 = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.
Parameters:
Name
Type
Description
Default
value
string
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getGlassCode ()
Returns the value of the GlassCode attribute.
If available, this field records the international Glass Code of the material that constitutes this Mirror. 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 = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.
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 Mirror. 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 = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.
hasGlassCode ()
Checks whether the GlassCode attribute is present.
If available, this field records the international Glass Code of the material that constitutes this Mirror. 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 = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
getGlassCodeAllowedValues ()
staticmethod
Returns the allowed values for this attribut.
If available, this field records the international Glass Code of the material that constitutes this Mirror. 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 = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.
Returns:
Type
Description
std::set< str,std::less< str >,std::allocator< str > >
The list of allowed values
setAnnotationRef ( value , validate = True )