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

#include <vtkLZ4Compressor.h>

Inheritance diagram for vtkLZ4Compressor:

Collaboration diagram for vtkLZ4Compressor:

[legend]

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) override


virtual void	SetQuality (int)
	Set the quality measure. More...

virtual int	GetQuality ()
	Set the quality measure. More...


int	Compress () override
	Compress/Decompress data array on the objects input with results in the objects output. More...

int	Decompress () override
	Compress/Decompress data array on the objects input with results in the objects output. More...


void	SaveConfiguration (vtkMultiProcessStream *stream) override
	Serialize/Restore compressor configuration (but not the data) into the stream. More...

bool	RestoreConfiguration (vtkMultiProcessStream *stream) override
	Serialize/Restore compressor configuration (but not the data) into the stream. More...

const char *	SaveConfiguration () override
	Serialize/Restore compressor configuration (but not the data) into the stream. More...

const char *	RestoreConfiguration (const char *stream) override
	Serialize/Restore compressor configuration (but not the data) into the stream. More...

Public Member Functions inherited from vtkImageCompressor
virtual void	SetImageResolution (int width, int height)
	Communicates the next expected image resolution. More...

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...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

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)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkLZ4Compressor ()

	~vtkLZ4Compressor () override

Protected Member Functions inherited from vtkImageCompressor
virtual void	SetConfiguration (const char *)

	vtkImageCompressor ()
	Construct with nullptr input array and empty but allocated output array. More...

	~vtkImageCompressor () override
	Construct with nullptr input array and empty but allocated output array. More...

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	Quality

Protected Attributes inherited from vtkImageCompressor
vtkUnsignedCharArray *	Output

vtkUnsignedCharArray *	Input

int	LossLessMode

char *	Configuration

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 21 of file vtkLZ4Compressor.h.

Member Typedef Documentation

◆ Superclass

typedef vtkImageCompressor vtkLZ4Compressor::Superclass

Definition at line 25 of file vtkLZ4Compressor.h.

Constructor & Destructor Documentation

◆ vtkLZ4Compressor()

vtkLZ4Compressor::vtkLZ4Compressor ( )

protected

◆ ~vtkLZ4Compressor()

vtkLZ4Compressor::~vtkLZ4Compressor ( )

overrideprotected

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
	)

overridevirtual

Reimplemented from vtkImageCompressor.

◆ 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()

int vtkLZ4Compressor::Compress ( )

overridevirtual

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

◆ Decompress()

int vtkLZ4Compressor::Decompress ( )

overridevirtual

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

◆ SaveConfiguration() [1/2]

void vtkLZ4Compressor::SaveConfiguration ( vtkMultiProcessStream * stream )

overridevirtual

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

Reimplemented from vtkImageCompressor.

◆ RestoreConfiguration() [1/2]

bool vtkLZ4Compressor::RestoreConfiguration ( vtkMultiProcessStream * stream )

overridevirtual

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

Reimplemented from vtkImageCompressor.

◆ SaveConfiguration() [2/2]

const char* vtkLZ4Compressor::SaveConfiguration ( )

overridevirtual

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

Reimplemented from vtkImageCompressor.

◆ RestoreConfiguration() [2/2]

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

overridevirtual

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 62 of file vtkLZ4Compressor.h.

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

/builds/gitlab-kitware-sciviz-ci/VTKExtensions/FiltersRendering/vtkLZ4Compressor.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkLZ4Compressor()

◆ ~vtkLZ4Compressor()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetQuality()

◆ GetQuality()

◆ Compress()

◆ Decompress()

◆ SaveConfiguration() [1/2]

◆ RestoreConfiguration() [1/2]

◆ SaveConfiguration() [2/2]

◆ RestoreConfiguration() [2/2]

Member Data Documentation

◆ Quality