ImageVector is the 6D TVector specialization used by the ML for all image indexing. More...

#include <mlImageVector.h>

Inheritance diagram for ml::TImageVector< CompIntType >:

Public Types
typedef TVector< TVector6DBase < CompIntType > >	ParentClass
	Parent class of this class.
typedef ParentClass::ComponentType	ComponentType
	Integer type used by this vector.
Public Member Functions
	TImageVector ()
	Constructor. All components are initialized to 0.
	TImageVector (const ParentClass &v)
	Copy constructor from Base class.
	TImageVector (const ComponentType i)
	Constructor which initializes all components to i.
template<typename T2IntType >
	TImageVector (const TImageVector< T2IntType > &v2)
	Copy constructor from another TVector of same or other integer type, values are cast.
	TImageVector (const ComponentType xp, const TImageVector< ComponentType > &p)
	Constructor which assigns X to x and copies other elements from p.
void	set (const ComponentType v=0)
	Set all components to v or - if v is not specified - to 0.
void	set (const ParentClass &v)
	Like assignment operator.
	TImageVector (const MLint num, const ComponentType *const arr, const ComponentType deflt)
	Constructor which initializes the vector components by copying them from arr[0] ,..., arr[num-1].
	TImageVector (const ComponentType xp, const ComponentType yp, const ComponentType zp, const ComponentType cp, const ComponentType tp, const ComponentType up)
	Constructor which initializes all components with the values x, y, z, c, t and u.
	TImageVector (const Vector6 &v6)
	Copy the six double components of v6 into x, ..., u, respectively.
void	set (const ComponentType vx, const ComponentType vy, const ComponentType vz=0, const ComponentType vc=0, const ComponentType vt=0, const ComponentType vu=0)
	Set vector to (vx, vy, vz, vc, vt, vu). Not passed components are set to 0.
void	get (ComponentType const xp=NULL, ComponentType const yp=NULL, ComponentType const zp=NULL, ComponentType const cp=NULL, ComponentType const tp=NULL, ComponentType const up=NULL) const
	Return the subset of those Vector components whose corresponding pointers are not NULL.
bool	iterate (const TImageVector< ComponentType > &ext)
	Coordinate incrementation/iterator function inside ext.
Vector6	toVector6 () const
	Get vector contents as Vector6.
Deprecated
Vector6	getVec6 () const
Static Public Member Functions
Properties of an image of the ML.
static MLint	dim ()
	Returns dimension the ML calculates with.

Detailed Description

template<typename CompIntType = MLint>
class ml::TImageVector< CompIntType >

ImageVector is the 6D TVector specialization used by the ML for all image indexing.

It uses MLint as default for CompIntType and TVector6DBase<CompIntType> as container type for specialized access to array member with x,y,z,c,t, and u.

In contrast to the base class TVector the members are specialized to MLMaxImageDimension dimensions to implement dedicated functionality for ML images. This class can also be instantiated with arguments or other CompIntType arguments to compile with an arbitrary integer base type.

Example for vector initialization:

       ImageVector p;
       p.x=1; p.y=2; p.z=3; p.c=4; p.t=5; p.u=6;
      // or
       ImageVector p;
       p[0]=3; p[1]=5; p[2]=7; p[3]=9; p[4]=11; p[5]=13;
      // or
       ImageVector p;
       p.set(3, 5, 7, 9, 11, 13);
      // or
       ImageVector q(4, p);
      // or
       p = ImageVector(1,2,3,4,5,6);
      // or
       ImageVector p(1,2,3,4,5,6);

Notes:

operator= can safely be used although not implemented explicitly.
This class is used to describe points, coordinates and subimage regions easily, in a uniform manner and independent of the exact number of supported dimensions.
All coordinate components are explicitly public and may used so without limitation of class functionality.
Even method parameters are implemented as "const" to give compilers maximum information to optimize.
In most methods this class is not traced nor ML_TRY/CATCH mechanisms are used, because:
it is heavily used in time critical positions for all image processing aspects in ML modules.
it should be possible to detect/debug errors easily on next higher function which then should be traced/try/caught.

Definition at line 132 of file mlImageVector.h.