vtkImageMultipleInputFilter Class Reference

#include <vtkImageMultipleInputFilter.h>

Inheritance diagram for vtkImageMultipleInputFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkImageMultipleInputFilter:

Collaboration graph
[legend]

List of all members.


Detailed Description

Generic filter that has N inputs.

vtkImageMultipleInputFilter is a super class for filters that have any number of inputs. Streaming is not available in this class yet.

See also:
vtkImageToImageFilter vtkImageInPlaceFilter vtkImageTwoInputFilter

Definition at line 32 of file vtkImageMultipleInputFilter.h.


Public Types

typedef vtkImageSource Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetInput (int num, vtkImageData *input)
virtual void AddInput (vtkImageData *input)
virtual void RemoveInput (vtkImageData *input)
vtkImageDataGetInput (int num)
vtkImageDataGetInput ()
virtual void SetBypass (int)
virtual int GetBypass ()
virtual void BypassOn ()
virtual void BypassOff ()
virtual void SetNumberOfThreads (int)
virtual int GetNumberOfThreads ()
virtual int SplitExtent (int splitExt[6], int startExt[6], int num, int total)
virtual void ThreadedExecute (vtkImageData **inDatas, vtkImageData *outData, int extent[6], int threadId)

Static Public Member Functions

static int IsTypeOf (const char *type)
static
vtkImageMultipleInputFilter
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageMultipleInputFilter ()
 ~vtkImageMultipleInputFilter ()
void ComputeInputUpdateExtents (vtkDataObject *output)
virtual void ComputeInputUpdateExtent (int inExt[6], int outExt[6], int whichInput)
void ExecuteData (vtkDataObject *output)
void MultiThread (vtkImageData **indatas, vtkImageData *outdata)
void ExecuteInformation ()
virtual void ExecuteInformation (vtkImageData **, vtkImageData *)
virtual int FillInputPortInformation (int, vtkInformation *)

Protected Attributes

vtkMultiThreaderThreader
int Bypass
int NumberOfThreads

Member Typedef Documentation

Reimplemented from vtkImageSource.

Reimplemented in vtkImageMultipleInputOutputFilter, and vtkImageTwoInputFilter.

Definition at line 35 of file vtkImageMultipleInputFilter.h.


Constructor & Destructor Documentation

vtkImageMultipleInputFilter::vtkImageMultipleInputFilter (  )  [protected]

vtkImageMultipleInputFilter::~vtkImageMultipleInputFilter (  )  [protected]


Member Function Documentation

virtual const char* vtkImageMultipleInputFilter::GetClassName (  )  [virtual]

Reimplemented from vtkImageSource.

Reimplemented in vtkImageMultipleInputOutputFilter, and vtkImageTwoInputFilter.

static int vtkImageMultipleInputFilter::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 vtkImageSource.

Reimplemented in vtkImageMultipleInputOutputFilter, and vtkImageTwoInputFilter.

virtual int vtkImageMultipleInputFilter::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.

Reimplemented in vtkImageMultipleInputOutputFilter, and vtkImageTwoInputFilter.

static vtkImageMultipleInputFilter* vtkImageMultipleInputFilter::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkImageSource.

Reimplemented in vtkImageMultipleInputOutputFilter, and vtkImageTwoInputFilter.

void vtkImageMultipleInputFilter::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.

Reimplemented in vtkImageMultipleInputOutputFilter, and vtkImageTwoInputFilter.

virtual void vtkImageMultipleInputFilter::SetInput ( int  num,
vtkImageData input 
) [virtual]

Set an Input of this filter.

virtual void vtkImageMultipleInputFilter::AddInput ( vtkImageData input  )  [virtual]

Adds an input to the first null position in the input list. Expands the list memory if necessary

virtual void vtkImageMultipleInputFilter::RemoveInput ( vtkImageData input  )  [virtual]

Adds an input to the first null position in the input list. Expands the list memory if necessary

vtkImageData* vtkImageMultipleInputFilter::GetInput ( int  num  ) 

Get one input to this filter.

vtkImageData* vtkImageMultipleInputFilter::GetInput (  ) 

Get one input to this filter.

virtual void vtkImageMultipleInputFilter::SetBypass ( int   )  [virtual]

Turning bypass on will cause the filter to turn off and simply pass the data from the first input (input0) through. It is implemented for consistency with vtkImageToImageFilter.

virtual int vtkImageMultipleInputFilter::GetBypass (  )  [virtual]

Turning bypass on will cause the filter to turn off and simply pass the data from the first input (input0) through. It is implemented for consistency with vtkImageToImageFilter.

virtual void vtkImageMultipleInputFilter::BypassOn (  )  [virtual]

Turning bypass on will cause the filter to turn off and simply pass the data from the first input (input0) through. It is implemented for consistency with vtkImageToImageFilter.

virtual void vtkImageMultipleInputFilter::BypassOff (  )  [virtual]

Turning bypass on will cause the filter to turn off and simply pass the data from the first input (input0) through. It is implemented for consistency with vtkImageToImageFilter.

virtual void vtkImageMultipleInputFilter::SetNumberOfThreads ( int   )  [virtual]

Get/Set the number of threads to create when rendering

virtual int vtkImageMultipleInputFilter::GetNumberOfThreads (  )  [virtual]

Get/Set the number of threads to create when rendering

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

Putting this here until I merge graphics and imaging streaming.

virtual void vtkImageMultipleInputFilter::ThreadedExecute ( vtkImageData **  inDatas,
vtkImageData outData,
int  extent[6],
int  threadId 
) [virtual]

The execute method created by the subclass. This is kept public instead of protected since it is called from a non-member thread function.

Reimplemented in vtkImageMultipleInputOutputFilter.

void vtkImageMultipleInputFilter::ComputeInputUpdateExtents ( vtkDataObject output  )  [protected, virtual]

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.

Reimplemented in vtkImageMultipleInputOutputFilter.

virtual void vtkImageMultipleInputFilter::ComputeInputUpdateExtent ( int  inExt[6],
int  outExt[6],
int  whichInput 
) [protected, virtual]

void vtkImageMultipleInputFilter::ExecuteData ( vtkDataObject output  )  [protected, virtual]

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.

Reimplemented in vtkImageMultipleInputOutputFilter.

void vtkImageMultipleInputFilter::MultiThread ( vtkImageData **  indatas,
vtkImageData outdata 
) [protected]

void vtkImageMultipleInputFilter::ExecuteInformation (  )  [protected, virtual]

Reimplemented from vtkSource.

Reimplemented in vtkImageMultipleInputOutputFilter.

virtual void vtkImageMultipleInputFilter::ExecuteInformation ( vtkImageData **  ,
vtkImageData  
) [inline, protected, virtual]

Reimplemented in vtkImageMultipleInputOutputFilter.

Definition at line 107 of file vtkImageMultipleInputFilter.h.

virtual int vtkImageMultipleInputFilter::FillInputPortInformation ( int  port,
vtkInformation info 
) [protected, virtual]

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

Definition at line 90 of file vtkImageMultipleInputFilter.h.

Definition at line 91 of file vtkImageMultipleInputFilter.h.

Definition at line 92 of file vtkImageMultipleInputFilter.h.


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

Generated on Wed Aug 24 11:41:32 2011 for VTK by  doxygen 1.5.6