Inscoper::NBO::Pixels¶

Represents the XML element Pixels. More...

#include <Pixels.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	Pixels()
	~Pixels()
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::PixelsID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
PixelsID_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	setDimensionOrder(const Inscoper::NBO::PixelsDimensionOrder_TypePtr & value, bool validate =true) Sets the value of the DimensionOrder attribute.
PixelsDimensionOrder_TypePtr	getDimensionOrder() const Returns the value of the DimensionOrder attribute.
void	resetDimensionOrder() Resets the DimensionOrder attribute to an unset state.
bool	hasDimensionOrder() const Checks whether the optional DimensionOrder attribute is present.
void	setSizeX(const Inscoper::NBO::PositiveInt_TypePtr & value, bool validate =true) Sets the value of the SizeX attribute.
PositiveInt_TypePtr	getSizeX() const Returns the value of the SizeX attribute.
void	resetSizeX() Resets the SizeX attribute to an unset state.
bool	hasSizeX() const Checks whether the optional SizeX attribute is present.
void	setSizeY(const Inscoper::NBO::PositiveInt_TypePtr & value, bool validate =true) Sets the value of the SizeY attribute.
PositiveInt_TypePtr	getSizeY() const Returns the value of the SizeY attribute.
void	resetSizeY() Resets the SizeY attribute to an unset state.
bool	hasSizeY() const Checks whether the optional SizeY attribute is present.
void	setSizeZ(const Inscoper::NBO::PositiveInt_TypePtr & value, bool validate =true) Sets the value of the SizeZ attribute.
PositiveInt_TypePtr	getSizeZ() const Returns the value of the SizeZ attribute.
void	resetSizeZ() Resets the SizeZ attribute to an unset state.
bool	hasSizeZ() const Checks whether the optional SizeZ attribute is present.
void	setSizeC(const Inscoper::NBO::PositiveInt_TypePtr & value, bool validate =true) Sets the value of the SizeC attribute.
PositiveInt_TypePtr	getSizeC() const Returns the value of the SizeC attribute.
void	resetSizeC() Resets the SizeC attribute to an unset state.
bool	hasSizeC() const Checks whether the optional SizeC attribute is present.
void	setSizeT(const Inscoper::NBO::PositiveInt_TypePtr & value, bool validate =true) Sets the value of the SizeT attribute.
PositiveInt_TypePtr	getSizeT() const Returns the value of the SizeT attribute.
void	resetSizeT() Resets the SizeT attribute to an unset state.
bool	hasSizeT() const Checks whether the optional SizeT attribute is present.
void	setPhysicalSizeX(const Inscoper::NBO::PositiveFloat_TypePtr & value, bool validate =true) Sets the value of the PhysicalSizeX attribute.
PositiveFloat_TypePtr	getPhysicalSizeX() const Returns the value of the PhysicalSizeX attribute.
void	resetPhysicalSizeX() Resets the PhysicalSizeX attribute to an unset state.
bool	hasPhysicalSizeX() const Checks whether the optional PhysicalSizeX attribute is present.
void	setPhysicalSizeXUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the PhysicalSizeXUnit attribute.
UnitsLength_TypePtr	getPhysicalSizeXUnit() const Returns the value of the PhysicalSizeXUnit attribute.
void	resetPhysicalSizeXUnit() Resets the PhysicalSizeXUnit attribute to an unset state.
bool	hasPhysicalSizeXUnit() const Checks whether the optional PhysicalSizeXUnit attribute is present.
void	setPhysicalSizeY(const Inscoper::NBO::PositiveFloat_TypePtr & value, bool validate =true) Sets the value of the PhysicalSizeY attribute.
PositiveFloat_TypePtr	getPhysicalSizeY() const Returns the value of the PhysicalSizeY attribute.
void	resetPhysicalSizeY() Resets the PhysicalSizeY attribute to an unset state.
bool	hasPhysicalSizeY() const Checks whether the optional PhysicalSizeY attribute is present.
void	setPhysicalSizeYUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the PhysicalSizeYUnit attribute.
UnitsLength_TypePtr	getPhysicalSizeYUnit() const Returns the value of the PhysicalSizeYUnit attribute.
void	resetPhysicalSizeYUnit() Resets the PhysicalSizeYUnit attribute to an unset state.
bool	hasPhysicalSizeYUnit() const Checks whether the optional PhysicalSizeYUnit attribute is present.
void	setPhysicalSizeZ(const Inscoper::NBO::PositiveFloat_TypePtr & value, bool validate =true) Sets the value of the PhysicalSizeZ attribute.
PositiveFloat_TypePtr	getPhysicalSizeZ() const Returns the value of the PhysicalSizeZ attribute.
void	resetPhysicalSizeZ() Resets the PhysicalSizeZ attribute to an unset state.
bool	hasPhysicalSizeZ() const Checks whether the optional PhysicalSizeZ attribute is present.
void	setPhysicalSizeZUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the PhysicalSizeZUnit attribute.
UnitsLength_TypePtr	getPhysicalSizeZUnit() const Returns the value of the PhysicalSizeZUnit attribute.
void	resetPhysicalSizeZUnit() Resets the PhysicalSizeZUnit attribute to an unset state.
bool	hasPhysicalSizeZUnit() const Checks whether the optional PhysicalSizeZUnit attribute is present.
void	setTimeIncrement(const Inscoper::NBO::PositiveFloat_TypePtr & value, bool validate =true) Sets the value of the TimeIncrement attribute.
PositiveFloat_TypePtr	getTimeIncrement() const Returns the value of the TimeIncrement attribute.
void	resetTimeIncrement() Resets the TimeIncrement attribute to an unset state.
bool	hasTimeIncrement() const Checks whether the optional TimeIncrement attribute is present.
void	setTimeIncrementUnit(const Inscoper::NBO::UnitsTime_TypePtr & value, bool validate =true) Sets the value of the TimeIncrementUnit attribute.
UnitsTime_TypePtr	getTimeIncrementUnit() const Returns the value of the TimeIncrementUnit attribute.
void	resetTimeIncrementUnit() Resets the TimeIncrementUnit attribute to an unset state.
bool	hasTimeIncrementUnit() const Checks whether the optional TimeIncrementUnit attribute is present.
void	setPixelType(const Inscoper::NBO::PixelType_TypePtr & value, bool validate =true) Sets the value of the PixelType attribute.
PixelType_TypePtr	getPixelType() const Returns the value of the PixelType attribute.
void	resetPixelType() Resets the PixelType attribute to an unset state.
bool	hasPixelType() const Checks whether the optional PixelType attribute is present.
void	setInterleaved(const bool & value, bool validate =true) Sets the value of the Interleaved attribute.
bool	getInterleaved() const Returns the value of the Interleaved attribute.
void	resetInterleaved() Resets the Interleaved attribute to an unset state.
bool	hasInterleaved() const Checks whether the Interleaved attribute is present.
void	setSignificantBits(const Inscoper::NBO::PositiveInt_TypePtr & value, bool validate =true) Sets the value of the SignificantBits attribute.
PositiveInt_TypePtr	getSignificantBits() const Returns the value of the SignificantBits attribute.
void	resetSignificantBits() Resets the SignificantBits attribute to an unset state.
bool	hasSignificantBits() const Checks whether the optional SignificantBits attribute is present.
void	setBigEndian(const bool & value, bool validate =true) Sets the value of the BigEndian attribute.
bool	getBigEndian() const Returns the value of the BigEndian attribute.
void	resetBigEndian() Resets the BigEndian attribute to an unset state.
bool	hasBigEndian() const Checks whether the BigEndian attribute is present.
void	setPlane_List(const std::vector< Inscoper::NBO::PlanePtr > & value, bool validate =true) Sets the list of Plane elements.
std::vector< Inscoper::NBO::PlanePtr >	getPlane_List() const Returns the list of Plane elements.
void	addToPlane_List(const Inscoper::NBO::PlanePtr & value, bool validate =true) Adds a new Plane element to this object.
void	clearPlane_List() Clear the list of Plane.
void	setChannel_List(const std::vector< Inscoper::NBO::ChannelPtr > & value, bool validate =true) Sets the list of Channel elements.
std::vector< Inscoper::NBO::ChannelPtr >	getChannel_List() const Returns the list of Channel elements.
void	addToChannel_List(const Inscoper::NBO::ChannelPtr & value, bool validate =true) Adds a new Channel element to this object.
void	clearChannel_List() Clear the list of Channel.
void	setAdditionalDimensionMap(const Inscoper::NBO::AdditionalDimensionMapPtr & value, bool validate =true) Sets the value of the AdditionalDimensionMap element.
Inscoper::NBO::AdditionalDimensionMapPtr	getAdditionalDimensionMap() const Returns the value of the AdditionalDimensionMap element.
void	resetAdditionalDimensionMap() Resets the AdditionalDimensionMap element to an unset state.
bool	hasAdditionalDimensionMap() const Checks whether the optional AdditionalDimensionMap element is present.
void	setpixels_choice(const Inscoper::NBO::Pixels_ChoicePtr & value, bool validate =true) Sets the value of the pixels_choice element.
Inscoper::NBO::Pixels_ChoicePtr	getpixels_choice() const Returns the value of the pixels_choice element.
void	resetpixels_choice() Resets the pixels_choice element to an unset state.
bool	haspixels_choice() const Checks whether the optional pixels_choice element is present.
std::shared_ptr< Pixels >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a Pixels.

