ML integer image vector class to be specialized for different purposes. More...

#include <mlIntegerVector.h>

Inheritance diagram for ml::TVector< TVectorBase >:

Public Types
enum	{ NumberOfDimensions = ParentClass::NumberOfDimensions }
	Enumerator defining the dimension of this class. More...

typedef TVectorBase::ComponentType	ComponentType
	Integer type used by this vector.

typedef TVectorBase	ParentClass
	Parent class of this class.

Public Member Functions
std::string	print (const std::string &openStr="", const std::string &sepStr=" ", const std::string &termStr="", const MLint16 numDigits=-1) const
	Returns the string openStr + v.array[0] + sepStr + ... + v.array[NumberOfDimensions-2] + sepStr + v.array[NumberOfDimensions-1] + termStr.

Initialization
	TVector ()
	Constructor. All components are initialized to 0.

	TVector (const ComponentType i)
	Constructor which initializes all components to i.

	TVector (const TVector< TVectorBase > &v2)

TVector< TVectorBase > &	operator= (const TVector< TVectorBase > &v2)

template<typename TVectorBase2 >
	TVector (const TVector< TVectorBase2 > &v2)
	Copy constructor from another TVector of same or other integer type, values are cast.

	TVector (const ComponentType xp, const TVector &p)
	Constructor which assigns X to x and copies other elements from p.

	TVector (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].

void	copy (const MLint num, ComponentType *const arr) const
	Copy the first num elements from internal array into arr starting with array[0] to arr[0] to array[num-1] to arr[num-1], respectively.

void	set (const ComponentType v=0)
	Sets all components to v or - if v is not specified - to 0.

void	set (const TVector &v)
	Like assignment operator.

Functions and operators.
TVector< TVectorBase >	operator+ (const TVector &b) const
	Add the corresponding component from b to each component.

TVector< TVectorBase > &	operator+= (const TVector< TVectorBase > &b)
	Adds the corresponding component from b to each component.

TVector< TVectorBase >	operator- (const TVector< TVectorBase > &b) const
	Calculates and returns *this-b.

TVector< TVectorBase > &	operator-= (const TVector< TVectorBase > &b)
	Subtracts the corresponding component from b from each component.

TVector< TVectorBase >	operator* (const TVector< TVectorBase > &b) const
	Calculates and returns the multiplication of each component of this with its corresponding component from b.

TVector< TVectorBase > &	operator*= (const TVector< TVectorBase > &b)
	Multiplies each component with its corresponding components from b.

TVector< TVectorBase >	operator+ (const ComponentType b) const
	Calculates and returns the addition of each component of *this with scalar b.

TVector< TVectorBase >	operator- (const ComponentType b) const
	Subtracts the scalar b from all components.

TVector< TVectorBase >	operator* (const ComponentType b) const
	Multiplies all components with scalar b.

TVector< TVectorBase >	operator/ (const TVector< TVectorBase > &b) const
	Calculates and returns the division of each component of *this by its corresponding component from b.

TVector< TVectorBase > &	operator/= (const TVector< TVectorBase > &b)
	Divides each component by its corresponding component from b.

bool	operator== (const TVector< TVectorBase > &b) const
	Equality operator: Returns whether each component of a is equal to its corresponding component of b.

bool	operator!= (const TVector< TVectorBase > &b) const
	Inequality operator: Returns whether any component differs from its corresponding component of b.

bool	operator< (const TVector< TVectorBase > &b) const
	"Smaller" comparison operator, return whether the 'smaller' relation is valid for all components.

bool	operator<= (const TVector< TVectorBase > &b) const
	"Smaller Or Equal" comparison operator, return whether the 'smaller or equal' relation is valid for all components.

bool	operator> (const TVector< TVectorBase > &b) const
	"Greater" comparison operator, return whether the 'greater' relation is valid for all components.

bool	operator>= (const TVector< TVectorBase > &b) const
	"Greater or Equal" comparison operator, return whether the 'greater or equal' relation is valid for all components.

TVector< TVectorBase >	operator& (const TVector< TVectorBase > &b) const
	Performs a binary "And" of all components with the corresponding components of another Vector.

TVector< TVectorBase >	operator\| (const TVector< TVectorBase > &b) const
	Performs a binary "Or" of all components with the corresponding components of another Vector.

TVector< TVectorBase >	operator^ (const TVector< TVectorBase > &b) const
	Performs a binary "Xor" of all components with the corresponding components of another Vector.

TVector< TVectorBase > &	operator&= (const TVector< TVectorBase > &b)
	Performs a binary "And" of all components with the corresponding components of another Vector.

TVector< TVectorBase > &	operator\|= (const TVector< TVectorBase > &b)
	Performs a binary "Or" of all components with the corresponding components of another Vector.

TVector< TVectorBase > &	operator^= (const TVector< TVectorBase > &b)
	Performs a binary "Xor" of all components with the corresponding components of another Vector.

