PointDetectorSettings
Bases: DetectorSettings_Type
Represents the XML element PointDetectorSettings.
This element refers to the Point Detector used to acquire this Channel and it holds the Settings that were applied to the Point Detector during this Acquisition.
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 |
setVoltage(value)
Sets the value of the Voltage attribute.
This field refers to the Voltage settings applied to the Photomultiplier Tube (PMT) for the Acquisition of this Channel (e.g., voltage
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getVoltage()
Returns the value of the Voltage attribute.
This field refers to the Voltage settings applied to the Photomultiplier Tube (PMT) for the Acquisition of this Channel (e.g., voltage
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
setVoltageUnit(value)
Sets the value of the VoltageUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UnitsElectricPotential_Type
|
The value to set |
required |
getVoltageUnit()
Returns the value of the VoltageUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
UnitsElectricPotential_Type
|
The value of the attribute |
resetVoltageUnit()
Resets the VoltageUnit attribute to an unset state.
No description available in the XSD standard.
hasVoltageUnit()
Checks whether the optional VoltageUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setPhotonCounting(value)
Sets the value of the PhotonCounting attribute.
This boolean indicates whether this Photomultiplier Tube was operated in photon-counting mode (True) or not (False), during the Acquisition of this Channel.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
boolean
|
The value to set |
required |
getPhotonCounting()
Returns the value of the PhotonCounting attribute.
This boolean indicates whether this Photomultiplier Tube was operated in photon-counting mode (True) or not (False), during the Acquisition of this Channel.
Returns:
| Type | Description |
|---|---|
boolean
|
The value of the attribute |
resetPhotonCounting()
Resets the PhotonCounting attribute to an unset state.
This boolean indicates whether this Photomultiplier Tube was operated in photon-counting mode (True) or not (False), during the Acquisition of this Channel.
hasPhotonCounting()
Checks whether the optional PhotonCounting attribute is present.
This boolean indicates whether this Photomultiplier Tube was operated in photon-counting mode (True) or not (False), during the Acquisition of this Channel.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |