VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | 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 Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkDataEncoderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetMaxThreads (vtkTypeUInt32)
 Define the number of worker threads to use. More...
 
virtual vtkTypeUInt32 GetMaxThreads ()
 
void Initialize ()
 Re-initializes the encoder. More...
 
void PushAndTakeReference (vtkTypeUInt32 key, vtkImageData *&data, int quality, int encoding=1)
 Push an image into the encoder. More...
 
bool GetLatestOutput (vtkTypeUInt32 key, vtkSmartPointer< vtkUnsignedCharArray > &data)
 Get access to the most-recent fully encoded result corresponding to the given key, if any. More...
 
void Flush (vtkTypeUInt32 key)
 Flushes the encoding pipe and blocks till the most recently pushed image for the particular key has been processed. More...
 
const char * EncodeAsBase64Png (vtkImageData *img, int compressionLevel=5)
 Take an image data and synchronously convert it to a base-64 encoded png. More...
 
const char * EncodeAsBase64Jpg (vtkImageData *img, int quality=50)
 Take an image data and synchronously convert it to a base-64 encoded jpg. More...
 
void Finalize ()
 This method will wait for any running thread to terminate. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkDataEncoderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataEncoderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataEncoder ()
 
 ~vtkDataEncoder () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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

vtkTypeUInt32 MaxThreads
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > 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.

Definition at line 43 of file vtkDataEncoder.h.

Member Typedef Documentation

◆ Superclass

Definition at line 47 of file vtkDataEncoder.h.

Constructor & Destructor Documentation

◆ vtkDataEncoder()

vtkDataEncoder::vtkDataEncoder ( )
protected

◆ ~vtkDataEncoder()

vtkDataEncoder::~vtkDataEncoder ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkDataEncoder* vtkDataEncoder::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkDataEncoder::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

◆ SafeDownCast()

static vtkDataEncoder* vtkDataEncoder::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkDataEncoder::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkDataEncoder* vtkDataEncoder::NewInstance ( ) const

◆ PrintSelf()

void vtkDataEncoder::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ SetMaxThreads()

void vtkDataEncoder::SetMaxThreads ( vtkTypeUInt32  )

Define the number of worker threads to use.

Initialize() needs to be called after changing the thread count.

◆ GetMaxThreads()

virtual vtkTypeUInt32 vtkDataEncoder::GetMaxThreads ( )
virtual

◆ Initialize()

void vtkDataEncoder::Initialize ( )

Re-initializes the encoder.

This will abort any on going encoding threads and clear internal data-structures.

◆ PushAndTakeReference()

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

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. encoding can be set to 0 to skip encoding.

◆ GetLatestOutput()

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.

◆ Flush()

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.

◆ EncodeAsBase64Png()

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

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

◆ EncodeAsBase64Jpg()

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

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

◆ Finalize()

void vtkDataEncoder::Finalize ( )

This method will wait for any running thread to terminate.

Member Data Documentation

◆ MaxThreads

vtkTypeUInt32 vtkDataEncoder::MaxThreads
protected

Definition at line 110 of file vtkDataEncoder.h.


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