Inscoper::NBO::Channel¶

Represents the XML element Channel. More...

#include <Channel.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	Channel()
	~Channel()
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::ChannelID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
ChannelID_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	setName(const Inscoper::NBO::Denomination_TypePtr & value, bool validate =true) Sets the value of the Name attribute.
Denomination_TypePtr	getName() const Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
bool	hasName() const Checks whether the optional Name attribute is present.
void	setIlluminationType(const Inscoper::NBO::ImagingMethodList_TypePtr & value, bool validate =true) Sets the value of the IlluminationType attribute.
ImagingMethodList_TypePtr	getIlluminationType() const Returns the value of the IlluminationType attribute.
void	resetIlluminationType() Resets the IlluminationType attribute to an unset state.
bool	hasIlluminationType() const Checks whether the optional IlluminationType attribute is present.
void	setIlluminationTypeTermAcession(const std::string & value, bool validate =true) Sets the value of the IlluminationTypeTermAcession attribute.
std::string	getIlluminationTypeTermAcession() const Returns the value of the IlluminationTypeTermAcession attribute.
void	resetIlluminationTypeTermAcession() Resets the IlluminationTypeTermAcession attribute to an unset state.
bool	hasIlluminationTypeTermAcession() const Checks whether the IlluminationTypeTermAcession attribute is present.
void	setContrastMethod(const Inscoper::NBO::ChannelContrastMethod_TypePtr & value, bool validate =true) Sets the value of the ContrastMethod attribute.
ChannelContrastMethod_TypePtr	getContrastMethod() const Returns the value of the ContrastMethod attribute.
void	resetContrastMethod() Resets the ContrastMethod attribute to an unset state.
bool	hasContrastMethod() const Checks whether the optional ContrastMethod attribute is present.
void	setColor(const Inscoper::NBO::Color_TypePtr & value, bool validate =true) Sets the value of the Color attribute.
Color_TypePtr	getColor() const Returns the value of the Color attribute.
void	resetColor() Resets the Color attribute to an unset state.
bool	hasColor() const Checks whether the optional Color attribute is present.
void	setSamplesPerPixel(const Inscoper::NBO::PositiveInt_TypePtr & value, bool validate =true) Sets the value of the SamplesPerPixel attribute.
PositiveInt_TypePtr	getSamplesPerPixel() const Returns the value of the SamplesPerPixel attribute.
void	resetSamplesPerPixel() Resets the SamplesPerPixel attribute to an unset state.
bool	hasSamplesPerPixel() const Checks whether the optional SamplesPerPixel attribute is present.
void	setFluorophore_List(const std::vector< Inscoper::NBO::FluorophorePtr > & value, bool validate =true) Sets the list of Fluorophore elements.
std::vector< Inscoper::NBO::FluorophorePtr >	getFluorophore_List() const Returns the list of Fluorophore elements.
void	addToFluorophore_List(const Inscoper::NBO::FluorophorePtr & value, bool validate =true) Adds a new Fluorophore element to this object.
void	clearFluorophore_List() Clear the list of Fluorophore.
void	setLightPath(const Inscoper::NBO::LightPathPtr & value, bool validate =true) Sets the value of the LightPath element.
Inscoper::NBO::LightPathPtr	getLightPath() const Returns the value of the LightPath element.
void	resetLightPath() Resets the LightPath element to an unset state.
bool	hasLightPath() const Checks whether the optional LightPath element is present.
void	setExcitationCalibration_List(const std::vector< Inscoper::NBO::ExcitationCalibrationPtr > & value, bool validate =true) Sets the list of ExcitationCalibration elements.
std::vector< Inscoper::NBO::ExcitationCalibrationPtr >	getExcitationCalibration_List() const Returns the list of ExcitationCalibration elements.
void	addToExcitationCalibration_List(const Inscoper::NBO::ExcitationCalibrationPtr & value, bool validate =true) Adds a new ExcitationCalibration element to this object.
void	clearExcitationCalibration_List() Clear the list of ExcitationCalibration.
void	setAnnotationRef(const Inscoper::NBO::AnnotationRefPtr & value, bool validate =true) Sets the value of the AnnotationRef element.
Inscoper::NBO::AnnotationRefPtr	getAnnotationRef() const Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
bool	hasAnnotationRef() const Checks whether the optional AnnotationRef element is present.
std::shared_ptr< Channel >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a Channel.
const std::set< std::string > &	getIlluminationTypeTermAcessionAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::Channel;

Represents the XML element Channel.

