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

Generic filter that has one input of type vtkImageData. More...

#include <vtkImageToImageFilter.h>

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

Public Types

typedef vtkImageSource Superclass
 
- Public Types inherited from vtkImageSource
typedef vtkSource Superclass
 
- Public Types inherited from vtkSource
typedef vtkProcessObject Superclass
 
- Public Types inherited from vtkProcessObject
typedef vtkAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetInputMemoryLimit (int)
 
long GetInputMemoryLimit ()
 
virtual void SetInput (vtkImageData *input)
 
vtkImageDataGetInput ()
 
void SetBypass (int)
 
void BypassOn ()
 
void BypassOff ()
 
virtual int GetBypass ()
 
virtual void ThreadedExecute (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)
 
- Public Member Functions inherited from vtkImageSource
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetOutput (vtkImageData *output)
 
vtkImageDataGetOutput ()
 
vtkImageDataGetOutput (int idx)
 
- Public Member Functions inherited from vtkSource
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Update ()
 
virtual void UpdateWholeExtent ()
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent (vtkDataObject *output)
 
virtual void TriggerAsynchronousUpdate ()
 
virtual void UpdateData (vtkDataObject *output)
 
void UnRegisterAllOutputs (void)
 
int GetOutputIndex (vtkDataObject *out)
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ReleaseDataFlagOff ()
 
vtkDataObject ** GetOutputs ()
 
virtual int GetNumberOfOutputs ()
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Public Member Functions inherited from vtkProcessObject
void PrintSelf (ostream &os, vtkIndent indent)
 
void SqueezeInputArray ()
 
void RemoveAllInputs ()
 
vtkDataObject ** GetInputs ()
 
int GetNumberOfInputs ()
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
virtual void SetNumberOfInputConnections (int port, int n)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkImageToImageFilterSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkImageSource
static int IsTypeOf (const char *type)
 
static vtkImageSourceSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSource
static int IsTypeOf (const char *type)
 
static vtkSourceSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkProcessObject
static int IsTypeOf (const char *type)
 
static vtkProcessObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkImageToImageFilter ()
 
 ~vtkImageToImageFilter ()
 
void ExecuteInformation ()
 
virtual void ExecuteInformation (vtkImageData *inData, vtkImageData *outData)
 
void ExecuteData (vtkDataObject *output)
 
virtual vtkImageDataAllocateOutputData (vtkDataObject *out)
 
void MultiThread (vtkImageData *input, vtkImageData *output)
 
void ComputeInputUpdateExtents (vtkDataObject *output)
 
virtual void ComputeInputUpdateExtent (int inExt[6], int outExt[6])
 
virtual void SetInputScalarsSelection (const char *)
 
virtual int FillInputPortInformation (int, vtkInformation *)
 
- Protected Member Functions inherited from vtkImageSource
 vtkImageSource ()
 
 ~vtkImageSource ()
 
void Execute ()
 
virtual void Execute (vtkImageData *data)
 
virtual int FillOutputPortInformation (int, vtkInformation *)
 
- Protected Member Functions inherited from vtkSource
 vtkSource ()
 
 ~vtkSource ()
 
virtual void MarkGeneratedOutputs (vtkDataObject *)
 
void SetNumberOfOutputs (int num)
 
vtkDataObjectGetOutput (int idx)
 
virtual void SetNthOutput (int num, vtkDataObject *output)
 
virtual void AddOutput (vtkDataObject *output)
 
virtual void RemoveOutput (vtkDataObject *output)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
int FillOutputPortInformation (int, vtkInformation *)
 
virtual void SetNumberOfOutputPorts (int n)
 
- Protected Member Functions inherited from vtkProcessObject
void SetNumberOfInputs (int num)
 
virtual void SetNthInput (int num, vtkDataObject *input)
 
virtual void AddInput (vtkDataObject *input)
 
virtual void RemoveInput (vtkDataObject *input)
 
void AddInputInternal (vtkDataObject *input)
 
void RemoveInputInternal (vtkDataObject *input)
 
void SetupInputs ()
 
 vtkProcessObject ()
 
 ~vtkProcessObject ()
 

Protected Attributes

vtkMultiThreaderThreader
 
int Bypass
 
int BypassWasOn
 
int NumberOfThreads
 
char * InputScalarsSelection
 
- Protected Attributes inherited from vtkSource
vtkDataObject ** Outputs
 
int NumberOfOutputs
 
int Updating
 
vtkTimeStamp InformationTime
 
- Protected Attributes inherited from vtkProcessObject
int NumberOfInputs
 
int NumberOfRequiredInputs
 
vtkDataObject ** Inputs
 

Detailed Description

Generic filter that has one input of type vtkImageData.

vtkImageToImageFilter 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 vtkSimpleImageToImageFilter instead.

