ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkZlibImageCompressor Class Reference

Image compressor/decompressor using Zlib. More...

#include <vtkZlibImageCompressor.h>

Inheritance diagram for vtkZlibImageCompressor:
Inheritance graph
[legend]
Collaboration diagram for vtkZlibImageCompressor:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetLossLessMode (int mode)
virtual int Compress ()
virtual int Decompress ()
virtual void SaveConfiguration (vtkMultiProcessStream *stream)
virtual bool RestoreConfiguration (vtkMultiProcessStream *stream)
virtual const char * SaveConfiguration ()
virtual const char * RestoreConfiguration (const char *stream)
virtual void SetCompressionLevel (int)
virtual int GetCompressionLevel ()
void SetColorSpace (int csId)
int GetColorSpace ()
void SetStripAlpha (int status)
int GetStripAlpha ()

Static Public Member Functions

static vtkZlibImageCompressorNew ()
static int IsTypeOf (const char *type)
static vtkZlibImageCompressorSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkZlibImageCompressor ()
virtual ~vtkZlibImageCompressor ()

Detailed Description

Image compressor/decompressor using Zlib.

This class compresses Image data using Zlib. The compression level varies between 1 and 9, 1 being the fastest at the cost of the compression ratio, 9 producing the highest compression ratio at the cost of speed. Optionally color depth may be reduced and alpha stripped/restored.

Thanks:
SciberQuest Inc. contributed this class.

Definition at line 36 of file vtkZlibImageCompressor.h.


Constructor & Destructor Documentation

vtkZlibImageCompressor::vtkZlibImageCompressor ( ) [protected]
virtual vtkZlibImageCompressor::~vtkZlibImageCompressor ( ) [protected, virtual]

Member Function Documentation

static vtkZlibImageCompressor* vtkZlibImageCompressor::New ( ) [static]

Reimplemented from vtkObject.

virtual const char* vtkZlibImageCompressor::GetClassName ( ) [virtual]

Reimplemented from vtkImageCompressor.

static int vtkZlibImageCompressor::IsTypeOf ( const char *  type) [static]

Reimplemented from vtkImageCompressor.

virtual int vtkZlibImageCompressor::IsA ( const char *  type) [virtual]

Reimplemented from vtkImageCompressor.

static vtkZlibImageCompressor* vtkZlibImageCompressor::SafeDownCast ( vtkObject o) [static]

Reimplemented from vtkImageCompressor.

void vtkZlibImageCompressor::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Reimplemented from vtkImageCompressor.

virtual int vtkZlibImageCompressor::Compress ( ) [virtual]

Compress/Decompress data array on the objects input with results in the objects output. See also Set/GetInput/Output.

Implements vtkImageCompressor.

virtual int vtkZlibImageCompressor::Decompress ( ) [virtual]

Compress/Decompress data array on the objects input with results in the objects output. See also Set/GetInput/Output.

Implements vtkImageCompressor.

virtual void vtkZlibImageCompressor::SaveConfiguration ( vtkMultiProcessStream stream) [virtual]

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

Reimplemented from vtkImageCompressor.

virtual bool vtkZlibImageCompressor::RestoreConfiguration ( vtkMultiProcessStream stream) [virtual]

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

Reimplemented from vtkImageCompressor.

virtual const char* vtkZlibImageCompressor::SaveConfiguration ( ) [virtual]

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

Reimplemented from vtkImageCompressor.

virtual const char* vtkZlibImageCompressor::RestoreConfiguration ( const char *  stream) [virtual]

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

Reimplemented from vtkImageCompressor.

virtual void vtkZlibImageCompressor::SetCompressionLevel ( int  ) [virtual]

Set compression level. A setting of 1 is the fastest producing the smallest compression ratio while a setting of 9 is the slowest producing the highest compression ratio. Zlib is loss-less regardless of level however, setting SetColorSpaceReduction factor to a non zero value will cause internal pre-processor to reduce the color space prior to compression which can improve compression ratio realized.

virtual int vtkZlibImageCompressor::GetCompressionLevel ( ) [virtual]

Set compression level. A setting of 1 is the fastest producing the smallest compression ratio while a setting of 9 is the slowest producing the highest compression ratio. Zlib is loss-less regardless of level however, setting SetColorSpaceReduction factor to a non zero value will cause internal pre-processor to reduce the color space prior to compression which can improve compression ratio realized.

void vtkZlibImageCompressor::SetColorSpace ( int  csId)

Set to an integer between 0 and 5. This uses the same color space reduction as the squirt compressor. If set to 0 no colorspace reduction is performed.

int vtkZlibImageCompressor::GetColorSpace ( )

Set to an integer between 0 and 5. This uses the same color space reduction as the squirt compressor. If set to 0 no colorspace reduction is performed.

void vtkZlibImageCompressor::SetStripAlpha ( int  status)

Set to boolean value indicating whether alpha values should be stripped prior to compression. Stripping alpha values will reduce input to compressor by 1/4 and results in speed up in compressor run time and of course reduced image size. Stripped alpha value are reinstated to 0xff during decompress.

int vtkZlibImageCompressor::GetStripAlpha ( )

Set to boolean value indicating whether alpha values should be stripped prior to compression. Stripping alpha values will reduce input to compressor by 1/4 and results in speed up in compressor run time and of course reduced image size. Stripped alpha value are reinstated to 0xff during decompress.

virtual void vtkZlibImageCompressor::SetLossLessMode ( int  mode) [virtual]

When set the implementation must use loss-less compression, otherwise implemnetation should user provided settings.

Reimplemented from vtkImageCompressor.


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