Stores a compressed copy of a mitk::Image using LZ4 compression. More...

#include <mitkCompressedImageContainer.h>

Public Member Functions
	CompressedImageContainer ()
	Construct an empty container. More...

	~CompressedImageContainer ()
	Destructor. Frees all compressed data buffers. More...

	CompressedImageContainer (const CompressedImageContainer &)=delete

CompressedImageContainer &	operator= (const CompressedImageContainer &)=delete

void	CompressImage (const Image *image)
	Compress the given image and store the result internally. More...

Image::Pointer	DecompressImage () const
	Decompress the stored data and return a new Image. More...

Detailed Description

Stores a compressed copy of a mitk::Image using LZ4 compression.

This class compresses an MITK image slice-by-slice using the LZ4 algorithm and can reconstruct the original image from the compressed data. It is useful for keeping undo/redo snapshots of image data without consuming excessive memory.

The class is non-copyable; each instance owns its compressed buffer.

See also: mitk::Image

Definition at line 37 of file mitkCompressedImageContainer.h.

Constructor & Destructor Documentation

◆ CompressedImageContainer() [1/2]

mitk::CompressedImageContainer::CompressedImageContainer ( )

Construct an empty container.

◆ ~CompressedImageContainer()

mitk::CompressedImageContainer::~CompressedImageContainer ( )

Destructor. Frees all compressed data buffers.

◆ CompressedImageContainer() [2/2]

mitk::CompressedImageContainer::CompressedImageContainer ( const CompressedImageContainer & )

delete

Member Function Documentation

◆ CompressImage()

void mitk::CompressedImageContainer::CompressImage ( const Image * image )

Compress the given image and store the result internally.

Any previously stored compressed data is cleared before compression. The image is compressed slice-by-slice using the LZ4 algorithm.

Parameters

[in] image The image to compress. If nullptr, the container is cleared.

◆ DecompressImage()

Image::Pointer mitk::CompressedImageContainer::DecompressImage ( ) const

Decompress the stored data and return a new Image.

Reconstructs the full image from the internally stored compressed slices.

Returns: A newly created Image with the same pixel type, dimensions, and geometry as the originally compressed image, or nullptr if no data is stored.

◆ operator=()

CompressedImageContainer& mitk::CompressedImageContainer::operator= ( const CompressedImageContainer & )