mitk::ImagePixelAccessor< TPixel, VDimension > Class Template Reference

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

#include <mitkImagePixelAccessor.h>

Inheritance diagram for mitk::ImagePixelAccessor< TPixel, VDimension >:

Collaboration diagram for mitk::ImagePixelAccessor< TPixel, VDimension >:

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

TPixel	defines the PixelType
VDimension	defines the dimension for accessing data

Definition at line 32 of file mitkImagePixelAccessor.h.

Member Typedef Documentation

template<class TPixel , unsigned int VDimension = 3>

typedef Image::ConstPointer mitk::ImagePixelAccessor< TPixel, VDimension >::ImageConstPointer

Definition at line 39 of file mitkImagePixelAccessor.h.

template<class TPixel , unsigned int VDimension = 3>

typedef ImagePixelAccessor<TPixel, VDimension> mitk::ImagePixelAccessor< TPixel, VDimension >::ImagePixelAccessorType

Definition at line 38 of file mitkImagePixelAccessor.h.

template<class TPixel , unsigned int VDimension = 3>

typedef itk::Index<VDimension> mitk::ImagePixelAccessor< TPixel, VDimension >::IndexType

Definition at line 37 of file mitkImagePixelAccessor.h.

Constructor & Destructor Documentation

template<class TPixel , unsigned int VDimension = 3>

mitk::ImagePixelAccessor< TPixel, VDimension >::ImagePixelAccessor ( ImageConstPointer  iP, const mitk::ImageDataItem *  iDI  )

inlineprotected

Parameters

ImageDataItem*

specifies the allocated image part

Definition at line 45 of file mitkImagePixelAccessor.h.

References mitk::ImagePixelAccessor< TPixel, VDimension >::CheckData(), and mitk::ImagePixelAccessor< TPixel, VDimension >::m_ImageDataItem.

template<class TPixel , unsigned int VDimension = 3>

virtual mitk::ImagePixelAccessor< TPixel, VDimension >::~ImagePixelAccessor ( )

inlineprotectedvirtual

Destructor

Definition at line 55 of file mitkImagePixelAccessor.h.

Member Function Documentation

template<class TPixel , unsigned int VDimension = 3>

void mitk::ImagePixelAccessor< TPixel, VDimension >::CheckData ( const Image *  image )

inlineprotected

Definition at line 56 of file mitkImagePixelAccessor.h.

References mitk::ImageDataItem::GetDimension(), mitk::Image::GetDimension(), mitk::PixelType::GetNumberOfComponents(), mitk::Image::GetPixelType(), mitk::ImagePixelAccessor< TPixel, VDimension >::m_ImageDataItem, and mitkThrow.

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

template<class TPixel , unsigned int VDimension = 3>

int mitk::ImagePixelAccessor< TPixel, VDimension >::GetDimension ( int  i ) const

inline

Get Dimensions from ImageDataItem

Definition at line 42 of file mitkImagePixelAccessor.h.

References mitk::ImageDataItem::GetDimension(), and mitk::ImagePixelAccessor< TPixel, VDimension >::m_ImageDataItem.

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 109 of file mitkImagePixelAccessor.h.

References offset.

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

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 94 of file mitkImagePixelAccessor.h.

template<class TPixel , unsigned int VDimension = 3>

const ImageDataItem* mitk::ImagePixelAccessor< TPixel, VDimension >::m_ImageDataItem

protected

Holds the specified ImageDataItem

Definition at line 88 of file mitkImagePixelAccessor.h.

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

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 106 of file mitkImagePixelAccessor.h.

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 101 of file mitkImagePixelAccessor.h.

---

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

• mitkImagePixelAccessor.h