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::Image >	ImageConstPointer

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...
virtual	~ImageWriteAccessor ()
	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
virtual 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

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

Definition at line 29 of file mitkImageWriteAccessor.h.

Member Typedef Documentation

typedef Image::Pointer mitk::ImageWriteAccessor::ImagePointer

Definition at line 35 of file mitkImageWriteAccessor.h.

Constructor & Destructor Documentation

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

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

Parameters

Image::Pointer	specifies the associated Image
ImageDataItem*	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

Definition at line 19 of file mitkImageWriteAccessor.cpp.

mitk::ImageWriteAccessor::~ImageWriteAccessor ( )

virtual

informs Image to unlock the represented image part

Definition at line 26 of file mitkImageWriteAccessor.cpp.

Member Function Documentation

void* mitk::ImageWriteAccessor::GetData ( )

inline

Gives full data access.

Definition at line 51 of file mitkImageWriteAccessor.h.

Referenced by QmitkSlicesInterpolator::AcceptAllInterpolations(), mitk::CastToIpPicDescriptor(), mitk::PythonService::CopyCvImageFromPython(), mitk::LabelSetImage::CreateLabelMask(), mitk::DWIHeadMotionCorrectionFilter::GenerateData(), mitk::ImageGenerator::GenerateImageFromReference(), mitk::ImageGenerator::GenerateRandomImage(), mitk::LabelSetImage::InitializeByLabeledImage(), mitkLevelWindowTest(), ResampleImage(), mitk::SurfaceToImageFilter::Stencil3DImage(), and ThreadMethod().

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

overrideprotectedvirtual

Implements mitk::ImageAccessorBase.

Definition at line 51 of file mitkImageWriteAccessor.cpp.

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

---

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

• mitkImageWriteAccessor.h
• mitkImageWriteAccessor.cpp