TVector< TVectorBase >	operator& (const ComponentType b) const
	Performs a binary "And" of all components with an integer.

TVector< TVectorBase >	operator\| (const ComponentType b) const
	Performs a binary "Or" of all components with an integer.

TVector< TVectorBase >	operator^ (const ComponentType b) const
	Performs a binary "Xor" of all components with an integer.

TVector< TVectorBase > &	operator&= (const ComponentType b)
	Performs a binary "And" of all components with an integer.

TVector< TVectorBase > &	operator\|= (const ComponentType b)
	Performs a binary "Or" of all components with an integer.

TVector< TVectorBase > &	operator^= (const ComponentType b)
	Performs a binary "Xor" of all components with an integer.

TVector< TVectorBase >	operator>> (const int b) const
	Performs a binary right shift ">>" on each vector component.

TVector< TVectorBase >	operator<< (const int b) const
	Performs a binary left shift "<<" on each vector component.

TVector< TVectorBase > &	operator>>= (const int b)
	Performs a binary right shift unary ">>=" on each vector component.

TVector< TVectorBase > &	operator<<= (const int b)
	Performs a binary left shift unary "<<=" on each vector component.

TVector< TVectorBase >	operator- () const
	Performs an unary "-" on each vector component.

ComponentType	operator[] (const size_t i) const
	Constant indexing operator permits read access to array[0], ..., array[NumberOfDimensions-1] via indexes 0,1, ..., NumberOfDimensions-1, respectively.

ComponentType &	operator[] (const size_t i)
	Indexing operator permits read and write access to array[0], ..., array[NumberOfDimensions-1] via indexes 0,1, ..., NumberOfDimensions-1, respectively.

MLint	getMaxIdx () const
	Searches the maximum component and returns the index of its first occurrence.

ComponentType	getMax () const
	Returns the maximum component value.

MLint	getMinIdx () const
	Searches the minimum component and returns the index of its first occurrence.

ComponentType	getMin () const
	Returns the minimum component value.

TVector< TVectorBase >	getStrides (const ComponentType offset=1) const
	Interprets the vector as image extension and returns a stride vector.

TVector< TVectorBase >	getVectorPosition (ComponentType offsetPos) const
	Interprets the vector as a stride vector of an image and returns the offset position offsetPos from the image origin to the coordinate specified by the vector.

MLint	getExtDimension () const
	Returns the index to the highest vector component which is not 1 which is useful to get the real dimensional extent of an image.

bool	hasNegativeComp () const
	Returns whether any component is negative.

bool	allBiggerZero () const
	Returns whether all components > 0.

bool	sanityCheckNumberOfVoxels () const
	Returns whether product of all components is in range of integer type.

Arithmetics as static and member functions
TVector< TVectorBase >	divCeil (const TVector< TVectorBase > &b) const
	Returns the component wise division of the vector this by vector b with rounding up.

TVector< TVectorBase >	compMin (const TVector< TVectorBase > &b) const
	Returns the component wise minimum of components of this and b.

TVector< TVectorBase >	compMax (const TVector< TVectorBase > &b) const
	Returns the component wise maximum of components of this and b.

TVector< TVectorBase >	compMod (const TVector< TVectorBase > &b) const
	Returns the rest of the division of this by b component wise.

TVector< TVectorBase >	compAbs () const
	Returns a vector with all components of this replaced by their absolute values.

ComponentType	compMul () const
	Returns the product of all components. There is no check for integer overflow.

ComponentType	compSum () const
	Returns the sum of all components. There is no check for integer overflow.

ComponentType	dot (const TVector< TVectorBase > &b) const
	Returns the scalar product of vectors this and b. There is no check for integer overflow.

void	fillSmallerComps (const ComponentType threshold=0, const ComponentType fillVal=0)
	Sets the components which are smaller than threshold to fillVal.

void	fillGreaterComps (const ComponentType threshold=0, const ComponentType fillVal=0)
	Sets the components which are greater than threshold to fillVal.

void	fillEqualComps (const ComponentType threshold=0, const ComponentType fillVal=0)
	Sets the components which are equal to threshold to fillVal.

static TVector< TVectorBase >	divCeil (const TVector< TVectorBase > &a, const TVector< TVectorBase > &b)
	Static version: Returns the component wise division of the vector a by vector b with rounding up.

static TVector< TVectorBase >	compMin (const TVector< TVectorBase > &a, const TVector< TVectorBase > &b)
	Static version: Returns the component wise minimum of vectors a and b.

static TVector< TVectorBase >	compMax (const TVector< TVectorBase > &a, const TVector< TVectorBase > &b)
	Static version: Returns the component wise maximum of vectors a and b.

static TVector< TVectorBase >	compMod (const TVector< TVectorBase > &a, const TVector< TVectorBase > &b)
	Static version: Returns the rest dividing vector a by b component wise.