Detailed Description¶

class Inscoper::NBO::Pixels;

Represents the XML element Pixels.

The Pixels element is going to be removed in the future, but it is still required. This is just notice that the contents of Pixels will be moved up to Image in a future release. This is because there has only been 1 Pixels object in each Image for some time. The concept of multiple Pixels sets for one Image failed to take off. It is therefore redundant. The Image will be unreadable if any of the required Pixel attributes are missing. The Pixels themselves can be stored within the OME-XML compressed by Plane, and encoded in Base64. Or the Pixels may be stored in TIFF format. The Pixels element should contain a list of BinData or TiffData, each containing a single Plane of pixels. These Pixels elements, when read in document order, must produce a 5-D Pixel array of the size specified in this element, and in the dimension order specified by 'DimensionOrder'. All of the values in the Pixels object when present should match the same value stored in any associated TIFF format (e.g. SizeX should be the same). Where there is a mismatch our readers will take the value from the TIFF structure as overriding the value in the OME-XML. This is simply a pragmatic decision as it increases the likelihood of reading data from a slightly incorrect file.

Public Functions Documentation¶

function Pixels¶

function ~Pixels¶

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::PixelsID_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 setDimensionOrder¶

void setDimensionOrder(
    const Inscoper::NBO::PixelsDimensionOrder_TypePtr & value,
    bool validate =true
)

