MicrolensArray

Bases: NBOBaseClass

Represents the XML element MicrolensArray.

Micro-lens arrays contain multiple micro-lenses forming a one- or two-dimensional array on a supporting substrate.

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

getID()

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

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

setLensletDiameter(value)

Sets the value of the LensletDiameter attribute.

This field records the physical Dameter of the Lenslets that compose this Micro Lens Array.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getLensletDiameter()

Returns the value of the LensletDiameter attribute.

This field records the physical Dameter of the Lenslets that compose this Micro Lens Array.

Returns:

Type	Description
float	The value of the attribute

resetLensletDiameter()

Resets the LensletDiameter attribute to an unset state.

This field records the physical Dameter of the Lenslets that compose this Micro Lens Array.

hasLensletDiameter()

Checks whether the optional LensletDiameter attribute is present.

This field records the physical Dameter of the Lenslets that compose this Micro Lens Array.

Returns:

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

setLensletDiameterUnit(value)

Sets the value of the LensletDiameterUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getLensletDiameterUnit()

Returns the value of the LensletDiameterUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetLensletDiameterUnit()

Resets the LensletDiameterUnit attribute to an unset state.

No description available in the XSD standard.

hasLensletDiameterUnit()

Checks whether the optional LensletDiameterUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setLensletPitch(value)

Sets the value of the LensletPitch attribute.

This field records the distance between Lenslets in this Micro Lens Array.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getLensletPitch()

Returns the value of the LensletPitch attribute.

This field records the distance between Lenslets in this Micro Lens Array.

Returns:

Type	Description
float	The value of the attribute

resetLensletPitch()

Resets the LensletPitch attribute to an unset state.

This field records the distance between Lenslets in this Micro Lens Array.

hasLensletPitch()

Checks whether the optional LensletPitch attribute is present.

This field records the distance between Lenslets in this Micro Lens Array.

Returns:

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

setLensletPitchUnit(value)

Sets the value of the LensletPitchUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getLensletPitchUnit()

Returns the value of the LensletPitchUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetLensletPitchUnit()

Resets the LensletPitchUnit attribute to an unset state.

No description available in the XSD standard.

hasLensletPitchUnit()

Checks whether the optional LensletPitchUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setLensletArrangement(value)

Sets the value of the LensletArrangement attribute.

This field records the arrangement of individual Lenslets on this Array.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getLensletArrangement()

Returns the value of the LensletArrangement attribute.

This field records the arrangement of individual Lenslets on this Array.

Returns:

Type	Description
string	The value of the attribute

resetLensletArrangement()

Resets the LensletArrangement attribute to an unset state.

This field records the arrangement of individual Lenslets on this Array.

hasLensletArrangement()

Checks whether the optional LensletArrangement attribute is present.

This field records the arrangement of individual Lenslets on this Array.

Returns:

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

setLensletShape(value)

Sets the value of the LensletShape attribute.

This field records the geometrical shape (e.g., round vs. square) of the individual Lenslets composing this Micro Lens Array.

Parameters:

Name	Type	Description	Default
value	LensletShape_Type	The value to set	required

getLensletShape()

Returns the value of the LensletShape attribute.

This field records the geometrical shape (e.g., round vs. square) of the individual Lenslets composing this Micro Lens Array.

Returns:

Type	Description
LensletShape_Type	The value of the attribute

resetLensletShape()

Resets the LensletShape attribute to an unset state.

This field records the geometrical shape (e.g., round vs. square) of the individual Lenslets composing this Micro Lens Array.

hasLensletShape()

Checks whether the optional LensletShape attribute is present.

This field records the geometrical shape (e.g., round vs. square) of the individual Lenslets composing this Micro Lens Array.

Returns:

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

setLensletProfileShape(value)

Sets the value of the LensletProfileShape attribute.

This field describes the shape of the profile (e.g., concave vs. convex) of the individual Lenslets that compose this Micro Lens Array.

Parameters:

Name	Type	Description	Default
value	LensShapeType_Type	The value to set	required

getLensletProfileShape()

Returns the value of the LensletProfileShape attribute.

This field describes the shape of the profile (e.g., concave vs. convex) of the individual Lenslets that compose this Micro Lens Array.

Returns:

Type	Description
LensShapeType_Type	The value of the attribute

resetLensletProfileShape()

Resets the LensletProfileShape attribute to an unset state.

