class used to compress/encode images using threads. More...
#include <vtkDataEncoder.h>
Public Types | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual int | IsA (const char *type) |
| vtkDataEncoder * | NewInstance () 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) |
Static Public Member Functions | |
| static vtkDataEncoder * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkDataEncoder * | SafeDownCast (vtkObjectBase *o) |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkDataEncoder () | |
| ~vtkDataEncoder () | |
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 42 of file vtkDataEncoder.h.
Member Typedef Documentation
| typedef vtkObject vtkDataEncoder::Superclass |
Reimplemented from vtkObject.
Definition at line 46 of file vtkDataEncoder.h.
Constructor & Destructor Documentation
| vtkDataEncoder::vtkDataEncoder | ( | ) | [protected] |
| vtkDataEncoder::~vtkDataEncoder | ( | ) | [protected] |
Member Function Documentation
| static vtkDataEncoder* vtkDataEncoder::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
| static int vtkDataEncoder::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type 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.
| 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] |
Reimplemented from vtkObject.
| virtual vtkObjectBase* vtkDataEncoder::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkObject.
| vtkDataEncoder* vtkDataEncoder::NewInstance | ( | ) | const |
Reimplemented from vtkObject.
| void vtkDataEncoder::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
| 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.
The documentation for this class was generated from the following file:
- /Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Web/Core/vtkDataEncoder.h
