Medical Imaging Interaction Toolkit  2018.4.99-12ad79a3
Medical Imaging Interaction Toolkit
mitk::ImageDataItem Class Reference

Internal class for managing references on sub-images. More...

#include <mitkImageDataItem.h>

Inheritance diagram for mitk::ImageDataItem:
Collaboration diagram for mitk::ImageDataItem:

Public Types

typedef itk::SmartPointer< mitk::ImageImagePointer
 
typedef itk::SmartPointer< const mitk::ImageImageConstPointer
 
typedef ImageDataItem Self
 
typedef itk::LightObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
itk::LightObject::Pointer InternalClone () const override
 
 ImageDataItem (const ImageDataItem &aParent, const mitk::ImageDescriptor::Pointer desc, int timestep, unsigned int dimension, void *data=nullptr, bool manageMemory=false, vcl_size_t offset=0)
 
 ~ImageDataItem () override
 
 ImageDataItem (const mitk::ImageDescriptor::Pointer desc, int timestep, void *data, bool manageMemory)
 
 ImageDataItem (const mitk::PixelType &type, int timestep, unsigned int dimension, unsigned int *dimensions, void *data, bool manageMemory)
 
 ImageDataItem (const ImageDataItem &other)
 
void * GetData () const
 
bool IsComplete () const
 
void SetComplete (bool complete)
 
int GetOffset () const
 
PixelType GetPixelType () const
 
void SetTimestep (int t)
 
void SetManageMemory (bool b)
 
int GetDimension () const
 
int GetDimension (int i) const
 
ImageDataItem::ConstPointer GetParent () const
 
ImageVtkReadAccessorGetVtkImageAccessor (ImageConstPointer) const
 GetVtkImageAccessor Returns a vtkImageDataItem, if none is present, a new one is constructed by the ConstructVtkImageData method. Due to historical development of MITK and VTK, the vtkImage origin is explicitly set to (0, 0, 0) for 3D images. See bug 5050 for detailed information. More...
 
ImageVtkWriteAccessorGetVtkImageAccessor (ImagePointer)
 
bool GetManageMemory () const
 
virtual void ConstructVtkImageData (ImageConstPointer) const
 
vcl_size_t GetSize () const
 
virtual void Modified () const
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 

Protected Attributes

unsigned char * m_Data
 
PixelTypem_PixelType
 
bool m_ManageMemory
 
vtkImageData * m_VtkImageData
 
ImageVtkReadAccessorm_VtkImageReadAccessor
 
ImageVtkWriteAccessorm_VtkImageWriteAccessor
 
int m_Offset
 
bool m_IsComplete
 
vcl_size_t m_Size
 

Detailed Description

Internal class for managing references on sub-images.

ImageDataItem is a container for image data which is used internal in mitk::Image to handle the communication between the different data types for images used in MITK (ipPicDescriptor, mitk::Image, vtkImageData). Common for these image data types is the actual image data, but they differ in representation of pixel type etc. The class is also used to convert ipPic images to vtkImageData.

The class is mainly used to extract sub-images inside of mitk::Image, like single slices etc. It should not be used outside of this.

Parameters
manageMemoryDetermines if image data is removed while destruction of ImageDataItem or not.

Definition at line 47 of file mitkImageDataItem.h.

Member Typedef Documentation

◆ ConstPointer

◆ ImageConstPointer

◆ ImagePointer

◆ Pointer

◆ Self

Definition at line 65 of file mitkImageDataItem.h.

◆ Superclass

typedef itk::LightObject mitk::ImageDataItem::Superclass

Definition at line 65 of file mitkImageDataItem.h.

Constructor & Destructor Documentation

◆ ImageDataItem() [1/4]

mitk::ImageDataItem::ImageDataItem ( const ImageDataItem aParent,
const mitk::ImageDescriptor::Pointer  desc,
int  timestep,
unsigned int  dimension,
void *  data = nullptr,
bool  manageMemory = false,
vcl_size_t  offset = 0 
)

Definition at line 34 of file mitkImageDataItem.cpp.

References m_Data, and m_Size.

◆ ~ImageDataItem()

mitk::ImageDataItem::~ImageDataItem ( )
override

◆ ImageDataItem() [2/4]

mitk::ImageDataItem::ImageDataItem ( const mitk::ImageDescriptor::Pointer  desc,
int  timestep,
void *  data,
bool  manageMemory 
)

Definition at line 98 of file mitkImageDataItem.cpp.

References m_Data, m_ManageMemory, and m_Size.

◆ ImageDataItem() [3/4]

mitk::ImageDataItem::ImageDataItem ( const mitk::PixelType type,
int  timestep,
unsigned int  dimension,
unsigned int *  dimensions,
void *  data,
bool  manageMemory 
)

Definition at line 132 of file mitkImageDataItem.cpp.

References m_Data, m_ManageMemory, and m_Size.

◆ ImageDataItem() [4/4]

mitk::ImageDataItem::ImageDataItem ( const ImageDataItem other)

Definition at line 167 of file mitkImageDataItem.cpp.

References MAX_IMAGE_DIMENSIONS.

Member Function Documentation

◆ Clone()

Pointer mitk::ImageDataItem::Clone ( ) const

◆ ConstructVtkImageData()

void mitk::ImageDataItem::ConstructVtkImageData ( ImageConstPointer  iP) const
virtual

Definition at line 203 of file mitkImageDataItem.cpp.