This field describes the shape of the profile (e.g., concave vs. convex) of the individual Lenslets that compose this Micro Lens Array.

hasLensletProfileShape()

Checks whether the optional LensletProfileShape attribute is present.

This field describes the shape of the profile (e.g., concave vs. convex) of the individual Lenslets that compose this Micro Lens Array.

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

setReflectance(value)

Sets the value of the Reflectance attribute.

This field records the maximum amount of light this Micro Lens Array is capable of reflecting. 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 Micro Lens Array is capable of reflecting. It is represented as a fractional value from 0.0 to 1.0.

Returns:

Type	Description
float	The value of the attribute

setSustrateMaterial(value)

Sets the value of the SustrateMaterial attribute.

This field records the chemical composition or designation of the substrate of this Micro Lens Array. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica.

Parameters:

Name	Type	Description	Default
value	OpticalMaterialName_Type	The value to set	required

getSustrateMaterial()

Returns the value of the SustrateMaterial attribute.

This field records the chemical composition or designation of the substrate of this Micro Lens Array. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica.

Returns:

Type	Description
OpticalMaterialName_Type	The value of the attribute

resetSustrateMaterial()

Resets the SustrateMaterial attribute to an unset state.

This field records the chemical composition or designation of the substrate of this Micro Lens Array. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica.

hasSustrateMaterial()

Checks whether the optional SustrateMaterial attribute is present.

This field records the chemical composition or designation of the substrate of this Micro Lens Array. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica.

Returns:

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

setFrontFocalLength(value)

Sets the value of the FrontFocalLength attribute.

This field records the distance (f) measured along the optical axis from the front principal plane of this Micro Lens Array to the front focal plane (F).

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getFrontFocalLength()

Returns the value of the FrontFocalLength attribute.

This field records the distance (f) measured along the optical axis from the front principal plane of this Micro Lens Array to the front focal plane (F).

Returns:

Type	Description
float	The value of the attribute

resetFrontFocalLength()

Resets the FrontFocalLength attribute to an unset state.

This field records the distance (f) measured along the optical axis from the front principal plane of this Micro Lens Array to the front focal plane (F).

hasFrontFocalLength()

Checks whether the optional FrontFocalLength attribute is present.

This field records the distance (f) measured along the optical axis from the front principal plane of this Micro Lens Array to the front focal plane (F).

Returns:

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

setBackFocalLength(value)

Sets the value of the BackFocalLength attribute.

This field records the distance (f') measured along the optical axis from the rear principal plane of this Micro Lens Array to the rear focal plane (F').

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getBackFocalLength()

Returns the value of the BackFocalLength attribute.

This field records the distance (f') measured along the optical axis from the rear principal plane of this Micro Lens Array to the rear focal plane (F').

Returns:

Type	Description
float	The value of the attribute

resetBackFocalLength()

Resets the BackFocalLength attribute to an unset state.

This field records the distance (f') measured along the optical axis from the rear principal plane of this Micro Lens Array to the rear focal plane (F').

hasBackFocalLength()

Checks whether the optional BackFocalLength attribute is present.

This field records the distance (f') measured along the optical axis from the rear principal plane of this Micro Lens Array to the rear focal plane (F').

Returns:

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

setOpticalDistanceUnit(value)

Sets the value of the OpticalDistanceUnit attribute.

Use this unit for both Focal Length fields.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getOpticalDistanceUnit()

Returns the value of the OpticalDistanceUnit attribute.

Use this unit for both Focal Length fields.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetOpticalDistanceUnit()

Resets the OpticalDistanceUnit attribute to an unset state.

Use this unit for both Focal Length fields.

hasOpticalDistanceUnit()

Checks whether the optional OpticalDistanceUnit attribute is present.

Use this unit for both Focal Length fields.

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

setWavelengthRange_List(value)

Sets the list of WavelengthRange elements.

No description available in the XSD standard.

Parameters:

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

getWavelengthRange_List()

Returns the list of WavelengthRange elements.

No description available in the XSD standard.

Returns:

Type	Description
List[WavelengthRange]	The list of WavelengthRange elements

addToWavelengthRange_List(value)

Adds a new WavelengthRange element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	WavelengthRange	The element to add	required

clearWavelengthRange_List()

Clear the list of WavelengthRange.

No description available in the XSD standard.