PhotoMultiplierTube

Bases: PointDetector_Type

Represents the XML element PhotoMultiplierTube.

A Photomultiplier Tube (PMT) is a photoemissive device in which the absorption of a photon results in the emission of an electron and it is used for the detection of very weak signals. These Detectors work by amplifying the electrons generated by a photocathode exposed to a photon flux. The higher the supplied voltage (PMTVoltage setting), the greater the amplification of the current (PMTGain setting) and thus sensitivity, but also the higher the noise in the acquired image. The amplifier offset (PMTOffset setting) defines black level setting of the image. A PMT has no inherent spatial information of the image.

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
PhotoMultiplierTube	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

setCollectionEfficiency(value, validate=True)

Sets the value of the CollectionEfficiency attribute.

This field measures the probability that photoelectrons will land on the effective area of the first dynode of the photomultiplier stage. While there might be dispersion at the second and later dynodes, this tends to have less of an effect on the total collection efficiency as the number of emitted electrons increases greatly.

Parameters:

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

getCollectionEfficiency()

Returns the value of the CollectionEfficiency attribute.

This field measures the probability that photoelectrons will land on the effective area of the first dynode of the photomultiplier stage. While there might be dispersion at the second and later dynodes, this tends to have less of an effect on the total collection efficiency as the number of emitted electrons increases greatly.

Returns:

Type	Description
PercentFraction_Type	The value of the attribute

resetCollectionEfficiency()

Resets the CollectionEfficiency attribute to an unset state.

This field measures the probability that photoelectrons will land on the effective area of the first dynode of the photomultiplier stage. While there might be dispersion at the second and later dynodes, this tends to have less of an effect on the total collection efficiency as the number of emitted electrons increases greatly.

hasCollectionEfficiency()

Checks whether the optional CollectionEfficiency attribute is present.

This field measures the probability that photoelectrons will land on the effective area of the first dynode of the photomultiplier stage. While there might be dispersion at the second and later dynodes, this tends to have less of an effect on the total collection efficiency as the number of emitted electrons increases greatly.

Returns:

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

setMultianode(value, validate=True)

Sets the value of the Multianode attribute.

This field records whether (True) or not (False) this is Photo Multiplier Tube is composed of an array of multiple

Parameters:

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

getMultianode()

Returns the value of the Multianode attribute.

This field records whether (True) or not (False) this is Photo Multiplier Tube is composed of an array of multiple

Returns:

Type	Description
boolean	The value of the attribute

resetMultianode()

Resets the Multianode attribute to an unset state.

This field records whether (True) or not (False) this is Photo Multiplier Tube is composed of an array of multiple

hasMultianode()

Checks whether the Multianode attribute is present.

This field records whether (True) or not (False) this is Photo Multiplier Tube is composed of an array of multiple

Returns:

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

setMultianodeChannelNr(value, validate=True)

Sets the value of the MultianodeChannelNr attribute.

In case this Detector is a Multianode composed of an array of multiple Photomultiplier Tubes, this field records the number of Channels it consists of.

Parameters:

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

getMultianodeChannelNr()

Returns the value of the MultianodeChannelNr attribute.

In case this Detector is a Multianode composed of an array of multiple Photomultiplier Tubes, this field records the number of Channels it consists of.

Returns:

Type	Description
int	The value of the attribute

resetMultianodeChannelNr()

Resets the MultianodeChannelNr attribute to an unset state.

In case this Detector is a Multianode composed of an array of multiple Photomultiplier Tubes, this field records the number of Channels it consists of.

hasMultianodeChannelNr()

Checks whether the MultianodeChannelNr attribute is present.

In case this Detector is a Multianode composed of an array of multiple Photomultiplier Tubes, this field records the number of Channels it consists of.

Returns:

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

setMultianodeArrangement(value, validate=True)

Sets the value of the MultianodeArrangement attribute.

In case this Detector is a Multianode composed of an array of multiple Photomultiplier Tubes, this field records the arrangement of the individual Photomultiplier Tubes.

Parameters:

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

getMultianodeArrangement()

Returns the value of the MultianodeArrangement attribute.

In case this Detector is a Multianode composed of an array of multiple Photomultiplier Tubes, this field records the arrangement of the individual Photomultiplier Tubes.

Returns:

Type	Description
MultianodeArrangement_Type	The value of the attribute

resetMultianodeArrangement()

Resets the MultianodeArrangement attribute to an unset state.

In case this Detector is a Multianode composed of an array of multiple Photomultiplier Tubes, this field records the arrangement of the individual Photomultiplier Tubes.

hasMultianodeArrangement()

Checks whether the optional MultianodeArrangement attribute is present.

In case this Detector is a Multianode composed of an array of multiple Photomultiplier Tubes, this field records the arrangement of the individual Photomultiplier Tubes.

Returns:

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

setHeadOn(value, validate=True)

Sets the value of the HeadOn attribute.

This is True if the Photocathode is positioned at either end of the vacuum tube. This is False if the photocathode element is located on the side of the vacuum tube (side-on geometry).

Parameters:

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

getHeadOn()

Returns the value of the HeadOn attribute.

This is True if the Photocathode is positioned at either end of the vacuum tube. This is False if the photocathode element is located on the side of the vacuum tube (side-on geometry).

Returns:

Type	Description
boolean	The value of the attribute

resetHeadOn()

Resets the HeadOn attribute to an unset state.

This is True if the Photocathode is positioned at either end of the vacuum tube. This is False if the photocathode element is located on the side of the vacuum tube (side-on geometry).

hasHeadOn()

Checks whether the HeadOn attribute is present.

This is True if the Photocathode is positioned at either end of the vacuum tube. This is False if the photocathode element is located on the side of the vacuum tube (side-on geometry).

Returns:

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