Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkImageMultipleInputFilter Class Reference

Generic filter that has N inputs. More...

#include <vtkImageMultipleInputFilter.h>

Inheritance diagram for vtkImageMultipleInputFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkImageMultipleInputFilter:

Collaboration graph
[legend]
List of all members.

Public Methods

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)
vtkImageData * GetInput (int num)
vtkImageData * GetInput ()
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 Methods

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

Protected Methods

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

Protected Attributes

vtkMultiThreader * Threader
int Bypass
int NumberOfThreads

Detailed Description

Generic filter that has N inputs.

Date:
2001/11/13 14:12:56
Revision:
1.49
Thanks:
Thanks to C. Charles Law who developed this class.
vtkImageMultipleInputFilter is a super class for filters that have any number of inputs. Steaming is not available in this class yet.

See also:
vtkImageToImageFilter vtkImageInPlaceFilter vtkImageTwoInputFilter vtkImageTwoOutputFilter

Definition at line 63 of file vtkImageMultipleInputFilter.h.

Constructor & Destructor Documentation

vtkImageMultipleInputFilter::vtkImageMultipleInputFilter (    )  [protected]
 

vtkImageMultipleInputFilter::~vtkImageMultipleInputFilter (    )  [protected]
 

Member Function Documentation

vtkImageMultipleInputFilter* vtkImageMultipleInputFilter::New (    )  [static]
 

Instantiate object with no start, end, or progress methods.

Reimplemented from vtkImageSource.

Reimplemented in vtkImageMultipleInputOutputFilter, vtkImageTwoInputFilter, vtkImageAppend, vtkImageAppendComponents, vtkImageBlend, vtkImageCheckerboard, vtkImageCorrelation, vtkImageDifference, vtkImageDotProduct, vtkImageLogic, vtkImageMask, vtkImageMathematics, and vtkImageNonMaximumSuppression.

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageSource.

Reimplemented in vtkImageMultipleInputOutputFilter, vtkImageTwoInputFilter, vtkImageAppend, vtkImageAppendComponents, vtkImageBlend, vtkImageCheckerboard, vtkImageCorrelation, vtkImageDifference, vtkImageDotProduct, vtkImageLogic, vtkImageMask, vtkImageMathematics, and vtkImageNonMaximumSuppression.

int vtkImageMultipleInputFilter::IsTypeOf (  const char *    type )  [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, vtkImageTwoInputFilter, vtkImageAppend, vtkImageAppendComponents, vtkImageBlend, vtkImageCheckerboard, vtkImageCorrelation, vtkImageDifference, vtkImageDotProduct, vtkImageLogic, vtkImageMask, vtkImageMathematics, and vtkImageNonMaximumSuppression.

virtual int vtkImageMultipleInputFilter::IsA (  const char *    type )  [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, vtkImageTwoInputFilter, vtkImageAppend, vtkImageAppendComponents, vtkImageBlend, vtkImageCheckerboard, vtkImageCorrelation, vtkImageDifference, vtkImageDotProduct, vtkImageLogic, vtkImageMask, vtkImageMathematics, and vtkImageNonMaximumSuppression.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageSource.

Reimplemented in vtkImageMultipleInputOutputFilter, vtkImageTwoInputFilter, vtkImageAppend, vtkImageAppendComponents, vtkImageBlend, vtkImageCheckerboard, vtkImageCorrelation, vtkImageDifference, vtkImageDotProduct, vtkImageLogic, vtkImageMask, vtkImageMathematics, and vtkImageNonMaximumSuppression.

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 vtkSource.

Reimplemented in vtkImageMultipleInputOutputFilter, vtkImageAppend, vtkImageBlend, vtkImageCheckerboard, vtkImageCorrelation, vtkImageDifference, vtkImageLogic, vtkImageMask, vtkImageMathematics, and vtkImageNonMaximumSuppression.

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

Set an Input of this filter.

Reimplemented in vtkImageDifference.

Referenced by vtkImageDifference::SetInput(), vtkImageAppendComponents::SetInput1(), and vtkImageAppendComponents::SetInput2().

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    id
)  [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, vtkImageAppend, vtkImageAppendComponents, vtkImageBlend, vtkImageCheckerboard, vtkImageCorrelation, vtkImageDifference, vtkImageDotProduct, vtkImageLogic, vtkImageMask, vtkImageMathematics, and vtkImageNonMaximumSuppression.

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]
 

Reimplemented in vtkImageMultipleInputOutputFilter, vtkImageAppend, vtkImageBlend, vtkImageCorrelation, vtkImageDifference, and vtkImageNonMaximumSuppression.

void vtkImageMultipleInputFilter::ExecuteData (  vtkDataObject *    out )  [protected]
 

Reimplemented in vtkImageMultipleInputOutputFilter, and vtkImageBlend.

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

Reimplemented from vtkSource.

Reimplemented in vtkImageMultipleInputOutputFilter, vtkImageAppend, vtkImageAppendComponents, vtkImageBlend, vtkImageCorrelation, vtkImageDifference, vtkImageDotProduct, vtkImageMask, vtkImageMathematics, and vtkImageNonMaximumSuppression.

Referenced by vtkImageNonMaximumSuppression::ExecuteInformation(), vtkImageMathematics::ExecuteInformation(), vtkImageMask::ExecuteInformation(), vtkImageDotProduct::ExecuteInformation(), vtkImageDifference::ExecuteInformation(), vtkImageCorrelation::ExecuteInformation(), vtkImageBlend::ExecuteInformation(), vtkImageAppendComponents::ExecuteInformation(), and vtkImageAppend::ExecuteInformation().

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

Reimplemented in vtkImageMultipleInputOutputFilter, vtkImageAppend, vtkImageAppendComponents, vtkImageBlend, vtkImageCorrelation, vtkImageDifference, vtkImageDotProduct, vtkImageMask, vtkImageMathematics, and vtkImageNonMaximumSuppression.

Definition at line 138 of file vtkImageMultipleInputFilter.h.

Member Data Documentation

vtkMultiThreader* vtkImageMultipleInputFilter::Threader [protected]
 

Definition at line 122 of file vtkImageMultipleInputFilter.h.

int vtkImageMultipleInputFilter::Bypass [protected]
 

Definition at line 123 of file vtkImageMultipleInputFilter.h.

int vtkImageMultipleInputFilter::NumberOfThreads [protected]
 

Definition at line 124 of file vtkImageMultipleInputFilter.h.

The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:31:02 2002 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001