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 Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase 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 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 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)
 
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformationGetInputPortInformation (int port)
 
vtkInformationGetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformationGetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 
vtkDataObjectGetInputDataObject (int port, int connection)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char 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)
 
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)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

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)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObject *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyPRESERVES_DATASET ()
 
static vtkInformationIntegerKeyPRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKeyPRESERVES_BOUNDS ()
 
static vtkInformationIntegerKeyPRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKeyPRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKeyPRESERVES_RANGES ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *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

 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 Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
virtual void SetNumberOfInputPorts (int n)
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 
virtual vtkExecutiveCreateDefaultExecutive ()
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetErrorCode (unsigned long)
 
- 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 &os)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkMultiThreaderThreader
 
int Bypass
 
int BypassWasOn
 
int NumberOfThreads
 
char * InputScalarsSelection
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 
- Friends inherited from vtkObject

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 *  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 vtkImageSource.

static vtkImageToImageFilter* vtkImageToImageFilter::SafeDownCast ( vtkObject o)
static
void vtkImageToImageFilter::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 vtkImageSource.

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  port,
vtkInformation info 
)
protectedvirtual

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

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: