Inscoper::NBO::PlaneTransformationMatrix¶

Represents the XML element PlaneTransformationMatrix. More...

#include <PlaneTransformationMatrix.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	PlaneTransformationMatrix()
	~PlaneTransformationMatrix()
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::LSID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LSID_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	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.
std::shared_ptr< PlaneTransformationMatrix >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a PlaneTransformationMatrix.

Detailed Description¶

class Inscoper::NBO::PlaneTransformationMatrix;

Represents the XML element PlaneTransformationMatrix.

This element describes a 4x4 matrix relating the position of this Plane typically with respect to other Planes within this Image or collection of Images (or alternatively to the Microscope's reference frame). This can correct for translations, rotations, scale differences, or other affine distortions between Planes from the same set or between Image Datasets. An example is when multiple cameras are used for e.g. to acquire different Channels for the same Image. See: https://www.openmicroscopy.org/community/viewtopic.php?p=17433.

Public Functions Documentation¶

function PlaneTransformationMatrix¶

function ~PlaneTransformationMatrix¶

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::LSID_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 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 fromBase¶

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

Cast a NBOBaseClass to a PlaneTransformationMatrix.

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