Inscoper::NBO::LightSourceSettings¶

Represents the XML element LightSourceSettings. More...

#include <LightSourceSettings.h>

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

Public Functions¶

	Name
	LightSourceSettings()
	~LightSourceSettings()
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	setID(const Inscoper::NBO::LightSourceID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LightSourceID_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	setIlluminationPowerSettings(const float & value, bool validate =true) Sets the value of the IlluminationPowerSettings attribute.
float	getIlluminationPowerSettings() const Returns the value of the IlluminationPowerSettings attribute.
void	resetIlluminationPowerSettings() Resets the IlluminationPowerSettings attribute to an unset state.
bool	hasIlluminationPowerSettings() const Checks whether the IlluminationPowerSettings attribute is present.
void	setlluminationPowerSettingsUnit(const Inscoper::NBO::UnitsPower_TypePtr & value, bool validate =true) Sets the value of the lluminationPowerSettingsUnit attribute.
UnitsPower_TypePtr	getlluminationPowerSettingsUnit() const Returns the value of the lluminationPowerSettingsUnit attribute.
void	resetlluminationPowerSettingsUnit() Resets the lluminationPowerSettingsUnit attribute to an unset state.
bool	haslluminationPowerSettingsUnit() const Checks whether the optional lluminationPowerSettingsUnit attribute is present.
void	setAttenuation(const Inscoper::NBO::PercentFraction_TypePtr & value, bool validate =true) Sets the value of the Attenuation attribute.
PercentFraction_TypePtr	getAttenuation() const Returns the value of the Attenuation attribute.
void	resetAttenuation() Resets the Attenuation attribute to an unset state.
bool	hasAttenuation() const Checks whether the optional Attenuation attribute is present.
void	setAttenuationMethod(const std::string & value, bool validate =true) Sets the value of the AttenuationMethod attribute.
std::string	getAttenuationMethod() const Returns the value of the AttenuationMethod attribute.
void	resetAttenuationMethod() Resets the AttenuationMethod attribute to an unset state.
bool	hasAttenuationMethod() const Checks whether the AttenuationMethod attribute is present.
void	setUsedAcoustoOpticalDevice(const bool & value, bool validate =true) Sets the value of the UsedAcoustoOpticalDevice attribute.
bool	getUsedAcoustoOpticalDevice() const Returns the value of the UsedAcoustoOpticalDevice attribute.
void	resetUsedAcoustoOpticalDevice() Resets the UsedAcoustoOpticalDevice attribute to an unset state.
bool	hasUsedAcoustoOpticalDevice() const Checks whether the UsedAcoustoOpticalDevice attribute is present.
std::shared_ptr< LightSourceSettings >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a LightSourceSettings.
const std::set< std::string > &	getAttenuationMethodAllowedValues() Returns the allowed values for this attribut.

Additional inherited members¶

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::LightSourceSettings;

Represents the XML element LightSourceSettings.

This element holds the Setting applied to a Light Source used in the Light Path during the acquisition of this Channel as well as a reference to the LightSource (the ID attribute) in question.

Public Functions Documentation¶

function LightSourceSettings¶

function ~LightSourceSettings¶

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 setID¶

void setID(
    const Inscoper::NBO::LightSourceID_TypePtr & value,
    bool validate =true
)

Sets the value of the ID attribute.

Parameters:

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

A Unique Identifier for this component.

function getID¶

function resetID¶

function hasID¶

function setIlluminationPowerSettings¶

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

Sets the value of the IlluminationPowerSettings attribute.

Parameters:

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

This field records the nominal Illumination Power (also known as Power Output or Illumination Intensity) that was set for the Acquisition of this Image or was reported by the Image Acquisition Software, as advertised by the Manufacturer. Depending on the system this might be reported as a % value.

function getIlluminationPowerSettings¶

float getIlluminationPowerSettings() const

Returns the value of the IlluminationPowerSettings attribute.

Return: The value of the attribute

This field records the nominal Illumination Power (also known as Power Output or Illumination Intensity) that was set for the Acquisition of this Image or was reported by the Image Acquisition Software, as advertised by the Manufacturer. Depending on the system this might be reported as a % value.

function resetIlluminationPowerSettings¶

void resetIlluminationPowerSettings()

Resets the IlluminationPowerSettings attribute to an unset state.

This field records the nominal Illumination Power (also known as Power Output or Illumination Intensity) that was set for the Acquisition of this Image or was reported by the Image Acquisition Software, as advertised by the Manufacturer. Depending on the system this might be reported as a % value.

function hasIlluminationPowerSettings¶

bool hasIlluminationPowerSettings() const

Checks whether the IlluminationPowerSettings attribute is present.

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

This field records the nominal Illumination Power (also known as Power Output or Illumination Intensity) that was set for the Acquisition of this Image or was reported by the Image Acquisition Software, as advertised by the Manufacturer. Depending on the system this might be reported as a % value.

function setlluminationPowerSettingsUnit¶

void setlluminationPowerSettingsUnit(
    const Inscoper::NBO::UnitsPower_TypePtr & value,
    bool validate =true
)

Sets the value of the lluminationPowerSettingsUnit 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 getlluminationPowerSettingsUnit¶

UnitsPower_TypePtr getlluminationPowerSettingsUnit() const

Returns the value of the lluminationPowerSettingsUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetlluminationPowerSettingsUnit¶

function haslluminationPowerSettingsUnit¶

bool haslluminationPowerSettingsUnit() const

Checks whether the optional lluminationPowerSettingsUnit attribute is present.

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

No description available in the XSD standard.

function setAttenuation¶

void setAttenuation(
    const Inscoper::NBO::PercentFraction_TypePtr & value,
    bool validate =true
)

Sets the value of the Attenuation attribute.

Parameters:

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

This field records the actual Attenuation of the excitation light power that was applied during the Acquisition of this Channel, expressed as a fractional value from 0.0 to 1.0.

function getAttenuation¶

PercentFraction_TypePtr getAttenuation() const

Returns the value of the Attenuation attribute.

Return: The value of the attribute

This field records the actual Attenuation of the excitation light power that was applied during the Acquisition of this Channel, expressed as a fractional value from 0.0 to 1.0.

function resetAttenuation¶

void resetAttenuation()

Resets the Attenuation attribute to an unset state.

This field records the actual Attenuation of the excitation light power that was applied during the Acquisition of this Channel, expressed as a fractional value from 0.0 to 1.0.

function hasAttenuation¶

bool hasAttenuation() const

Checks whether the optional Attenuation attribute is present.

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

This field records the actual Attenuation of the excitation light power that was applied during the Acquisition of this Channel, expressed as a fractional value from 0.0 to 1.0.

function setAttenuationMethod¶

void setAttenuationMethod(
    const std::string & value,
    bool validate =true
)

Sets the value of the AttenuationMethod attribute.

Parameters:

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

This field records the Method that was used to Attenuate the Laser beam during the acquisition of this Image.

function getAttenuationMethod¶

std::string getAttenuationMethod() const

Returns the value of the AttenuationMethod attribute.

Return: The value of the attribute

This field records the Method that was used to Attenuate the Laser beam during the acquisition of this Image.

function resetAttenuationMethod¶

void resetAttenuationMethod()

Resets the AttenuationMethod attribute to an unset state.

This field records the Method that was used to Attenuate the Laser beam during the acquisition of this Image.

function hasAttenuationMethod¶

bool hasAttenuationMethod() const

Checks whether the AttenuationMethod attribute is present.

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

This field records the Method that was used to Attenuate the Laser beam during the acquisition of this Image.

function setUsedAcoustoOpticalDevice¶

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

Sets the value of the UsedAcoustoOpticalDevice attribute.

Parameters:

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

In case a Laser was used for this Image Acquisition, this field records whether (True) or not (False) an AcoustoOptical Device was employed for intensity modulation.

function getUsedAcoustoOpticalDevice¶

bool getUsedAcoustoOpticalDevice() const

Returns the value of the UsedAcoustoOpticalDevice attribute.

Return: The value of the attribute

In case a Laser was used for this Image Acquisition, this field records whether (True) or not (False) an AcoustoOptical Device was employed for intensity modulation.

function resetUsedAcoustoOpticalDevice¶

void resetUsedAcoustoOpticalDevice()

Resets the UsedAcoustoOpticalDevice attribute to an unset state.

In case a Laser was used for this Image Acquisition, this field records whether (True) or not (False) an AcoustoOptical Device was employed for intensity modulation.

function hasUsedAcoustoOpticalDevice¶

bool hasUsedAcoustoOpticalDevice() const

Checks whether the UsedAcoustoOpticalDevice attribute is present.

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

In case a Laser was used for this Image Acquisition, this field records whether (True) or not (False) an AcoustoOptical Device was employed for intensity modulation.

function fromBase¶

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

Cast a NBOBaseClass to a LightSourceSettings.

Parameters:

base The base class to cast

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

function getAttenuationMethodAllowedValues¶

static const std::set< std::string > & getAttenuationMethodAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

This field records the Method that was used to Attenuate the Laser beam during the acquisition of this Image.

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