Pinhole

Bases: OpticalAperture_Type

Represents the XML element Pinhole.

A pin-like aperture positioned axially to the Light Path, which can act as a spatial filter for a beam of light to clean up the output of lasers and / or to suppress out-of-focus light in a confocal Microscope. Specifically, in Confocal Microscopy, such Pinholes are diaphragm typically situated in a plane conjugate with the object, and they restrict the area in the object plane that is illuminated and/or from which light is collected.

fromBase(base) staticmethod

Cast a NBOBaseClass to a CMOS.

Parameters:

Name	Type	Description	Default
base	NBOBaseClass	The base class to cast	required

Returns:

Type	Description
Pinhole	The casted element, or nullptr if the cast fails

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, validate=True)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromJsonString(json_string, validate=True)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlFile(path, validate=True)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlString(xml_string, validate=True)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlFile(filename, validate=True)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlString(validate=True)

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

Returns:

Type	Description
string	A string containing the XML representation of this object

setMaxDiameter(value, validate=True)

Sets the value of the MaxDiameter attribute.

This field records the maximum physical diameter of this Pinhole.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getMaxDiameter()

Returns the value of the MaxDiameter attribute.

This field records the maximum physical diameter of this Pinhole.

Returns:

Type	Description
float	The value of the attribute

resetMaxDiameter()

Resets the MaxDiameter attribute to an unset state.

This field records the maximum physical diameter of this Pinhole.

hasMaxDiameter()

Checks whether the MaxDiameter attribute is present.

This field records the maximum physical diameter of this Pinhole.

Returns:

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

setMaxDiameterUnit(value, validate=True)

Sets the value of the MaxDiameterUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getMaxDiameterUnit()

Returns the value of the MaxDiameterUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetMaxDiameterUnit()

Resets the MaxDiameterUnit attribute to an unset state.

No description available in the XSD standard.

hasMaxDiameterUnit()

Checks whether the optional MaxDiameterUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setShape(value, validate=True)

Sets the value of the Shape attribute.

This field records the Shape of this Pinhole.

Parameters:

Name	Type	Description	Default
value	PinholeShapeList_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getShape()

Returns the value of the Shape attribute.

This field records the Shape of this Pinhole.

Returns:

Type	Description
PinholeShapeList_Type	The value of the attribute

resetShape()

Resets the Shape attribute to an unset state.

This field records the Shape of this Pinhole.

hasShape()

Checks whether the optional Shape attribute is present.

This field records the Shape of this Pinhole.

Returns:

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