static TVector< TVectorBase >	compAbs (const TVector< TVectorBase > &a)
	Static version: Returns a vector with all components of a replaced by their absolute values.

static ComponentType	compMul (const TVector< TVectorBase > &a)
	Static version: Returns the product of all components without check for integer overflow.

static ComponentType	compSum (const TVector< TVectorBase > &a)
	Static version: Returns the sum of all components without check for integer overflow.

static ComponentType	dot (const TVector< TVectorBase > &a, const TVector< TVectorBase > &b)
	Static version: Returns the scalar product of vectors a and b without check for integer overflow.

Detailed Description

template<class TVectorBase>
class ml::TVector< TVectorBase >

ML integer image vector class to be specialized for different purposes.

It is a template to handle and calculate with n dimensional cardinal coordinates and vectors.

It represents a vector to address coordinates and offsets into images. The methods provide elementary arithmetic vector operations and support the stride concept for efficient image addressing.

The members of this class define a ND vector of type integer which is specialized normally to the ImageVector class which has the MLMaxImageDimension (defined in mlImageVector.h) with MLint as component type.

This class can also be instantiated with higher NumberOfDimensions arguments or other CompIntType arguments to compile arbitrary dimensional vectors with an arbitrary integer base type.

Example for vector initialization:

 TVector<MLint> p;
 p[0]=3; p[1]=5; p[2]=7; p[3]=9; p[4]=11; p[5]=13;
// or
 TVector<MLint> q(4, p);
// or
 TVector<MLint> q();
 q.set(0);

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.

Parameters

TVectorBase should be TVector6DBase for 6D ML image vector types or TVectorNDBase for other dimensional vectors.

Definition at line 111 of file mlIntegerVector.h.

Member Typedef Documentation

◆ ComponentType

template<class TVectorBase >

typedef TVectorBase::ComponentType ml::TVector< TVectorBase >::ComponentType

Integer type used by this vector.

Definition at line 116 of file mlIntegerVector.h.

◆ ParentClass

template<class TVectorBase >

typedef TVectorBase ml::TVector< TVectorBase >::ParentClass

Parent class of this class.

Definition at line 119 of file mlIntegerVector.h.

Member Enumeration Documentation

◆ anonymous enum

template<class TVectorBase >

anonymous enum

Enumerator defining the dimension of this class.

Enumerator
NumberOfDimensions

Definition at line 122 of file mlIntegerVector.h.

Constructor & Destructor Documentation

◆ TVector() [1/6]

template<class TVectorBase >

ml::TVector< TVectorBase >::TVector ( )

inline

Constructor. All components are initialized to 0.

Definition at line 130 of file mlIntegerVector.h.

void ml::TVector< TVectorBase >::copy	(	const MLint	num,
		ComponentType *const	arr ) const

std::string ml::TVector< TVectorBase >::print	(	const std::string &	openStr = "",
		const std::string &	sepStr = " ",
		const std::string &	termStr = "",
		const MLint16	numDigits = -1 ) const

Public Types

Public Member Functions

Arithmetics as static and member functions

Detailed Description

Member Typedef Documentation

◆ ComponentType

◆ ParentClass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ TVector() [1/6]

◆ TVector() [2/6]

◆ TVector() [3/6]

◆ TVector() [4/6]

◆ TVector() [5/6]

◆ TVector() [6/6]

Member Function Documentation

◆ allBiggerZero()

◆ compAbs() [1/2]

◆ compAbs() [2/2]

◆ compMax() [1/2]

◆ compMax() [2/2]

◆ compMin() [1/2]

◆ compMin() [2/2]

◆ compMod() [1/2]

◆ compMod() [2/2]

◆ compMul() [1/2]

◆ compMul() [2/2]

◆ compSum() [1/2]

◆ compSum() [2/2]

◆ copy()

◆ divCeil() [1/2]

◆ divCeil() [2/2]

◆ dot() [1/2]

◆ dot() [2/2]

◆ fillEqualComps()

◆ fillGreaterComps()

◆ fillSmallerComps()

◆ getExtDimension()

◆ getMax()

◆ getMaxIdx()

◆ getMin()

◆ getMinIdx()

◆ getStrides()

◆ getVectorPosition()

◆ hasNegativeComp()

◆ operator!=()

◆ operator&() [1/2]

◆ operator&() [2/2]

◆ operator&=() [1/2]

◆ operator&=() [2/2]

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=()

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator+=()

◆ operator-() [1/3]

◆ operator-() [2/3]

◆ operator-() [3/3]

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator<()

◆ operator<<()

◆ operator<<=()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator>>()

◆ operator>>=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ operator^() [1/2]

◆ operator^() [2/2]

◆ operator^=() [1/2]

◆ operator^=() [2/2]

◆ operator|() [1/2]