soma::Transformation Class Reference

Polymorphic base class for spatial transformations. More...

#include <soma-io/transformation/transformation.h>

Inheritance diagram for soma::Transformation:

Collaboration diagram for soma::Transformation:

Public Member Functions
virtual	~Transformation ()
virtual bool	isIdentity () const
	Test if the transformation can safely be omitted. More...
carto::Object	header ()
const carto::Object	header () const
void	setHeader (carto::Object ph)
Public Member Functions inherited from carto::RCObject
	RCObject ()
	RCObject (const RCObject &)
RCObject &	operator= (const RCObject &)
virtual	~RCObject ()

Protected Member Functions
	Transformation ()

Protected Attributes
carto::Object	_header

Additional Inherited Members
Public Types inherited from carto::RCObject
typedef int	RefCounterType

Detailed Description

Polymorphic base class for spatial transformations.

In Soma-IO 5.1 (2022) the header() has beed added in the base Transformation class, whereas it used to be only in Aims AffineTransformation3d. Now all transformations variants have a header.

Definition at line 57 of file transformation.h.

Constructor & Destructor Documentation

~Transformation()

virtual soma::Transformation::~Transformation ( )

virtual

Transformation()

soma::Transformation::Transformation ( )

protected

Member Function Documentation

header() [1/2]

carto::Object soma::Transformation::header ( )

inline

Definition at line 78 of file transformation.h.

References _header.

header() [2/2]

const carto::Object soma::Transformation::header ( ) const

inline

Definition at line 79 of file transformation.h.

References _header.

isIdentity()

virtual bool soma::Transformation::isIdentity ( ) const

inlinevirtual

Test if the transformation can safely be omitted.

This method returns true only if the transformation behaves exactly like an identity transformation (notably, the transform methods will always return the input coordinates unchanged).

Note

{Implementors of derived classes may choose to always return false if a test would be difficult to implement or expensive to run. As a result, a false result does not guarantee in general that the transformation is different from identity.}

Reimplemented in soma::AffineTransformation3dBase.

Definition at line 73 of file transformation.h.

setHeader()

void soma::Transformation::setHeader

(

carto::Object

ph

)

Member Data Documentation

_header

carto::Object soma::Transformation::_header

protected

Definition at line 83 of file transformation.h.

Referenced by header().

---

The documentation for this class was generated from the following file:

• soma-io/transformation/transformation.h