Medical Imaging Interaction Toolkit  2024.06.99-31d3c0df
Medical Imaging Interaction Toolkit
mitk::ImageWriteAccessor Class Reference

ImageWriteAccessor class to get locked write-access for a particular image part. More...

#include <mitkImageWriteAccessor.h>

Inheritance diagram for mitk::ImageWriteAccessor:
Collaboration diagram for mitk::ImageWriteAccessor:

Public Types

typedef Image::Pointer 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::ImageImageConstPointer

Public Member Functions

 ImageWriteAccessor (ImagePointer image, const ImageDataItem *iDI=nullptr, int OptionFlags=ImageAccessorBase::DefaultBehavior)
 Orders write access for a slice, volume or 4D-Image. More...
void * GetData ()
 Gives full data access. More...
 ~ImageWriteAccessor () override
 informs Image to unlock the represented image part More...
- Public Member Functions inherited from mitk::ImageAccessorBase
virtual ~ImageAccessorBase ()
const void * GetData () const
 Gives const access to the data. More...

Protected Member Functions

const ImageGetImage () 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
 Pointer to a WaitLock struct, that allows other ImageAccessors to wait for this ImageAccessor. More...
ThreadIDType m_Thread

Detailed Description

ImageWriteAccessor class to get locked write-access for a particular image part.

Definition at line 25 of file mitkImageWriteAccessor.h.

Member Typedef Documentation

◆ ImagePointer

Constructor & Destructor Documentation

◆ ImageWriteAccessor()

mitk::ImageWriteAccessor::ImageWriteAccessor ( ImagePointer  image,
const ImageDataItem iDI = nullptr,
int  OptionFlags = ImageAccessorBase::DefaultBehavior 

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

imagespecifies the associated Image
iDIspecifies the allocated image part
OptionFlagsproperties from mitk::ImageAccessorBase::Options can be chosen and assembled with bitwise unification.
mitk::Exceptionif the Constructor was created inappropriately
mitk::MemoryIsLockedExceptionif requested image area is exclusively locked and mitk::ImageAccessorBase::ExceptionIfLocked is set in OptionFlags

◆ ~ImageWriteAccessor()

mitk::ImageWriteAccessor::~ImageWriteAccessor ( )

informs Image to unlock the represented image part

Member Function Documentation

◆ GetData()

void* mitk::ImageWriteAccessor::GetData ( )

◆ GetImage()

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

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