Inscoper::NBO::CalibrationMap¶

Represents the XML element CalibrationMap. More...

#include <CalibrationMap.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	CalibrationMap()
	~CalibrationMap()
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	setMetricType(const Inscoper::NBO::MatrixTypeEnum_TypePtr & value, bool validate =true) Sets the value of the MetricType attribute.
MatrixTypeEnum_TypePtr	getMetricType() const Returns the value of the MetricType attribute.
void	resetMetricType() Resets the MetricType attribute to an unset state.
bool	hasMetricType() const Checks whether the optional MetricType attribute is present.
void	setIlluminationIntensity(const float & value, bool validate =true) Sets the value of the IlluminationIntensity attribute.
float	getIlluminationIntensity() const Returns the value of the IlluminationIntensity attribute.
void	resetIlluminationIntensity() Resets the IlluminationIntensity attribute to an unset state.
bool	hasIlluminationIntensity() const Checks whether the IlluminationIntensity attribute is present.
void	setNrOfImages(const int & value, bool validate =true) Sets the value of the NrOfImages attribute.
int	getNrOfImages() const Returns the value of the NrOfImages attribute.
void	resetNrOfImages() Resets the NrOfImages attribute to an unset state.
bool	hasNrOfImages() const Checks whether the NrOfImages attribute is present.
void	setRow_List(const std::vector< Inscoper::NBO::rowType_TypePtr > & value, bool validate =true) Sets the list of Row elements.
std::vector< Inscoper::NBO::rowType_TypePtr >	getRow_List() const Returns the list of Row elements.
void	addToRow_List(const Inscoper::NBO::rowType_TypePtr & value, bool validate =true) Adds a new Row element to this object.
void	clearRow_List() Clear the list of Row.
void	setDescription(const Inscoper::NBO::DescriptionPtr & value, bool validate =true) Sets the value of the Description element.
Inscoper::NBO::DescriptionPtr	getDescription() const Returns the value of the Description element.
void	resetDescription() Resets the Description element to an unset state.
bool	hasDescription() const Checks whether the optional Description element is present.
std::shared_ptr< CalibrationMap >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a CalibrationMap.

Detailed Description¶

class Inscoper::NBO::CalibrationMap;

Represents the XML element CalibrationMap.

This element describes a 2D matrix containing values computed as a resulut of the calibration procedure. This matrix is the same size of the experimental Image this calibration refers to.

Public Functions Documentation¶

function CalibrationMap¶

function ~CalibrationMap¶

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

void setMetricType(
    const Inscoper::NBO::MatrixTypeEnum_TypePtr & value,
    bool validate =true
)

Sets the value of the MetricType attribute.

Parameters:

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

This field captures the type of metric that was computed as part of the calibratin procedure in this instance.

function getMetricType¶

MatrixTypeEnum_TypePtr getMetricType() const

Returns the value of the MetricType attribute.

Return: The value of the attribute

This field captures the type of metric that was computed as part of the calibratin procedure in this instance.

function resetMetricType¶

function hasMetricType¶

bool hasMetricType() const

Checks whether the optional MetricType attribute is present.

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

This field captures the type of metric that was computed as part of the calibratin procedure in this instance.

function setIlluminationIntensity¶

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

Sets the value of the IlluminationIntensity attribute.

Parameters:

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

This attribute only applies to matrices of type Variance and Mean. It represents the illumination intensity that was used to acquire the images used to contruct this matrix. The value can range from 0 (i.e. dark image) to any intenisty value experssed either as percentage or as absolute power.

function getIlluminationIntensity¶

float getIlluminationIntensity() const

Returns the value of the IlluminationIntensity attribute.

Return: The value of the attribute

This attribute only applies to matrices of type Variance and Mean. It represents the illumination intensity that was used to acquire the images used to contruct this matrix. The value can range from 0 (i.e. dark image) to any intenisty value experssed either as percentage or as absolute power.

function resetIlluminationIntensity¶

void resetIlluminationIntensity()

Resets the IlluminationIntensity attribute to an unset state.

This attribute only applies to matrices of type Variance and Mean. It represents the illumination intensity that was used to acquire the images used to contruct this matrix. The value can range from 0 (i.e. dark image) to any intenisty value experssed either as percentage or as absolute power.

function hasIlluminationIntensity¶

bool hasIlluminationIntensity() const

Checks whether the IlluminationIntensity attribute is present.

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

This attribute only applies to matrices of type Variance and Mean. It represents the illumination intensity that was used to acquire the images used to contruct this matrix. The value can range from 0 (i.e. dark image) to any intenisty value experssed either as percentage or as absolute power.

function setNrOfImages¶

void setNrOfImages(
    const int & value,
    bool validate =true
)

Sets the value of the NrOfImages attribute.

Parameters:

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

This field represents the number of images that were employed to generate this calibration matrix.

function getNrOfImages¶

int getNrOfImages() const

Returns the value of the NrOfImages attribute.

Return: The value of the attribute

This field represents the number of images that were employed to generate this calibration matrix.

function resetNrOfImages¶

function hasNrOfImages¶

bool hasNrOfImages() const

Checks whether the NrOfImages attribute is present.

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

This field represents the number of images that were employed to generate this calibration matrix.

function setRow_List¶

void setRow_List(
    const std::vector< Inscoper::NBO::rowType_TypePtr > & value,
    bool validate =true
)

Sets the list of Row elements.

Parameters:

value The new list of Row elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getRow_List¶

function addToRow_List¶

void addToRow_List(
    const Inscoper::NBO::rowType_TypePtr & value,
    bool validate =true
)

Adds a new Row element to this object.

Parameters:

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

No description available in the XSD standard.

function clearRow_List¶

function setDescription¶

void setDescription(
    const Inscoper::NBO::DescriptionPtr & value,
    bool validate =true
)

Sets the value of the Description element.

Parameters:

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

No description available in the XSD standard.

function getDescription¶

function resetDescription¶

function hasDescription¶

bool hasDescription() const

Checks whether the optional Description element is present.

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

No description available in the XSD standard.

function fromBase¶

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

Cast a NBOBaseClass to a CalibrationMap.

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:37 +0200