ImageReadAccessor class to get locked read access for a particular image part. More...

#include <mitkImageReadAccessor.h>

Inheritance diagram for mitk::ImageReadAccessor:

Collaboration diagram for mitk::ImageReadAccessor:

[legend]

Public Types
typedef itk::SmartPointer< Image >	ImagePointer

Public Types inherited from mitk::ImageAccessorBase
enum	Options { DefaultBehavior, ExceptionIfLocked, ForceCoherentMemory, IgnoreLock }
	defines different flags for the ImageAccessor constructors More...

typedef itk::SmartPointer< const mitk::Image >	ImageConstPointer

Public Member Functions
	ImageReadAccessor (ImageConstPointer image, const ImageDataItem *iDI=nullptr, int OptionFlags=ImageAccessorBase::DefaultBehavior)
	Orders read access for a slice, volume or 4D-Image. More...

	ImageReadAccessor (ImagePointer image, const ImageDataItem *iDI=nullptr, int OptionFlags=ImageAccessorBase::DefaultBehavior)

	ImageReadAccessor (const Image image, const ImageDataItem iDI=nullptr)

	~ImageReadAccessor () override

Public Member Functions inherited from mitk::ImageAccessorBase
virtual	~ImageAccessorBase ()

const void *	GetData () const
	Gives const access to the data. More...

Protected Member Functions
const Image *	GetImage () const override

Protected Member Functions inherited from mitk::ImageAccessorBase
	ImageAccessorBase (ImageConstPointer iP, const ImageDataItem *iDI=nullptr, int OptionFlags=DefaultBehavior)
	Checks validity of given parameters from inheriting classes and stores those parameters in member variables. More...

void	Increment ()
	Increments m_WaiterCount. A call of this method is prohibited unless the Mutex m_ReadWriteLock in the mitk::Image class is Locked. More...

bool	Overlap (const ImageAccessorBase *iAB)
	Computes if there is an Overlap of the image part between this instantiation and another ImageAccessor object. More...

void	WaitForReleaseOf (ImageAccessorWaitLock *wL)
	Uses the WaitLock to wait for another ImageAccessor. More...

void	PreventRecursiveMutexLock (ImageAccessorBase *iAB)
	Prevents a recursive mutex lock by comparing thread ids of competing image accessors. More...

Additional Inherited Members
Protected Attributes inherited from mitk::ImageAccessorBase
itk::ImageRegion< 4 > *	m_SubRegion

void *	m_AddressBegin

void *	m_AddressEnd

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

bool	m_CoherentMemory

ImageAccessorWaitLock *	m_WaitLock
	Pointer to a WaitLock struct, that allows other ImageAccessors to wait for this ImageAccessor. More...

ThreadIDType	m_Thread

Detailed Description

ImageReadAccessor class to get locked read access for a particular image part.

Definition at line 27 of file mitkImageReadAccessor.h.

Member Typedef Documentation

◆ ImagePointer

typedef itk::SmartPointer<Image> mitk::ImageReadAccessor::ImagePointer

Definition at line 35 of file mitkImageReadAccessor.h.

Constructor & Destructor Documentation

◆ ImageReadAccessor() [1/3]

mitk::ImageReadAccessor::ImageReadAccessor	(	ImageConstPointer	image,
		const ImageDataItem *	iDI = `nullptr`,
		int	OptionFlags = `ImageAccessorBase::DefaultBehavior`
	)

Orders read access for a slice, volume or 4D-Image.

Parameters

image	specifies the associated Image
iDI	specifies the allocated image part
OptionFlags	properties from mitk::ImageAccessorBase::Options can be chosen and assembled with bitwise unification.

Exceptions

mitk::Exception	if the Constructor was created inappropriately
mitk::MemoryIsLockedException	if requested image area is exclusively locked and mitk::ImageAccessorBase::ExceptionIfLocked is set in OptionFlags

◆ ImageReadAccessor() [2/3]

mitk::ImageReadAccessor::ImageReadAccessor	(	ImagePointer	image,
		const ImageDataItem *	iDI = `nullptr`,
		int	OptionFlags = `ImageAccessorBase::DefaultBehavior`
	)

◆ ImageReadAccessor() [3/3]

mitk::ImageReadAccessor::ImageReadAccessor	(	const Image *	image,
		const ImageDataItem *	iDI = `nullptr`
	)

◆ ~ImageReadAccessor()

mitk::ImageReadAccessor::~ImageReadAccessor ( )

override

Destructor informs Image to unlock memory.

Member Function Documentation

◆ GetImage()

const Image* mitk::ImageReadAccessor::GetImage ( ) const

overrideprotectedvirtual

Implements mitk::ImageAccessorBase.

Referenced by mitk::ImagePixelReadAccessor< TPixel, VDimension >::GetConsecutivePixelsAsVector(), and mitk::ImagePixelReadAccessor< TPixel, VDimension >::GetPixelByWorldCoordinates().

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

mitkImageReadAccessor.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members