Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mitk::ImageAccessorBase Class Referenceabstract

#include <mitkImageAccessorBase.h>

Inheritance diagram for mitk::ImageAccessorBase:
Inheritance graph
[legend]
Collaboration diagram for mitk::ImageAccessorBase:
Collaboration graph
[legend]

Public Types

enum  Options { DefaultBehavior, ExceptionIfLocked, ForceCoherentMemory, IgnoreLock }
 defines different flags for the ImageAccessor constructors More...
 
typedef itk::SmartPointer< const mitk::Image > ImageConstPointer
 

Public Member Functions

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

Protected Member Functions

 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...
 
virtual const Image * GetImage () const =0
 

Protected Attributes

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

Definition at line 48 of file mitkImageAccessorBase.h.

Member Typedef Documentation

◆ ImageConstPointer

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

Definition at line 62 of file mitkImageAccessorBase.h.

Member Enumeration Documentation

◆ Options

enum mitk::ImageAccessorBase::Options

defines different flags for the ImageAccessor constructors

Enumerator
DefaultBehavior 

No specific Options ==> Default

ExceptionIfLocked 

Defines if the Constructor waits for locked memory until it is released or not. If not, an exception is thrown.

ForceCoherentMemory 

Defines if requested Memory has to be coherent. If the parameter is true, it is possible that new Memory has to be allocated to arrange this desired condition. Consequently, this parameter can heavily affect computation time.

IgnoreLock 

Ignores the lock mechanism for immediate access. Only possible with read accessors.

Definition at line 66 of file mitkImageAccessorBase.h.

Constructor & Destructor Documentation

◆ ~ImageAccessorBase()

virtual mitk::ImageAccessorBase::~ImageAccessorBase ( )
virtual

◆ ImageAccessorBase()

mitk::ImageAccessorBase::ImageAccessorBase ( ImageConstPointer  iP,
const ImageDataItem *  iDI = nullptr,
int  OptionFlags = DefaultBehavior 
)
protected

Checks validity of given parameters from inheriting classes and stores those parameters in member variables.

Member Function Documentation

◆ GetData()

const void* mitk::ImageAccessorBase::GetData ( ) const
inline

Gives const access to the data.

Definition at line 85 of file mitkImageAccessorBase.h.

◆ GetImage()

virtual const Image* mitk::ImageAccessorBase::GetImage ( ) const
protectedpure virtual

Implemented in mitk::ImageReadAccessor, mitk::ImageWriteAccessor, mitk::ImageVtkReadAccessor, and mitk::ImageVtkWriteAccessor.

◆ Increment()

void mitk::ImageAccessorBase::Increment ( )
inlineprotected

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

Definition at line 129 of file mitkImageAccessorBase.h.

References mitk::ImageAccessorWaitLock::m_WaiterCount.

◆ Overlap()

bool mitk::ImageAccessorBase::Overlap ( const ImageAccessorBase *  iAB)
protected

Computes if there is an Overlap of the image part between this instantiation and another ImageAccessor object.

Exceptions
mitk::Exceptionif memory area is incoherent (not supported yet)

◆ PreventRecursiveMutexLock()

void mitk::ImageAccessorBase::PreventRecursiveMutexLock ( ImageAccessorBase *  iAB)
protected

Prevents a recursive mutex lock by comparing thread ids of competing image accessors.

◆ WaitForReleaseOf()

void mitk::ImageAccessorBase::WaitForReleaseOf ( ImageAccessorWaitLock *  wL)
protected

Uses the WaitLock to wait for another ImageAccessor.

Member Data Documentation

◆ m_AddressBegin

void* mitk::ImageAccessorBase::m_AddressBegin
protected

Points to the beginning of the image part.

Definition at line 111 of file mitkImageAccessorBase.h.

Referenced by mitk::ImagePixelReadAccessor< TPixel, VDimension >::GetConsecutivePixelsAsVector(), mitk::ImagePixelWriteAccessor< TPixel, VDimension >::GetData(), mitk::ImagePixelReadAccessor< TPixel, VDimension >::GetData(), 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().

◆ m_AddressEnd

void* mitk::ImageAccessorBase::m_AddressEnd
protected

Contains the first address after the image part.

Definition at line 114 of file mitkImageAccessorBase.h.

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

◆ m_CoherentMemory

bool mitk::ImageAccessorBase::m_CoherentMemory
protected

Defines if the accessed image part lies coherently in memory

Definition at line 122 of file mitkImageAccessorBase.h.

◆ m_Options

int mitk::ImageAccessorBase::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 119 of file mitkImageAccessorBase.h.

◆ m_SubRegion

itk::ImageRegion<4>* mitk::ImageAccessorBase::m_SubRegion
protected

ImageAccessor has access to the image it belongs to. Contains a SubRegion (always represented in maximal possible dimension)

Definition at line 108 of file mitkImageAccessorBase.h.

◆ m_Thread

ThreadIDType mitk::ImageAccessorBase::m_Thread
protected

Definition at line 139 of file mitkImageAccessorBase.h.

◆ m_WaitLock

ImageAccessorWaitLock* mitk::ImageAccessorBase::m_WaitLock
protected

Pointer to a WaitLock struct, that allows other ImageAccessors to wait for this ImageAccessor.

Definition at line 125 of file mitkImageAccessorBase.h.

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