vtkLZ4Compressor Class Reference

Image compressor/decompressor that uses LZ4 for fast lossless compression. More...

#include <vtkLZ4Compressor.h>

Inheritance diagram for vtkLZ4Compressor:

Collaboration diagram for vtkLZ4Compressor:

Public Types
typedef vtkImageCompressor	Superclass
Public Types inherited from vtkImageCompressor
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetQuality (int)
	Set the quality measure. More...
virtual int	GetQuality ()
	Set the quality measure. More...
virtual int	Compress ()
	Compress/Decompress data array on the objects input with results in the objects output. More...
virtual int	Decompress ()
	Compress/Decompress data array on the objects input with results in the objects output. More...
virtual void	SaveConfiguration (vtkMultiProcessStream *stream)
	Serialize/Restore compressor configuration (but not the data) into the stream. More...
virtual bool	RestoreConfiguration (vtkMultiProcessStream *stream)
	Serialize/Restore compressor configuration (but not the data) into the stream. More...
virtual const char *	SaveConfiguration ()
	Serialize/Restore compressor configuration (but not the data) into the stream. More...
virtual const char *	RestoreConfiguration (const char *stream)
	Serialize/Restore compressor configuration (but not the data) into the stream. More...
Public Member Functions inherited from vtkImageCompressor
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetInput (vtkUnsignedCharArray *input)
	Get/Set the input to this compressor. More...
virtual vtkUnsignedCharArray *	GetInput ()
	Get/Set the input to this compressor. More...
virtual vtkUnsignedCharArray *	GetOutput ()
	Get/Set the output of the compressor. More...
void	SetOutput (vtkUnsignedCharArray *)
	Get/Set the output of the compressor. More...
virtual void	SetLossLessMode (int)
	When set the implementation must use loss-less compression, otherwise implemnetation should user provided settings. More...
virtual int	GetLossLessMode ()
	When set the implementation must use loss-less compression, otherwise implemnetation should user provided settings. More...

Static Public Member Functions
static vtkLZ4Compressor *	New ()
static int	IsTypeOf (const char *type)
static vtkLZ4Compressor *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkImageCompressor
static int	IsTypeOf (const char *type)
static vtkImageCompressor *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkLZ4Compressor ()
	~vtkLZ4Compressor ()
Protected Member Functions inherited from vtkImageCompressor
virtual void	SetConfiguration (const char *)
	vtkImageCompressor ()
	Construct with NULL input array and empty but allocated output array. More...
virtual	~vtkImageCompressor ()
	Construct with NULL input array and empty but allocated output array. More...

Protected Attributes
int	Quality
Protected Attributes inherited from vtkImageCompressor
vtkUnsignedCharArray *	Output
vtkUnsignedCharArray *	Input
int	LossLessMode
char *	Configuration

Detailed Description

Image compressor/decompressor that uses LZ4 for fast lossless compression.

vtkLZ4Compressor uses LZ4 for fast lossless compression and decompression on data.

Definition at line 33 of file vtkLZ4Compressor.h.

Member Typedef Documentation

Superclass

typedef vtkImageCompressor vtkLZ4Compressor::Superclass

Definition at line 37 of file vtkLZ4Compressor.h.

Constructor & Destructor Documentation

vtkLZ4Compressor()

vtkLZ4Compressor::vtkLZ4Compressor ( )

protected

~vtkLZ4Compressor()

vtkLZ4Compressor::~vtkLZ4Compressor ( )

protected

Member Function Documentation

New()

static vtkLZ4Compressor* vtkLZ4Compressor::New ( )

static

GetClassName()

virtual const char* vtkLZ4Compressor::GetClassName ( )

virtual

Reimplemented from vtkImageCompressor.

IsTypeOf()

static int vtkLZ4Compressor::IsTypeOf ( const char *  type )

static

IsA()

virtual int vtkLZ4Compressor::IsA ( const char *  type )

virtual

Reimplemented from vtkImageCompressor.

SafeDownCast()

static vtkLZ4Compressor* vtkLZ4Compressor::SafeDownCast ( vtkObject *  o )

static

PrintSelf()

void vtkLZ4Compressor::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

SetQuality()

virtual void vtkLZ4Compressor::SetQuality ( int  )

virtual

Set the quality measure.

The value can be between 0 and 5. 0 means preserve input image quality while 5 means improve compression at the cost of image quality. For quality values > 1, we use a color mask on the input colors similar to vtkSquirtCompressor.

GetQuality()

virtual int vtkLZ4Compressor::GetQuality ( )

virtual

Set the quality measure.

The value can be between 0 and 5. 0 means preserve input image quality while 5 means improve compression at the cost of image quality. For quality values > 1, we use a color mask on the input colors similar to vtkSquirtCompressor.

Compress()

virtual int vtkLZ4Compressor::Compress ( )

virtual

Compress/Decompress data array on the objects input with results in the objects output.

See also Set/GetInput/Output.

Implements vtkImageCompressor.

Decompress()

virtual int vtkLZ4Compressor::Decompress ( )

virtual

Compress/Decompress data array on the objects input with results in the objects output.

See also Set/GetInput/Output.

Implements vtkImageCompressor.

SaveConfiguration() [1/2]

virtual void vtkLZ4Compressor::SaveConfiguration ( vtkMultiProcessStream *  stream )

virtual

Serialize/Restore compressor configuration (but not the data) into the stream.

Reimplemented from vtkImageCompressor.

RestoreConfiguration() [1/2]

virtual bool vtkLZ4Compressor::RestoreConfiguration ( vtkMultiProcessStream *  stream )

virtual

Serialize/Restore compressor configuration (but not the data) into the stream.

Reimplemented from vtkImageCompressor.

SaveConfiguration() [2/2]

virtual const char* vtkLZ4Compressor::SaveConfiguration ( )

virtual

Serialize/Restore compressor configuration (but not the data) into the stream.

Reimplemented from vtkImageCompressor.

RestoreConfiguration() [2/2]

virtual const char* vtkLZ4Compressor::RestoreConfiguration ( const char *  stream )

virtual

Serialize/Restore compressor configuration (but not the data) into the stream.

Reimplemented from vtkImageCompressor.

Member Data Documentation

Quality

int vtkLZ4Compressor::Quality

protected

Definition at line 74 of file vtkLZ4Compressor.h.

---

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

• /builddir/build/BUILD/ParaView-v5.2.0/ParaViewCore/VTKExtensions/Rendering/vtkLZ4Compressor.h