Each Image has to have at least one Plane and one Channel. The Channel element stores information about how the each Image Channel was acquired. The total number of Channel elements for a given Image must equal to SizeC.

Public Functions Documentation¶

function Channel¶

function ~Channel¶

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::ChannelID_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 Channel.

function getID¶

function resetID¶

function hasID¶

function setName¶

void setName(
    const Inscoper::NBO::Denomination_TypePtr & value,
    bool validate =true
)

Sets the value of the Name attribute.

Parameters:

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

A Name for this Channel that is suitable for presentation to the user.

function getName¶

function resetName¶

function hasName¶

bool hasName() const

Checks whether the optional Name attribute is present.

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

A Name for this Channel that is suitable for presentation to the user.

function setIlluminationType¶

void setIlluminationType(
    const Inscoper::NBO::ImagingMethodList_TypePtr & value,
    bool validate =true
)

Sets the value of the IlluminationType attribute.

Parameters:

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

This field describes the Light Microscopy Illumination method performed in this case. Allowable terms were obtained from the Biological Imaging Methods Ontology (Fbbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) Light Microscopy term (http://purl.obolibrary.org/obo/FBbi_00000345).

function getIlluminationType¶

ImagingMethodList_TypePtr getIlluminationType() const

Returns the value of the IlluminationType attribute.

Return: The value of the attribute

This field describes the Light Microscopy Illumination method performed in this case. Allowable terms were obtained from the Biological Imaging Methods Ontology (Fbbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) Light Microscopy term (http://purl.obolibrary.org/obo/FBbi_00000345).

function resetIlluminationType¶

void resetIlluminationType()

Resets the IlluminationType attribute to an unset state.

This field describes the Light Microscopy Illumination method performed in this case. Allowable terms were obtained from the Biological Imaging Methods Ontology (Fbbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) Light Microscopy term (http://purl.obolibrary.org/obo/FBbi_00000345).

function hasIlluminationType¶

bool hasIlluminationType() const

Checks whether the optional IlluminationType attribute is present.

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

This field describes the Light Microscopy Illumination method performed in this case. Allowable terms were obtained from the Biological Imaging Methods Ontology (Fbbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) Light Microscopy term (http://purl.obolibrary.org/obo/FBbi_00000345).

function setIlluminationTypeTermAcession¶

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

Sets the value of the IlluminationTypeTermAcession attribute.

Parameters:

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

This field records the Accession ID for the term used to describe the Illumination Type. A sub-classes of Light Microscopy term (http://purl.obolibrary.org/obo/FBbi_00000345) is recommended.

function getIlluminationTypeTermAcession¶

std::string getIlluminationTypeTermAcession() const

Returns the value of the IlluminationTypeTermAcession attribute.

Return: The value of the attribute

This field records the Accession ID for the term used to describe the Illumination Type. A sub-classes of Light Microscopy term (http://purl.obolibrary.org/obo/FBbi_00000345) is recommended.

function resetIlluminationTypeTermAcession¶

void resetIlluminationTypeTermAcession()

Resets the IlluminationTypeTermAcession attribute to an unset state.

This field records the Accession ID for the term used to describe the Illumination Type. A sub-classes of Light Microscopy term (http://purl.obolibrary.org/obo/FBbi_00000345) is recommended.

function hasIlluminationTypeTermAcession¶

bool hasIlluminationTypeTermAcession() const

Checks whether the IlluminationTypeTermAcession attribute is present.

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

This field records the Accession ID for the term used to describe the Illumination Type. A sub-classes of Light Microscopy term (http://purl.obolibrary.org/obo/FBbi_00000345) is recommended.

function setContrastMethod¶

void setContrastMethod(
    const Inscoper::NBO::ChannelContrastMethod_TypePtr & value,
    bool validate =true
)

Sets the value of the ContrastMethod attribute.

Parameters:

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

This field describes the technique used to achieve contrast for this Channel.

function getContrastMethod¶

ChannelContrastMethod_TypePtr getContrastMethod() const

Returns the value of the ContrastMethod attribute.

Return: The value of the attribute

This field describes the technique used to achieve contrast for this Channel.

function resetContrastMethod¶

function hasContrastMethod¶

bool hasContrastMethod() const

Checks whether the optional ContrastMethod attribute is present.

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

This field describes the technique used to achieve contrast for this Channel.

function setColor¶

void setColor(
    const Inscoper::NBO::Color_TypePtr & value,
    bool validate =true
)

Sets the value of the Color attribute.

Parameters:

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

This field records the Color used to render this Channel - encoded as RGBA. The default value is -1 corresponding #FFFFFFFF, so solid white (it is a signed 32 bit value).

function getColor¶

Color_TypePtr getColor() const

Returns the value of the Color attribute.

Return: The value of the attribute

This field records the Color used to render this Channel - encoded as RGBA. The default value is -1 corresponding #FFFFFFFF, so solid white (it is a signed 32 bit value).

function resetColor¶

void resetColor()

Resets the Color attribute to an unset state.

This field records the Color used to render this Channel - encoded as RGBA. The default value is -1 corresponding #FFFFFFFF, so solid white (it is a signed 32 bit value).

function hasColor¶

bool hasColor() const

Checks whether the optional Color attribute is present.

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

This field records the Color used to render this Channel - encoded as RGBA. The default value is -1 corresponding #FFFFFFFF, so solid white (it is a signed 32 bit value).

function setSamplesPerPixel¶

void setSamplesPerPixel(
    const Inscoper::NBO::PositiveInt_TypePtr & value,
    bool validate =true
)

Sets the value of the SamplesPerPixel attribute.

Parameters:

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

This field is prevalently used for RGB Images and records the number of samples the detector takes to form each pixel value. [units:none]

function getSamplesPerPixel¶

PositiveInt_TypePtr getSamplesPerPixel() const

Returns the value of the SamplesPerPixel attribute.

Return: The value of the attribute

This field is prevalently used for RGB Images and records the number of samples the detector takes to form each pixel value. [units:none]

function resetSamplesPerPixel¶

void resetSamplesPerPixel()

Resets the SamplesPerPixel attribute to an unset state.

This field is prevalently used for RGB Images and records the number of samples the detector takes to form each pixel value. [units:none]

function hasSamplesPerPixel¶

bool hasSamplesPerPixel() const

Checks whether the optional SamplesPerPixel attribute is present.

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

This field is prevalently used for RGB Images and records the number of samples the detector takes to form each pixel value. [units:none]

function setFluorophore_List¶

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

Sets the list of Fluorophore elements.

Parameters:

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

No description available in the XSD standard.

function getFluorophore_List¶

std::vector< Inscoper::NBO::FluorophorePtr > getFluorophore_List() const

Returns the list of Fluorophore elements.

Return: The list of Fluorophore elements

No description available in the XSD standard.

function addToFluorophore_List¶

void addToFluorophore_List(
    const Inscoper::NBO::FluorophorePtr & value,
    bool validate =true
)

Adds a new Fluorophore 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 clearFluorophore_List¶

function setLightPath¶

void setLightPath(
    const Inscoper::NBO::LightPathPtr & value,
    bool validate =true
)

Sets the value of the LightPath 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 getLightPath¶

function resetLightPath¶

function hasLightPath¶

bool hasLightPath() const

Checks whether the optional LightPath element is present.

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

No description available in the XSD standard.

function setExcitationCalibration_List¶

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

Sets the list of ExcitationCalibration elements.

Parameters:

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

No description available in the XSD standard.

function getExcitationCalibration_List¶

std::vector< Inscoper::NBO::ExcitationCalibrationPtr > getExcitationCalibration_List() const

Returns the list of ExcitationCalibration elements.

Return: The list of ExcitationCalibration elements

No description available in the XSD standard.

function addToExcitationCalibration_List¶

void addToExcitationCalibration_List(
    const Inscoper::NBO::ExcitationCalibrationPtr & value,
    bool validate =true
)

Adds a new ExcitationCalibration 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 clearExcitationCalibration_List¶

function setAnnotationRef¶

void setAnnotationRef(
    const Inscoper::NBO::AnnotationRefPtr & value,
    bool validate =true
)

Sets the value of the AnnotationRef element.

Parameters:

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

This is a simple multi-line comment or annotation describing this component.

function getAnnotationRef¶

Inscoper::NBO::AnnotationRefPtr getAnnotationRef() const

Returns the value of the AnnotationRef element.

Return: The value of the element

This is a simple multi-line comment or annotation describing this component.

function resetAnnotationRef¶

function hasAnnotationRef¶

bool hasAnnotationRef() const

Checks whether the optional AnnotationRef element is present.

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

This is a simple multi-line comment or annotation describing this component.

function fromBase¶

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

Cast a NBOBaseClass to a Channel.

Parameters:

base The base class to cast

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

function getIlluminationTypeTermAcessionAllowedValues¶

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

Returns the allowed values for this attribut.

Return: The list of allowed values

This field records the Accession ID for the term used to describe the Illumination Type. A sub-classes of Light Microscopy term (http://purl.obolibrary.org/obo/FBbi_00000345) is recommended.

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