Sets the value of the DimensionOrder attribute.

Parameters:

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

This field records the order in which the individual Planes of data are interleaved in the Image.

function getDimensionOrder¶

PixelsDimensionOrder_TypePtr getDimensionOrder() const

Returns the value of the DimensionOrder attribute.

Return: The value of the attribute

This field records the order in which the individual Planes of data are interleaved in the Image.

function resetDimensionOrder¶

function hasDimensionOrder¶

bool hasDimensionOrder() const

Checks whether the optional DimensionOrder attribute is present.

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

This field records the order in which the individual Planes of data are interleaved in the Image.

function setSizeX¶

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

Sets the value of the SizeX attribute.

Parameters:

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

This field records the X size of the Pixel data array.

function getSizeX¶

function resetSizeX¶

function hasSizeX¶

bool hasSizeX() const

Checks whether the optional SizeX attribute is present.

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

This field records the X size of the Pixel data array.

function setSizeY¶

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

Sets the value of the SizeY attribute.

Parameters:

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

This field records the Y size of the Pixel data array.

function getSizeY¶

function resetSizeY¶

function hasSizeY¶

bool hasSizeY() const

Checks whether the optional SizeY attribute is present.

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

This field records the Y size of the Pixel data array.

function setSizeZ¶

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

Sets the value of the SizeZ attribute.

