Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
mitk::CompressedImageContainer Class Reference

Holds one (compressed) mitk::Image. More...

#include <mitkCompressedImageContainer.h>

Inheritance diagram for mitk::CompressedImageContainer:
Collaboration diagram for mitk::CompressedImageContainer:

Public Member Functions

 mitkClassMacroItkParent (CompressedImageContainer, itk::Object)
 
Pointer Clone () const
 
void SetImage (Image *)
 Creates a compressed version of the image. More...
 
Image::Pointer GetImage ()
 Creates a full mitk::Image from its compressed version. More...
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 CompressedImageContainer ()
 
 ~CompressedImageContainer () override
 

Protected Attributes

PixelTypem_PixelType
 
unsigned int m_ImageDimension
 
std::vector< unsigned int > m_ImageDimensions
 
unsigned long m_OneTimeStepImageSizeInBytes
 
unsigned int m_NumberOfTimeSteps
 
std::vector< std::pair< unsigned char *, unsigned long > > m_ByteBuffers
 one for each timestep. first = pointer to compressed data; second = size of buffer in bytes More...
 
BaseGeometry::Pointer m_ImageGeometry
 

Detailed Description

Holds one (compressed) mitk::Image.

Uses zlib to compress the data of an mitk::Image.

$Author$

Definition at line 35 of file mitkCompressedImageContainer.h.

Constructor & Destructor Documentation

◆ CompressedImageContainer()

mitk::CompressedImageContainer::CompressedImageContainer ( )
protected

Definition at line 20 of file mitkCompressedImageContainer.cpp.

◆ ~CompressedImageContainer()

mitk::CompressedImageContainer::~CompressedImageContainer ( )
overrideprotected

Definition at line 24 of file mitkCompressedImageContainer.cpp.

References m_ByteBuffers, and m_PixelType.

Member Function Documentation

◆ Clone()

Pointer mitk::CompressedImageContainer::Clone ( ) const

◆ GetImage()

mitk::Image::Pointer mitk::CompressedImageContainer::GetImage ( void  )

Creates a full mitk::Image from its compressed version.

This Method hold no buffer, so the uncompression algorithm will be executed every time you call this method. Don't overdo it.

Definition at line 124 of file mitkCompressedImageContainer.cpp.

References image, m_ByteBuffers, m_ImageDimension, m_ImageDimensions, m_ImageGeometry, m_OneTimeStepImageSizeInBytes, m_PixelType, MITK_ERROR, MITK_INFO, and mitk::Image::New().

◆ mitkClassMacroItkParent()

mitk::CompressedImageContainer::mitkClassMacroItkParent ( CompressedImageContainer  ,
itk::Object   
)

◆ New()

◆ SetImage()

void mitk::CompressedImageContainer::SetImage ( Image image)

Member Data Documentation

◆ m_ByteBuffers

std::vector<std::pair<unsigned char *, unsigned long> > mitk::CompressedImageContainer::m_ByteBuffers
protected

one for each timestep. first = pointer to compressed data; second = size of buffer in bytes

Definition at line 73 of file mitkCompressedImageContainer.h.

Referenced by GetImage(), SetImage(), and ~CompressedImageContainer().

◆ m_ImageDimension

unsigned int mitk::CompressedImageContainer::m_ImageDimension
protected

Definition at line 65 of file mitkCompressedImageContainer.h.

Referenced by GetImage(), and SetImage().

◆ m_ImageDimensions

std::vector<unsigned int> mitk::CompressedImageContainer::m_ImageDimensions
protected

Definition at line 66 of file mitkCompressedImageContainer.h.

Referenced by GetImage(), and SetImage().

◆ m_ImageGeometry

BaseGeometry::Pointer mitk::CompressedImageContainer::m_ImageGeometry
protected

Definition at line 75 of file mitkCompressedImageContainer.h.

Referenced by GetImage(), and SetImage().

◆ m_NumberOfTimeSteps

unsigned int mitk::CompressedImageContainer::m_NumberOfTimeSteps
protected

Definition at line 70 of file mitkCompressedImageContainer.h.

Referenced by SetImage().

◆ m_OneTimeStepImageSizeInBytes

unsigned long mitk::CompressedImageContainer::m_OneTimeStepImageSizeInBytes
protected

Definition at line 68 of file mitkCompressedImageContainer.h.

Referenced by GetImage(), and SetImage().

◆ m_PixelType

PixelType* mitk::CompressedImageContainer::m_PixelType
protected

Definition at line 63 of file mitkCompressedImageContainer.h.

Referenced by GetImage(), SetImage(), and ~CompressedImageContainer().


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