Inscoper::NBO::PointDetectorSettings¶

Represents the XML element PointDetectorSettings. More...

#include <PointDetectorSettings.h>

Inherits from Inscoper::NBO::DetectorSettings_Type, Inscoper::NBO::Settings_Type, Inscoper::NBO::Reference_Type, NBOBaseClass

Public Functions¶

	Name
	PointDetectorSettings()
	~PointDetectorSettings()
virtual std::string	getTypeName() const override Returns the class type name.
std::string	getXMLName() const override Returns the XML element name corresponding to this class.
ENBOType	getNBOType() const override Returns the NBO Type corresponding to this class.
std::vector< NBOBaseClassPtr >	getChildren() const override Returns a list of all classes derived from this class.
std::vector< NBOBaseClassPtr >	getSubElements() const override Returns a list of all child elements contained in this class.
void	fromJsonFile(const std::string & path, bool validate =true) Populates this object from a JSON file.
void	fromJsonString(const std::string & json_string, bool validate =true) Populates this object from a JSON string.
void	fromXmlFile(const std::string & path, bool validate =true) Populates this object from a XML file.
void	fromXmlString(const std::string & xml_string, bool validate =true) Populates this object from a XML string.
void	toXmlFile(const std::string & filename, bool validate =true) const Serializes this object to an XML file.
std::string	toXmlString(bool validate =true) const Serializes this object to an XML string.
void	setVoltage(const float & value, bool validate =true) Sets the value of the Voltage attribute.
float	getVoltage() const Returns the value of the Voltage attribute.
void	resetVoltage() Resets the Voltage attribute to an unset state.
bool	hasVoltage() const Checks whether the Voltage attribute is present.
void	setVoltageUnit(const Inscoper::NBO::UnitsElectricPotential_TypePtr & value, bool validate =true) Sets the value of the VoltageUnit attribute.
UnitsElectricPotential_TypePtr	getVoltageUnit() const Returns the value of the VoltageUnit attribute.
void	resetVoltageUnit() Resets the VoltageUnit attribute to an unset state.
bool	hasVoltageUnit() const Checks whether the optional VoltageUnit attribute is present.
void	setPhotonCounting(const bool & value, bool validate =true) Sets the value of the PhotonCounting attribute.
bool	getPhotonCounting() const Returns the value of the PhotonCounting attribute.
void	resetPhotonCounting() Resets the PhotonCounting attribute to an unset state.
bool	hasPhotonCounting() const Checks whether the PhotonCounting attribute is present.
std::shared_ptr< PointDetectorSettings >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a PointDetectorSettings.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::DetectorSettings_Type

	Name
	DetectorSettings_Type()
	~DetectorSettings_Type()
