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

Generic filter that has one input.. More...

#include <vtkThreadedImageAlgorithm.h>

Inherits vtkImageAlgorithm.

Collaboration diagram for vtkThreadedImageAlgorithm:
[legend]

Public Types

typedef vtkImageAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void ThreadedExecute (vtkImageData *inData, vtkImageData *outData, int extent[6], int threadId)
 
virtual void ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int extent[6], int threadId)
 
virtual void SetNumberOfThreads (int)
 
virtual int GetNumberOfThreads ()
 
virtual int SplitExtent (int splitExt[6], int startExt[6], int num, int total)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkThreadedImageAlgorithmSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkThreadedImageAlgorithm ()
 
 ~vtkThreadedImageAlgorithm ()
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 

Protected Attributes

vtkMultiThreaderThreader
 
int NumberOfThreads
 

Detailed Description

Generic filter that has one input..

vtkThreadedImageAlgorithm is a filter superclass that hides much of the pipeline complexity. It handles breaking the pipeline execution into smaller extents so that the vtkImageData limits are observed. It also provides support for multithreading. If you don't need any of this functionality, consider using vtkSimpleImageToImageAlgorithm instead.

See Also
vtkSimpleImageToImageAlgorithm
Examples:
vtkThreadedImageAlgorithm (Examples)

Definition at line 38 of file vtkThreadedImageAlgorithm.h.

Member Typedef Documentation

typedef vtkImageAlgorithm vtkThreadedImageAlgorithm::Superclass

Definition at line 41 of file vtkThreadedImageAlgorithm.h.

Constructor & Destructor Documentation

vtkThreadedImageAlgorithm::vtkThreadedImageAlgorithm ( )
protected
vtkThreadedImageAlgorithm::~vtkThreadedImageAlgorithm ( )
protected

Member Function Documentation

virtual const char* vtkThreadedImageAlgorithm::GetClassName ( )
virtual
static int vtkThreadedImageAlgorithm::IsTypeOf ( const char *  type)
static
virtual int vtkThreadedImageAlgorithm::IsA ( const char *  type)
virtual
static vtkThreadedImageAlgorithm* vtkThreadedImageAlgorithm::SafeDownCast ( vtkObject o)
static
void vtkThreadedImageAlgorithm::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkThreadedImageAlgorithm::ThreadedRequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector,
vtkImageData ***  inData,
vtkImageData **  outData,
int  extent[6],
int  threadId 
)
virtual

If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method. It is public so that the thread functions can call this method.

virtual void vtkThreadedImageAlgorithm::ThreadedExecute ( vtkImageData *  inData,
vtkImageData *  outData,
int  extent[6],
int  threadId 
)
virtual
virtual void vtkThreadedImageAlgorithm::SetNumberOfThreads ( int  )
virtual

Get/Set the number of threads to create when rendering

virtual int vtkThreadedImageAlgorithm::GetNumberOfThreads ( )
virtual

Get/Set the number of threads to create when rendering

virtual int vtkThreadedImageAlgorithm::SplitExtent ( int  splitExt[6],
int  startExt[6],
int  num,
int  total 
)
virtual

Putting this here until I merge graphics and imaging streaming.

virtual int vtkThreadedImageAlgorithm::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Member Data Documentation

vtkMultiThreader* vtkThreadedImageAlgorithm::Threader
protected

Definition at line 78 of file vtkThreadedImageAlgorithm.h.

int vtkThreadedImageAlgorithm::NumberOfThreads
protected

Definition at line 79 of file vtkThreadedImageAlgorithm.h.


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