VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkDataEncoder Class Reference

class used to compress/encode images using threads. More...

#include <vtkDataEncoder.h>

Inheritance diagram for vtkDataEncoder:
[legend]
Collaboration diagram for vtkDataEncoder:
[legend]

Public Types

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkDataEncoderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void Initialize ()
 
void PushAndTakeReference (vtkTypeUInt32 key, vtkImageData *&data, int quality)
 
bool GetLatestOutput (vtkTypeUInt32 key, vtkSmartPointer< vtkUnsignedCharArray > &data)
 
void Flush (vtkTypeUInt32 key)
 
const char * EncodeAsBase64Png (vtkImageData *img, int compressionLevel=5)
 
const char * EncodeAsBase64Jpg (vtkImageData *img, int quality=50)
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (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 *)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkDataEncoderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataEncoderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataEncoder ()
 
 ~vtkDataEncoder ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
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 &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

class used to compress/encode images using threads.

vtkDataEncoder is used to compress and encode images using threads. Multiple images can be pushed into the encoder for compression and encoding. We use a vtkTypeUInt32 as the key to identify different image pipes. The images in each pipe will be processed in parallel threads. The latest compressed and encoded image can be accessed using GetLatestOutput().

vtkDataEncoder uses a thread-pool to do the compression and encoding in parallel. Note that images may not come out of the vtkDataEncoder in the same order as they are pushed in, if an image pushed in at N-th location takes longer to compress and encode than that pushed in at N+1-th location or if it was pushed in before the N-th location was even taken up for encoding by the a thread in the thread pool.

Tests:
vtkDataEncoder (Tests)

Definition at line 45 of file vtkDataEncoder.h.

Member Typedef Documentation

Definition at line 49 of file vtkDataEncoder.h.

Constructor & Destructor Documentation

vtkDataEncoder::vtkDataEncoder ( )
protected
vtkDataEncoder::~vtkDataEncoder ( )
protected

Member Function Documentation

static vtkDataEncoder* vtkDataEncoder::New ( )
static
static int vtkDataEncoder::IsTypeOf ( const char *  type)
static
virtual int vtkDataEncoder::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkDataEncoder* vtkDataEncoder::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkDataEncoder::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkObject.

vtkDataEncoder* vtkDataEncoder::NewInstance ( ) const
void vtkDataEncoder::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

void vtkDataEncoder::Initialize ( )

Re-initializes the encoder. This will abort any on going encoding threads and clear internal data-structures.

void vtkDataEncoder::PushAndTakeReference ( vtkTypeUInt32  key,
vtkImageData *&  data,
int  quality 
)

Push an image into the encoder. It is not safe to modify the image after this point, including changing the reference counts for it. You may run into thread safety issues. Typically, the caller code will simply release reference to the data and stop using it. vtkDataEncoder takes over the reference for the image and will call vtkObject::UnRegister() on it when it's done.

bool vtkDataEncoder::GetLatestOutput ( vtkTypeUInt32  key,
vtkSmartPointer< vtkUnsignedCharArray > &  data 
)

Get access to the most-recent fully encoded result corresponding to the given key, if any. This methods returns true if the data obtained is the result from the most recent Push() for the key, if any. If this method returns false, it means that there's some image either being processed on pending processing.

void vtkDataEncoder::Flush ( vtkTypeUInt32  key)

Flushes the encoding pipe and blocks till the most recently pushed image for the particular key has been processed. This call will block. Once this method returns, caller can use GetLatestOutput(key) to access the processed output.

const char* vtkDataEncoder::EncodeAsBase64Png ( vtkImageData img,
int  compressionLevel = 5 
)

Take an image data and synchronously convert it to a base-64 encoded png.

const char* vtkDataEncoder::EncodeAsBase64Jpg ( vtkImageData img,
int  quality = 50 
)

Take an image data and synchronously convert it to a base-64 encoded jpg.


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