Warning
This used to be the parent class for most imaging filter in VTK4.x, now this role has been replaced by vtkImageAlgorithm. You should consider using vtkImageAlgorithm instead, when writing filter for VTK5 and above. This class was kept to ensure full backward compatibility.
See also
vtkSimpleImageToImageFilter vtkImageSpatialFilter vtkImageAlgorithm

Definition at line 39 of file vtkImageToImageFilter.h.

Member Typedef Documentation

Definition at line 42 of file vtkImageToImageFilter.h.

Constructor & Destructor Documentation

vtkImageToImageFilter::vtkImageToImageFilter ( )
protected
vtkImageToImageFilter::~vtkImageToImageFilter ( )
protected

Member Function Documentation

virtual const char* vtkImageToImageFilter::GetClassName ( )
virtual

Reimplemented from vtkImageSource.

static int vtkImageToImageFilter::IsTypeOf ( const char *  type)
static
virtual int vtkImageToImageFilter::IsA ( const char *  type)
virtual

Reimplemented from vtkImageSource.

static vtkImageToImageFilter* vtkImageToImageFilter::SafeDownCast ( vtkObject o)
static
void vtkImageToImageFilter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkImageToImageFilter::SetInput ( vtkImageData input)
virtual

Set the Input of a filter.

vtkImageData* vtkImageToImageFilter::GetInput ( )

Set the Input of a filter.

void vtkImageToImageFilter::SetBypass ( int  )
inline

Obsolete feature - do not use.

Definition at line 53 of file vtkImageToImageFilter.h.

void vtkImageToImageFilter::BypassOn ( )
inline

Obsolete feature - do not use.

Definition at line 54 of file vtkImageToImageFilter.h.

void vtkImageToImageFilter::BypassOff ( )
inline

Obsolete feature - do not use.

Definition at line 55 of file vtkImageToImageFilter.h.

virtual int vtkImageToImageFilter::GetBypass ( )
virtual

Obsolete feature - do not use.

virtual void vtkImageToImageFilter::ThreadedExecute ( 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 vtkImageToImageFilter::SetNumberOfThreads ( int  )
virtual

Get/Set the number of threads to create when rendering

virtual int vtkImageToImageFilter::GetNumberOfThreads ( )
virtual

Get/Set the number of threads to create when rendering

void vtkImageToImageFilter::SetInputMemoryLimit ( int  )
inline

Definition at line 75 of file vtkImageToImageFilter.h.

long vtkImageToImageFilter::GetInputMemoryLimit ( )
inline

Definition at line 77 of file vtkImageToImageFilter.h.

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

Putting this here until I merge graphics and imaging streaming.

void vtkImageToImageFilter::ExecuteInformation ( )
protectedvirtual

Reimplemented from vtkSource.

virtual void vtkImageToImageFilter::ExecuteInformation ( vtkImageData inData,
vtkImageData outData 
)
protectedvirtual
void vtkImageToImageFilter::ExecuteData ( vtkDataObject output)
protectedvirtual

This method is the one that should be used by subclasses, right now the default implementation is to call the backwards compatibility method

Reimplemented from vtkSource.

virtual vtkImageData* vtkImageToImageFilter::AllocateOutputData ( vtkDataObject out)
protectedvirtual

Reimplemented from vtkImageSource.

void vtkImageToImageFilter::MultiThread ( vtkImageData input,
vtkImageData output 
)
protected
void vtkImageToImageFilter::ComputeInputUpdateExtents ( vtkDataObject output)
protectedvirtual

What is the input update extent that is required to produce the desired output? By default, the whole input is always required but this is overridden in many subclasses.

Reimplemented from vtkSource.

virtual void vtkImageToImageFilter::ComputeInputUpdateExtent ( int  inExt[6],
int  outExt[6] 
)
protectedvirtual
virtual void vtkImageToImageFilter::SetInputScalarsSelection ( const char *  )
protectedvirtual
virtual int vtkImageToImageFilter::FillInputPortInformation ( int  ,
vtkInformation  
)
protectedvirtual

Reimplemented from vtkProcessObject.

Member Data Documentation

vtkMultiThreader* vtkImageToImageFilter::Threader
protected

Definition at line 90 of file vtkImageToImageFilter.h.

int vtkImageToImageFilter::Bypass
protected

Definition at line 91 of file vtkImageToImageFilter.h.

int vtkImageToImageFilter::BypassWasOn
protected

Definition at line 92 of file vtkImageToImageFilter.h.

int vtkImageToImageFilter::NumberOfThreads
protected

Definition at line 93 of file vtkImageToImageFilter.h.

char* vtkImageToImageFilter::InputScalarsSelection
protected

Definition at line 113 of file vtkImageToImageFilter.h.


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