Parameters:

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

This field records the number of Z-Planes acquired for this Image.

function getSizeZ¶

function resetSizeZ¶

function hasSizeZ¶

bool hasSizeZ() const

Checks whether the optional SizeZ attribute is present.

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

This field records the number of Z-Planes acquired for this Image.

function setSizeC¶

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

Sets the value of the SizeC attribute.

Parameters:

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

This field records the number of Channels used in this Image

function getSizeC¶

function resetSizeC¶

function hasSizeC¶

bool hasSizeC() const

Checks whether the optional SizeC attribute is present.

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

This field records the number of Channels used in this Image

function setSizeT¶

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

Sets the value of the SizeT attribute.

Parameters:

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

This field records the number of Timepoints (often referred to as Frames) used in this Image.

function getSizeT¶

PositiveInt_TypePtr getSizeT() const

Returns the value of the SizeT attribute.

Return: The value of the attribute

This field records the number of Timepoints (often referred to as Frames) used in this Image.

function resetSizeT¶

function hasSizeT¶

bool hasSizeT() const

Checks whether the optional SizeT attribute is present.

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

This field records the number of Timepoints (often referred to as Frames) used in this Image.

function setPhysicalSizeX¶

void setPhysicalSizeX(
    const Inscoper::NBO::PositiveFloat_TypePtr & value,
    bool validate =true
)

Sets the value of the PhysicalSizeX attribute.

Parameters:

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

This field records the real world Physical Width represented by a Pixel in this Image. This measure is often referred to as X Pixel Size.

function getPhysicalSizeX¶

PositiveFloat_TypePtr getPhysicalSizeX() const

Returns the value of the PhysicalSizeX attribute.

Return: The value of the attribute

This field records the real world Physical Width represented by a Pixel in this Image. This measure is often referred to as X Pixel Size.

function resetPhysicalSizeX¶

void resetPhysicalSizeX()

Resets the PhysicalSizeX attribute to an unset state.

This field records the real world Physical Width represented by a Pixel in this Image. This measure is often referred to as X Pixel Size.

function hasPhysicalSizeX¶

bool hasPhysicalSizeX() const

Checks whether the optional PhysicalSizeX attribute is present.

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

This field records the real world Physical Width represented by a Pixel in this Image. This measure is often referred to as X Pixel Size.

function setPhysicalSizeXUnit¶

void setPhysicalSizeXUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the PhysicalSizeXUnit 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 getPhysicalSizeXUnit¶

function resetPhysicalSizeXUnit¶

function hasPhysicalSizeXUnit¶

bool hasPhysicalSizeXUnit() const

Checks whether the optional PhysicalSizeXUnit attribute is present.

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

No description available in the XSD standard.

function setPhysicalSizeY¶

void setPhysicalSizeY(
    const Inscoper::NBO::PositiveFloat_TypePtr & value,
    bool validate =true
)

Sets the value of the PhysicalSizeY attribute.

Parameters:

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

This field records the real world Physical Height represented by a Pixel in this Image. This measure is often referred to as Y Pixel Size.

function getPhysicalSizeY¶

PositiveFloat_TypePtr getPhysicalSizeY() const

Returns the value of the PhysicalSizeY attribute.

Return: The value of the attribute

This field records the real world Physical Height represented by a Pixel in this Image. This measure is often referred to as Y Pixel Size.

function resetPhysicalSizeY¶

