ML Reference
ml::TVector6DBase< CompIntType > Class Template Reference

TVector6DBase is the data container class for TVector providing specialized 6D container functionality for vectors of dimension MLMaxImageDimension. More...

#include <mlImageVector.h>

Public Types

enum  { NumberOfDimensions = MLMaxImageDimension }
 Enumerator defining the dimension of this class. More...
 
typedef CompIntType ComponentType
 Integer type used by this vector.
 

Public Attributes

union { 
 
   struct { 
 
      ComponentType   x 
 X component of the vector. More...
 
      ComponentType   y 
 Y component of the vector. More...
 
      ComponentType   z 
 Z component of the vector. More...
 
      ComponentType   c 
 Color component of the vector. More...
 
      ComponentType   t 
 Time component of the vector. More...
 
      ComponentType   u 
 Unit/Modality/User component of the vector. More...
 
   }  
 
   ComponentType   array [NumberOfDimensions
 Provides public access to all members as an array; the caller must guarantee that indexes are within [0,...,MLMaxImageDimension-1]. More...
 
};  
 

Protected Member Functions

 TVector6DBase ()
 Do not allow a direct creation of this class as object, because this container does not initialize itself, it must be done only by derived classes for performance reasons.
 

Detailed Description

template<typename CompIntType>
class ml::TVector6DBase< CompIntType >

TVector6DBase is the data container class for TVector providing specialized 6D container functionality for vectors of dimension MLMaxImageDimension.

Parameters
CompIntTypeis the integer type used as component member type; only signed integer types are tested/recommended.

Definition at line 39 of file mlImageVector.h.

Member Typedef Documentation

◆ ComponentType

template<typename CompIntType >
typedef CompIntType ml::TVector6DBase< CompIntType >::ComponentType

Integer type used by this vector.

Definition at line 44 of file mlImageVector.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename CompIntType >
anonymous enum

Enumerator defining the dimension of this class.

Enumerator
NumberOfDimensions 

Definition at line 47 of file mlImageVector.h.

Constructor & Destructor Documentation

◆ TVector6DBase()

template<typename CompIntType >
ml::TVector6DBase< CompIntType >::TVector6DBase ( )
inlineprotected

Do not allow a direct creation of this class as object, because this container does not initialize itself, it must be done only by derived classes for performance reasons.

Definition at line 83 of file mlImageVector.h.

Member Data Documentation

◆ [union]

union { ... } ml::TVector6DBase< CompIntType >

◆ array

template<typename CompIntType >
ComponentType ml::TVector6DBase< CompIntType >::array[NumberOfDimensions]

Provides public access to all members as an array; the caller must guarantee that indexes are within [0,...,MLMaxImageDimension-1].

Definition at line 75 of file mlImageVector.h.

◆ c

template<typename CompIntType >
ComponentType ml::TVector6DBase< CompIntType >::c

Color component of the vector.

Definition at line 65 of file mlImageVector.h.

◆ t

template<typename CompIntType >
ComponentType ml::TVector6DBase< CompIntType >::t

Time component of the vector.

Definition at line 67 of file mlImageVector.h.

◆ u

template<typename CompIntType >
ComponentType ml::TVector6DBase< CompIntType >::u

Unit/Modality/User component of the vector.

Definition at line 69 of file mlImageVector.h.

◆ x

template<typename CompIntType >
ComponentType ml::TVector6DBase< CompIntType >::x

X component of the vector.

Definition at line 59 of file mlImageVector.h.

◆ y

template<typename CompIntType >
ComponentType ml::TVector6DBase< CompIntType >::y

Y component of the vector.

Definition at line 61 of file mlImageVector.h.

◆ z

template<typename CompIntType >
ComponentType ml::TVector6DBase< CompIntType >::z

Z component of the vector.

Definition at line 63 of file mlImageVector.h.


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