References mitk::BaseGeometry::GetSpacing().

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::ImageDataItem::GetClassHierarchy ( ) const
inlinevirtual

Definition at line 65 of file mitkImageDataItem.h.

◆ GetClassName()

virtual const char* mitk::ImageDataItem::GetClassName ( ) const
virtual

◆ GetData()

void* mitk::ImageDataItem::GetData ( ) const
inline
Deprecated:
(as of 2012_09) Please use image accessors instead: See Doxygen/Related-Pages/Concepts/Image. This method can be replaced by ImageWriteAccessor::GetData() or ImageReadAccessor::GetData()

Definition at line 94 of file mitkImageDataItem.h.

◆ GetDimension() [1/2]

int mitk::ImageDataItem::GetDimension ( ) const
inline

◆ GetDimension() [2/2]

int mitk::ImageDataItem::GetDimension ( int  i) const
inline

Definition at line 102 of file mitkImageDataItem.h.

◆ GetManageMemory()

bool mitk::ImageDataItem::GetManageMemory ( ) const
inline

Definition at line 127 of file mitkImageDataItem.h.

◆ GetOffset()

int mitk::ImageDataItem::GetOffset ( ) const
inline

Definition at line 97 of file mitkImageDataItem.h.

◆ GetParent()

ImageDataItem::ConstPointer mitk::ImageDataItem::GetParent ( ) const
inline

Definition at line 113 of file mitkImageDataItem.h.

◆ GetPixelType()

PixelType mitk::ImageDataItem::GetPixelType ( ) const
inline

Definition at line 98 of file mitkImageDataItem.h.

◆ GetSize()

vcl_size_t mitk::ImageDataItem::GetSize ( ) const
inline

Definition at line 130 of file mitkImageDataItem.h.

◆ GetStaticNameOfClass()

static const char* mitk::ImageDataItem::GetStaticNameOfClass ( )
inlinestatic

Definition at line 65 of file mitkImageDataItem.h.

◆ GetVtkImageAccessor() [1/2]

mitk::ImageVtkReadAccessor * mitk::ImageDataItem::GetVtkImageAccessor ( ImageConstPointer  iP) const

GetVtkImageAccessor Returns a vtkImageDataItem, if none is present, a new one is constructed by the ConstructVtkImageData method. Due to historical development of MITK and VTK, the vtkImage origin is explicitly set to (0, 0, 0) for 3D images. See bug 5050 for detailed information.

Returns
Pointer of type ImageVtkReadAccessor

Definition at line 310 of file mitkImageDataItem.cpp.

◆ GetVtkImageAccessor() [2/2]

mitk::ImageVtkWriteAccessor * mitk::ImageDataItem::GetVtkImageAccessor ( ImagePointer  iP)

Definition at line 323 of file mitkImageDataItem.cpp.

◆ InternalClone()

itk::LightObject::Pointer mitk::ImageDataItem::InternalClone ( ) const
override

Definition at line 187 of file mitkImageDataItem.cpp.

◆ IsComplete()

bool mitk::ImageDataItem::IsComplete ( ) const
inline

Definition at line 95 of file mitkImageDataItem.h.

Referenced by ThreadMethod().

◆ Modified()

void mitk::ImageDataItem::Modified ( ) const
virtual

Definition at line 304 of file mitkImageDataItem.cpp.

◆ SetComplete()

void mitk::ImageDataItem::SetComplete ( bool  complete)
inline

Definition at line 96 of file mitkImageDataItem.h.

◆ SetManageMemory()

void mitk::ImageDataItem::SetManageMemory ( bool  b)
inline

Definition at line 100 of file mitkImageDataItem.h.

◆ SetTimestep()

void mitk::ImageDataItem::SetTimestep ( int  t)
inline

Definition at line 99 of file mitkImageDataItem.h.

Member Data Documentation

◆ m_Data

unsigned char* mitk::ImageDataItem::m_Data
protected

◆ m_IsComplete

bool mitk::ImageDataItem::m_IsComplete
protected

Definition at line 145 of file mitkImageDataItem.h.

◆ m_ManageMemory

bool mitk::ImageDataItem::m_ManageMemory
protected

Definition at line 138 of file mitkImageDataItem.h.

Referenced by ImageDataItem(), and ~ImageDataItem().

◆ m_Offset

int mitk::ImageDataItem::m_Offset
protected

Definition at line 143 of file mitkImageDataItem.h.

◆ m_PixelType

PixelType* mitk::ImageDataItem::m_PixelType
protected

Definition at line 136 of file mitkImageDataItem.h.

Referenced by ~ImageDataItem().

◆ m_Size

vcl_size_t mitk::ImageDataItem::m_Size
protected

◆ m_VtkImageData

vtkImageData* mitk::ImageDataItem::m_VtkImageData
mutableprotected

Definition at line 140 of file mitkImageDataItem.h.

Referenced by ~ImageDataItem().

◆ m_VtkImageReadAccessor

ImageVtkReadAccessor* mitk::ImageDataItem::m_VtkImageReadAccessor
mutableprotected

Definition at line 141 of file mitkImageDataItem.h.

Referenced by ~ImageDataItem().

◆ m_VtkImageWriteAccessor

ImageVtkWriteAccessor* mitk::ImageDataItem::m_VtkImageWriteAccessor
protected

Definition at line 142 of file mitkImageDataItem.h.

Referenced by ~ImageDataItem().


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