void	setID(const Inscoper::NBO::DetectorID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
DetectorID_TypePtr	getID() const Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
bool	hasID() const Checks whether the optional ID attribute is present.
void	setEffectiveBitDepth(const Inscoper::NBO::DigitizerType_TypePtr & value, bool validate =true) Sets the value of the EffectiveBitDepth attribute.
DigitizerType_TypePtr	getEffectiveBitDepth() const Returns the value of the EffectiveBitDepth attribute.
void	resetEffectiveBitDepth() Resets the EffectiveBitDepth attribute to an unset state.
bool	hasEffectiveBitDepth() const Checks whether the optional EffectiveBitDepth attribute is present.
void	setAnalogGain(const float & value, bool validate =true) Sets the value of the AnalogGain attribute.
float	getAnalogGain() const Returns the value of the AnalogGain attribute.
void	resetAnalogGain() Resets the AnalogGain attribute to an unset state.
bool	hasAnalogGain() const Checks whether the AnalogGain attribute is present.
void	setAmplificationGain(const float & value, bool validate =true) Sets the value of the AmplificationGain attribute.
float	getAmplificationGain() const Returns the value of the AmplificationGain attribute.
void	resetAmplificationGain() Resets the AmplificationGain attribute to an unset state.
bool	hasAmplificationGain() const Checks whether the AmplificationGain attribute is present.
void	setOffset(const float & value, bool validate =true) Sets the value of the Offset attribute.
float	getOffset() const Returns the value of the Offset attribute.
void	resetOffset() Resets the Offset attribute to an unset state.
bool	hasOffset() const Checks whether the Offset attribute is present.
void	setOffsetMode(const Inscoper::NBO::DetectorOffsetMode_TypePtr & value, bool validate =true) Sets the value of the OffsetMode attribute.
DetectorOffsetMode_TypePtr	getOffsetMode() const Returns the value of the OffsetMode attribute.
void	resetOffsetMode() Resets the OffsetMode attribute to an unset state.
bool	hasOffsetMode() const Checks whether the optional OffsetMode attribute is present.

Public Functions inherited from Inscoper::NBO::Settings_Type

	Name
	Settings_Type()
	~Settings_Type()
void	setMapAnnotation_List(const std::vector< Inscoper::NBO::MapAnnotationPtr > & value, bool validate =true) Sets the list of MapAnnotation elements.
std::vector< Inscoper::NBO::MapAnnotationPtr >	getMapAnnotation_List() const Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(const Inscoper::NBO::MapAnnotationPtr & value, bool validate =true) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setAdditionalVendorInformation_List(const std::vector< Inscoper::NBO::AdditionalVendorInformationPtr > & value, bool validate =true) Sets the list of AdditionalVendorInformation elements.
std::vector< Inscoper::NBO::AdditionalVendorInformationPtr >	getAdditionalVendorInformation_List() const Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(const Inscoper::NBO::AdditionalVendorInformationPtr & value, bool validate =true) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.

Public Functions inherited from Inscoper::NBO::Reference_Type

	Name
	Reference_Type()
	~Reference_Type()

Detailed Description¶

class Inscoper::NBO::PointDetectorSettings;

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.

Public Functions Documentation¶

function PointDetectorSettings¶

function ~PointDetectorSettings¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

void fromJsonFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

void fromJsonString(
    const std::string & json_string,
    bool validate =true
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

void fromXmlFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

void fromXmlString(
    const std::string & xml_string,
    bool validate =true
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

void toXmlFile(
    const std::string & filename,
    bool validate =true
) const

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlString¶

std::string toXmlString(
    bool validate =true
) const

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function setVoltage¶

void setVoltage(
    const float & value,
    bool validate =true
)

Sets the value of the Voltage attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field refers to the Voltage settings applied to the Photomultiplier Tube (PMT) for the Acquisition of this Channel (e.g., voltage = 244). The higher the supplied Voltage, the greater the amplification of the current generated by the PMT. While this increases the sensitivity, it also increases the background in the resulting image.

function getVoltage¶

float getVoltage() const

Returns the value of the Voltage attribute.

Return: The value of the attribute

This field refers to the Voltage settings applied to the Photomultiplier Tube (PMT) for the Acquisition of this Channel (e.g., voltage = 244). The higher the supplied Voltage, the greater the amplification of the current generated by the PMT. While this increases the sensitivity, it also increases the background in the resulting image.

function resetVoltage¶

void resetVoltage()

Resets the Voltage attribute to an unset state.

This field refers to the Voltage settings applied to the Photomultiplier Tube (PMT) for the Acquisition of this Channel (e.g., voltage = 244). The higher the supplied Voltage, the greater the amplification of the current generated by the PMT. While this increases the sensitivity, it also increases the background in the resulting image.

function hasVoltage¶

bool hasVoltage() const

Checks whether the Voltage attribute is present.

Return: true if the attribute has been set, false otherwise

This field refers to the Voltage settings applied to the Photomultiplier Tube (PMT) for the Acquisition of this Channel (e.g., voltage = 244). The higher the supplied Voltage, the greater the amplification of the current generated by the PMT. While this increases the sensitivity, it also increases the background in the resulting image.

function setVoltageUnit¶

void setVoltageUnit(
    const Inscoper::NBO::UnitsElectricPotential_TypePtr & value,
    bool validate =true
)

Sets the value of the VoltageUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getVoltageUnit¶

function resetVoltageUnit¶

function hasVoltageUnit¶

bool hasVoltageUnit() const

Checks whether the optional VoltageUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setPhotonCounting¶

void setPhotonCounting(
    const bool & value,
    bool validate =true
)

Sets the value of the PhotonCounting attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This boolean indicates whether this Photomultiplier Tube was operated in photon-counting mode (True) or not (False), during the Acquisition of this Channel.

function getPhotonCounting¶

bool getPhotonCounting() const

Returns the value of the PhotonCounting attribute.

Return: The value of the attribute

This boolean indicates whether this Photomultiplier Tube was operated in photon-counting mode (True) or not (False), during the Acquisition of this Channel.

function resetPhotonCounting¶

void 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.

function hasPhotonCounting¶

bool hasPhotonCounting() const

Checks whether the PhotonCounting attribute is present.

Return: true if the attribute has been set, false otherwise

This boolean indicates whether this Photomultiplier Tube was operated in photon-counting mode (True) or not (False), during the Acquisition of this Channel.

function fromBase¶

static std::shared_ptr< PointDetectorSettings > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a PointDetectorSettings.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

Updated on 2026-09-23 at 16:50:39 +0200