void resetPhysicalSizeY()

Resets the PhysicalSizeY attribute to an unset state.

This field records the real world Physical Height represented by a Pixel in this Image. This measure is often referred to as Y Pixel Size.

function hasPhysicalSizeY¶

bool hasPhysicalSizeY() const

Checks whether the optional PhysicalSizeY attribute is present.

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

This field records the real world Physical Height represented by a Pixel in this Image. This measure is often referred to as Y Pixel Size.

function setPhysicalSizeYUnit¶

void setPhysicalSizeYUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the PhysicalSizeYUnit 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 getPhysicalSizeYUnit¶

function resetPhysicalSizeYUnit¶

function hasPhysicalSizeYUnit¶

bool hasPhysicalSizeYUnit() const

Checks whether the optional PhysicalSizeYUnit attribute is present.

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

No description available in the XSD standard.

function setPhysicalSizeZ¶

void setPhysicalSizeZ(
    const Inscoper::NBO::PositiveFloat_TypePtr & value,
    bool validate =true
)

Sets the value of the PhysicalSizeZ attribute.

Parameters:

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

This field records the real world Physical distance between the individual Z-Planes recorded for this Image. This measure is sometimes referred to as Z Pixel or Voxel Size.

function getPhysicalSizeZ¶

PositiveFloat_TypePtr getPhysicalSizeZ() const

Returns the value of the PhysicalSizeZ attribute.

Return: The value of the attribute

This field records the real world Physical distance between the individual Z-Planes recorded for this Image. This measure is sometimes referred to as Z Pixel or Voxel Size.

function resetPhysicalSizeZ¶

void resetPhysicalSizeZ()

Resets the PhysicalSizeZ attribute to an unset state.

This field records the real world Physical distance between the individual Z-Planes recorded for this Image. This measure is sometimes referred to as Z Pixel or Voxel Size.

function hasPhysicalSizeZ¶

bool hasPhysicalSizeZ() const

Checks whether the optional PhysicalSizeZ attribute is present.

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

This field records the real world Physical distance between the individual Z-Planes recorded for this Image. This measure is sometimes referred to as Z Pixel or Voxel Size.

function setPhysicalSizeZUnit¶

void setPhysicalSizeZUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the PhysicalSizeZUnit 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 getPhysicalSizeZUnit¶

function resetPhysicalSizeZUnit¶

function hasPhysicalSizeZUnit¶

bool hasPhysicalSizeZUnit() const

Checks whether the optional PhysicalSizeZUnit attribute is present.

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

No description available in the XSD standard.

function setTimeIncrement¶

void setTimeIncrement(
    const Inscoper::NBO::PositiveFloat_TypePtr & value,
    bool validate =true
)

Sets the value of the TimeIncrement attribute.

Parameters:

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

In cases in which a time series is acquired with a global timing specification setting, this field describes the time between each sequential plane (or frame) in the series (i.e., from the start of time point 1 to the start of time point 2). Examples include, a video stream or a multi-dimensional Acquisition routine. Note that, this field is not intended to substitute the Timestamp attribute recorded in Plane. Also note that in case this field is not relevant e.g. a time lapse Acquisition with irregular increments, the value -1 should be used to indicate that only the Timestamps (in the Plane element) are valid.

function getTimeIncrement¶

PositiveFloat_TypePtr getTimeIncrement() const

Returns the value of the TimeIncrement attribute.

Return: The value of the attribute

In cases in which a time series is acquired with a global timing specification setting, this field describes the time between each sequential plane (or frame) in the series (i.e., from the start of time point 1 to the start of time point 2). Examples include, a video stream or a multi-dimensional Acquisition routine. Note that, this field is not intended to substitute the Timestamp attribute recorded in Plane. Also note that in case this field is not relevant e.g. a time lapse Acquisition with irregular increments, the value -1 should be used to indicate that only the Timestamps (in the Plane element) are valid.

