PinholeSettings

Bases: OpticalApertureSettings_Type

Represents the XML element PinholeSettings.

This element holds the Setting applied to a Pinhole used during the Acquisition of this Channel as well as a reference (the ID attribute) to the Pinhole in question.

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

setAperture(value)

Sets the value of the Aperture attribute.

This refers to the Diameter of the Pin Hole's Aperture that was set for this Acquisition, expressed in Airy units.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getAperture()

Returns the value of the Aperture attribute.

This refers to the Diameter of the Pin Hole's Aperture that was set for this Acquisition, expressed in Airy units.

Returns:

Type	Description
float	The value of the attribute