Medical Imaging Interaction Toolkit  2023.04.00
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mitk::ImagePixelAccessor< TPixel, VDimension > Class Template Reference
MITK Modules » Core » Data Classes

Provides templated image access for all inheriting classes. More...

#include <mitkImagePixelAccessor.h>

Inheritance diagram for mitk::ImagePixelAccessor< TPixel, VDimension >:
Inheritance graph
[legend]
Collaboration diagram for mitk::ImagePixelAccessor< TPixel, VDimension >:
Collaboration graph
[legend]

Public Types

typedef itk::Index< VDimension > IndexType
 
typedef ImagePixelAccessor< TPixel, VDimension > ImagePixelAccessorType
 
typedef Image::ConstPointer ImageConstPointer
 

Public Member Functions

int GetDimension (int i) const
 

Protected Member Functions

 ImagePixelAccessor (ImageConstPointer iP, const mitk::ImageDataItem *iDI)
 
virtual ~ImagePixelAccessor ()
 
void CheckData (const Image *image)
 
unsigned int GetOffset (const IndexType &idx) const
 

Protected Attributes

const ImageDataItem * m_ImageDataItem
 
BaseGeometry::Pointer m_Geometry
 Pointer to the used Geometry. Since Geometry can be different to the Image (if memory was forced to be coherent) it is necessary to store Geometry separately. More...
 
itk::ImageRegion< VDimension > * m_SubRegion
 A Subregion defines an arbitrary area within the image. If no SubRegion is defined, the whole ImageDataItem or Image is regarded. A subregion (e.g. subvolume) can lead to non-coherent memory access where every dimension has a start- and end-offset. More...
 
int m_Options
 Stores all extended properties of an ImageAccessor. The different flags in mitk::ImageAccessorBase::Options can be unified by bitwise operations. More...
 

Detailed Description

template<class TPixel, unsigned int VDimension = 3>
class mitk::ImagePixelAccessor< TPixel, VDimension >

Provides templated image access for all inheriting classes.

Template Parameters
TPixeldefines the PixelType
VDimensiondefines the dimension for accessing data

Definition at line 30 of file mitkImagePixelAccessor.h.

Member Typedef Documentation

◆ ImageConstPointer

template<class TPixel , unsigned int VDimension = 3>
typedef Image::ConstPointer mitk::ImagePixelAccessor< TPixel, VDimension >::ImageConstPointer

Definition at line 35 of file mitkImagePixelAccessor.h.

◆ ImagePixelAccessorType

template<class TPixel , unsigned int VDimension = 3>
typedef ImagePixelAccessor<TPixel, VDimension> mitk::ImagePixelAccessor< TPixel, VDimension >::ImagePixelAccessorType

Definition at line 34 of file mitkImagePixelAccessor.h.

◆ IndexType

template<class TPixel , unsigned int VDimension = 3>
typedef itk::Index<VDimension> mitk::ImagePixelAccessor< TPixel, VDimension >::IndexType

Definition at line 33 of file mitkImagePixelAccessor.h.

Constructor & Destructor Documentation

◆ ImagePixelAccessor()

template<class TPixel , unsigned int VDimension = 3>
mitk::ImagePixelAccessor< TPixel, VDimension >::ImagePixelAccessor ( ImageConstPointer  iP,
const mitk::ImageDataItem *  iDI 
)
inlineprotected
Parameters
iP
iDIspecifies the allocated image part

Definition at line 48 of file mitkImagePixelAccessor.h.

◆ ~ImagePixelAccessor()

template<class TPixel , unsigned int VDimension = 3>
virtual mitk::ImagePixelAccessor< TPixel, VDimension >::~ImagePixelAccessor ( )
inlineprotectedvirtual

Destructor

Definition at line 58 of file mitkImagePixelAccessor.h.

Member Function Documentation

◆ CheckData()

template<class TPixel , unsigned int VDimension = 3>
void mitk::ImagePixelAccessor< TPixel, VDimension >::CheckData ( const Image *  image)
inlineprotected

Definition at line 60 of file mitkImagePixelAccessor.h.

Referenced by mitk::ImagePixelAccessor< TPixel, 3 >::ImagePixelAccessor().

◆ GetDimension()

template<class TPixel , unsigned int VDimension = 3>
int mitk::ImagePixelAccessor< TPixel, VDimension >::GetDimension ( int  i) const
inline

Get Dimensions from ImageDataItem

Definition at line 38 of file mitkImagePixelAccessor.h.

◆ GetOffset()

template<class TPixel , unsigned int VDimension = 3>
unsigned int mitk::ImagePixelAccessor< TPixel, VDimension >::GetOffset ( const IndexType &  idx) const
inlineprotected

Get memory offset for a given image index

Definition at line 117 of file mitkImagePixelAccessor.h.

Referenced by mitk::ImagePixelReadAccessor< TPixel, VDimension >::GetConsecutivePixelsAsVector(), mitk::ImagePixelReadAccessor< TPixel, VDimension >::GetPixelByIndex(), mitk::ImagePixelWriteAccessor< TPixel, VDimension >::GetPixelByIndex(), mitk::ImagePixelWriteAccessor< TPixel, VDimension >::GetPixelByIndexSafe(), mitk::ImagePixelReadAccessor< TPixel, VDimension >::GetPixelByIndexSafe(), mitk::ImagePixelWriteAccessor< TPixel, VDimension >::SetPixelByIndex(), and mitk::ImagePixelWriteAccessor< TPixel, VDimension >::SetPixelByIndexSafe().

Member Data Documentation

◆ m_Geometry

template<class TPixel , unsigned int VDimension = 3>
BaseGeometry::Pointer mitk::ImagePixelAccessor< TPixel, VDimension >::m_Geometry
protected

Pointer to the used Geometry. Since Geometry can be different to the Image (if memory was forced to be coherent) it is necessary to store Geometry separately.

Definition at line 102 of file mitkImagePixelAccessor.h.

◆ m_ImageDataItem

template<class TPixel , unsigned int VDimension = 3>
const ImageDataItem* mitk::ImagePixelAccessor< TPixel, VDimension >::m_ImageDataItem
protected

Holds the specified ImageDataItem

Definition at line 96 of file mitkImagePixelAccessor.h.

Referenced by mitk::ImagePixelAccessor< TPixel, 3 >::CheckData(), mitk::ImagePixelAccessor< TPixel, 3 >::GetDimension(), mitk::ImagePixelAccessor< TPixel, 3 >::GetOffset(), and mitk::ImagePixelAccessor< TPixel, 3 >::ImagePixelAccessor().

◆ m_Options

template<class TPixel , unsigned int VDimension = 3>
int mitk::ImagePixelAccessor< TPixel, VDimension >::m_Options
protected

Stores all extended properties of an ImageAccessor. The different flags in mitk::ImageAccessorBase::Options can be unified by bitwise operations.

Definition at line 114 of file mitkImagePixelAccessor.h.

◆ m_SubRegion

template<class TPixel , unsigned int VDimension = 3>
itk::ImageRegion<VDimension>* mitk::ImagePixelAccessor< TPixel, VDimension >::m_SubRegion
protected

A Subregion defines an arbitrary area within the image. If no SubRegion is defined, the whole ImageDataItem or Image is regarded. A subregion (e.g. subvolume) can lead to non-coherent memory access where every dimension has a start- and end-offset.

Definition at line 109 of file mitkImagePixelAccessor.h.

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