function resetTimeIncrement¶

void resetTimeIncrement()

Resets the TimeIncrement attribute to an unset state.

In cases in which a time series is acquired with a global timing specification setting, this field describes the time between each sequential plane (or frame) in the series (i.e., from the start of time point 1 to the start of time point 2). Examples include, a video stream or a multi-dimensional Acquisition routine. Note that, this field is not intended to substitute the Timestamp attribute recorded in Plane. Also note that in case this field is not relevant e.g. a time lapse Acquisition with irregular increments, the value -1 should be used to indicate that only the Timestamps (in the Plane element) are valid.

function hasTimeIncrement¶

bool hasTimeIncrement() const

Checks whether the optional TimeIncrement attribute is present.

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

In cases in which a time series is acquired with a global timing specification setting, this field describes the time between each sequential plane (or frame) in the series (i.e., from the start of time point 1 to the start of time point 2). Examples include, a video stream or a multi-dimensional Acquisition routine. Note that, this field is not intended to substitute the Timestamp attribute recorded in Plane. Also note that in case this field is not relevant e.g. a time lapse Acquisition with irregular increments, the value -1 should be used to indicate that only the Timestamps (in the Plane element) are valid.

function setTimeIncrementUnit¶

void setTimeIncrementUnit(
    const Inscoper::NBO::UnitsTime_TypePtr & value,
    bool validate =true
)

Sets the value of the TimeIncrementUnit 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 getTimeIncrementUnit¶

function resetTimeIncrementUnit¶

function hasTimeIncrementUnit¶

bool hasTimeIncrementUnit() const

Checks whether the optional TimeIncrementUnit attribute is present.

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

No description available in the XSD standard.

function setPixelType¶

void setPixelType(
    const Inscoper::NBO::PixelType_TypePtr & value,
    bool validate =true
)

Sets the value of the PixelType attribute.

Parameters:

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

This field records the data type used to represent the Pixel Intensity in the Image.

function getPixelType¶

PixelType_TypePtr getPixelType() const

Returns the value of the PixelType attribute.

Return: The value of the attribute

This field records the data type used to represent the Pixel Intensity in the Image.

function resetPixelType¶

function hasPixelType¶

bool hasPixelType() const

Checks whether the optional PixelType attribute is present.

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

This field records the data type used to represent the Pixel Intensity in the Image.

function setInterleaved¶

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

Sets the value of the Interleaved attribute.

Parameters:

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

This field records the order in which the Channels are arranged within the data block: True if Channels are stored RGBRGBRGB...; False if Channels are stored RRR...GGG...BBB…

function getInterleaved¶

bool getInterleaved() const

Returns the value of the Interleaved attribute.

Return: The value of the attribute

This field records the order in which the Channels are arranged within the data block: True if Channels are stored RGBRGBRGB...; False if Channels are stored RRR...GGG...BBB…

function resetInterleaved¶

void resetInterleaved()

Resets the Interleaved attribute to an unset state.

This field records the order in which the Channels are arranged within the data block: True if Channels are stored RGBRGBRGB...; False if Channels are stored RRR...GGG...BBB…

function hasInterleaved¶

bool hasInterleaved() const

Checks whether the Interleaved attribute is present.

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

This field records the order in which the Channels are arranged within the data block: True if Channels are stored RGBRGBRGB...; False if Channels are stored RRR...GGG...BBB…

function setSignificantBits¶

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

Sets the value of the SignificantBits attribute.

Parameters:

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

This field records the number of bits within the type storing each Pixel value that are significant. e.g.,. you can store 12-bit data within a 16-bit type. This does not reduce the storage requirements but can be a useful indicator when processing or viewing the Image data.

function getSignificantBits¶

PositiveInt_TypePtr getSignificantBits() const

Returns the value of the SignificantBits attribute.

Return: The value of the attribute

This field records the number of bits within the type storing each Pixel value that are significant. e.g.,. you can store 12-bit data within a 16-bit type. This does not reduce the storage requirements but can be a useful indicator when processing or viewing the Image data.

function resetSignificantBits¶

void resetSignificantBits()

Resets the SignificantBits attribute to an unset state.

This field records the number of bits within the type storing each Pixel value that are significant. e.g.,. you can store 12-bit data within a 16-bit type. This does not reduce the storage requirements but can be a useful indicator when processing or viewing the Image data.

function hasSignificantBits¶

bool hasSignificantBits() const

Checks whether the optional SignificantBits attribute is present.

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

This field records the number of bits within the type storing each Pixel value that are significant. e.g.,. you can store 12-bit data within a 16-bit type. This does not reduce the storage requirements but can be a useful indicator when processing or viewing the Image data.

function setBigEndian¶

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

Sets the value of the BigEndian attribute.

Parameters:

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

This field is True if the pixels data was written in BigEndian order. If this value is present, it should match the value used in BinData or TiffData. If it is not, a reader should be used that honors the value used in the BinData or TiffData. This value is useful for MetadataOnly files and is to allow for future storage solutions.

function getBigEndian¶

bool getBigEndian() const

Returns the value of the BigEndian attribute.

Return: The value of the attribute

This field is True if the pixels data was written in BigEndian order. If this value is present, it should match the value used in BinData or TiffData. If it is not, a reader should be used that honors the value used in the BinData or TiffData. This value is useful for MetadataOnly files and is to allow for future storage solutions.

function resetBigEndian¶

void resetBigEndian()

Resets the BigEndian attribute to an unset state.

This field is True if the pixels data was written in BigEndian order. If this value is present, it should match the value used in BinData or TiffData. If it is not, a reader should be used that honors the value used in the BinData or TiffData. This value is useful for MetadataOnly files and is to allow for future storage solutions.

function hasBigEndian¶

bool hasBigEndian() const

Checks whether the BigEndian attribute is present.

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

This field is True if the pixels data was written in BigEndian order. If this value is present, it should match the value used in BinData or TiffData. If it is not, a reader should be used that honors the value used in the BinData or TiffData. This value is useful for MetadataOnly files and is to allow for future storage solutions.

function setPlane_List¶

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

Sets the list of Plane elements.

Parameters:

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

No description available in the XSD standard.

function getPlane_List¶

function addToPlane_List¶

void addToPlane_List(
    const Inscoper::NBO::PlanePtr & value,
    bool validate =true
)

Adds a new Plane 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 clearPlane_List¶

function setChannel_List¶

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

Sets the list of Channel elements.

Parameters:

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

No description available in the XSD standard.

function getChannel_List¶

function addToChannel_List¶

void addToChannel_List(
    const Inscoper::NBO::ChannelPtr & value,
    bool validate =true
)

Adds a new Channel 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 clearChannel_List¶

function setAdditionalDimensionMap¶

void setAdditionalDimensionMap(
    const Inscoper::NBO::AdditionalDimensionMapPtr & value,
    bool validate =true
)

Sets the value of the AdditionalDimensionMap 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 getAdditionalDimensionMap¶

Inscoper::NBO::AdditionalDimensionMapPtr getAdditionalDimensionMap() const

Returns the value of the AdditionalDimensionMap element.

Return: The value of the element

No description available in the XSD standard.

function resetAdditionalDimensionMap¶

function hasAdditionalDimensionMap¶

bool hasAdditionalDimensionMap() const

Checks whether the optional AdditionalDimensionMap element is present.

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

No description available in the XSD standard.

function setpixels_choice¶

void setpixels_choice(
    const Inscoper::NBO::Pixels_ChoicePtr & value,
    bool validate =true
)

Sets the value of the pixels_choice 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 getpixels_choice¶

function resetpixels_choice¶

function haspixels_choice¶

bool haspixels_choice() const

Checks whether the optional pixels_choice 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< Pixels > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a Pixels.

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