Main Page | Directories | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkImageAlgorithm Class Reference

#include <vtkImageAlgorithm.h>

Inheritance diagram for vtkImageAlgorithm:

Inheritance graph
[legend]
Collaboration diagram for vtkImageAlgorithm:

Collaboration graph
[legend]
List of all members.

Detailed Description

Generic algorithm superclass for image algs.

vtkImageToImageAlgorithm 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
Events:
vtkCommand::StartEvent vtkCommand::EndEvent
Created by:
  • Martin, Ken
CVS contributions (if > 5%):
  • Martin, Ken (100%)
CVS logs (CVSweb):
  • .h (/Filtering/vtkImageAlgorithm.h)
  • .cxx (/Filtering/vtkImageAlgorithm.cxx)

Definition at line 47 of file vtkImageAlgorithm.h.

Public Types

typedef vtkAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
vtkImageData * GetOutput ()
vtkImageData * GetOutput (int)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector *, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void AddInput (vtkDataObject *)
void AddInput (int, vtkDataObject *)

Static Public Member Functions

int IsTypeOf (const char *type)
vtkImageAlgorithm * SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageAlgorithm ()
 ~vtkImageAlgorithm ()
virtual void ExecuteInformation (vtkInformation *request, vtkInformationVector *inputVector, vtkInformationVector *outputVector)
virtual void RequestUpdateExtent (vtkInformation *, vtkInformationVector *, vtkInformationVector *)
virtual void RequestData (vtkInformation *request, vtkInformationVector *inputVector, vtkInformationVector *outputVector)
virtual void AllocateOutputData (vtkImageData *out, int *uExtent)
virtual vtkImageData * AllocateOutputData (vtkDataObject *out)
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual void SetInputScalarsSelection (const char *)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()

Protected Attributes

char * InputScalarsSelection

Member Typedef Documentation

typedef vtkAlgorithm vtkImageAlgorithm::Superclass
 

Reimplemented from vtkAlgorithm.

Reimplemented in vtkThreadedImageAlgorithm, vtkBooleanTexture, vtkExtractVOI, vtkImageCast, vtkImageConstantPad, vtkImageDivergence, vtkImageEllipsoidSource, vtkImageEuclideanToPolar, vtkImageExtractComponents, vtkImageGaussianSource, vtkImageGradient, vtkImageGradientMagnitude, vtkImageGridSource, vtkImageHSIToRGB, vtkImageHSVToRGB, vtkImageLogarithmicScale, vtkImageLogic, vtkImageLuminance, vtkImageMagnitude, vtkImageMandelbrotSource, vtkImageMaskBits, vtkImageMirrorPad, vtkImageNoiseSource, vtkImageNormalize, vtkImagePadFilter, vtkImageRGBToHSI, vtkImageRGBToHSV, vtkImageShiftScale, vtkImageSinusoidSource, vtkImageWrapPad, vtkTriangularTexture, vtkRendererSource, and vtkWindowToImageFilter.

Definition at line 50 of file vtkImageAlgorithm.h.

Constructor & Destructor Documentation

vtkImageAlgorithm::vtkImageAlgorithm (   )  [protected]
 

vtkImageAlgorithm::~vtkImageAlgorithm (   )  [protected]
 

Member Function Documentation

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

Reimplemented from vtkAlgorithm.

Reimplemented in vtkThreadedImageAlgorithm, vtkBooleanTexture, vtkExtractVOI, vtkImageCast, vtkImageConstantPad, vtkImageDivergence, vtkImageEllipsoidSource, vtkImageEuclideanToPolar, vtkImageExtractComponents, vtkImageGaussianSource, vtkImageGradient, vtkImageGradientMagnitude, vtkImageGridSource, vtkImageHSIToRGB, vtkImageHSVToRGB, vtkImageLogarithmicScale, vtkImageLogic, vtkImageLuminance, vtkImageMagnitude, vtkImageMandelbrotSource, vtkImageMaskBits, vtkImageMirrorPad, vtkImageNoiseSource, vtkImageNormalize, vtkImagePadFilter, vtkImageRGBToHSI, vtkImageRGBToHSV, vtkImageShiftScale, vtkImageSinusoidSource, vtkImageWrapPad, vtkTriangularTexture, vtkRendererSource, and vtkWindowToImageFilter.

int vtkImageAlgorithm::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkThreadedImageAlgorithm, vtkBooleanTexture, vtkExtractVOI, vtkImageCast, vtkImageConstantPad, vtkImageDivergence, vtkImageEllipsoidSource, vtkImageEuclideanToPolar, vtkImageExtractComponents, vtkImageGaussianSource, vtkImageGradient, vtkImageGradientMagnitude, vtkImageGridSource, vtkImageHSIToRGB, vtkImageHSVToRGB, vtkImageLogarithmicScale, vtkImageLogic, vtkImageLuminance, vtkImageMagnitude, vtkImageMandelbrotSource, vtkImageMaskBits, vtkImageMirrorPad, vtkImageNoiseSource, vtkImageNormalize, vtkImagePadFilter, vtkImageRGBToHSI, vtkImageRGBToHSV, vtkImageShiftScale, vtkImageSinusoidSource, vtkImageWrapPad, vtkTriangularTexture, vtkRendererSource, and vtkWindowToImageFilter.

virtual int vtkImageAlgorithm::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkThreadedImageAlgorithm, vtkBooleanTexture, vtkExtractVOI, vtkImageCast, vtkImageConstantPad, vtkImageDivergence, vtkImageEllipsoidSource, vtkImageEuclideanToPolar, vtkImageExtractComponents, vtkImageGaussianSource, vtkImageGradient, vtkImageGradientMagnitude, vtkImageGridSource, vtkImageHSIToRGB, vtkImageHSVToRGB, vtkImageLogarithmicScale, vtkImageLogic, vtkImageLuminance, vtkImageMagnitude, vtkImageMandelbrotSource, vtkImageMaskBits, vtkImageMirrorPad, vtkImageNoiseSource, vtkImageNormalize, vtkImagePadFilter, vtkImageRGBToHSI, vtkImageRGBToHSV, vtkImageShiftScale, vtkImageSinusoidSource, vtkImageWrapPad, vtkTriangularTexture, vtkRendererSource, and vtkWindowToImageFilter.

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

Reimplemented from vtkAlgorithm.

Reimplemented in vtkThreadedImageAlgorithm, vtkBooleanTexture, vtkExtractVOI, vtkImageCast, vtkImageConstantPad, vtkImageDivergence, vtkImageEllipsoidSource, vtkImageEuclideanToPolar, vtkImageExtractComponents, vtkImageGaussianSource, vtkImageGradient, vtkImageGradientMagnitude, vtkImageGridSource, vtkImageHSIToRGB, vtkImageHSVToRGB, vtkImageLogarithmicScale, vtkImageLogic, vtkImageLuminance, vtkImageMagnitude, vtkImageMandelbrotSource, vtkImageMaskBits, vtkImageMirrorPad, vtkImageNoiseSource, vtkImageNormalize, vtkImagePadFilter, vtkImageRGBToHSI, vtkImageRGBToHSV, vtkImageShiftScale, vtkImageSinusoidSource, vtkImageWrapPad, vtkTriangularTexture, vtkRendererSource, and vtkWindowToImageFilter.

void vtkImageAlgorithm::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 vtkAlgorithm.

Reimplemented in vtkThreadedImageAlgorithm, vtkBooleanTexture, vtkExtractVOI, vtkImageCast, vtkImageConstantPad, vtkImageEllipsoidSource, vtkImageEuclideanToPolar, vtkImageExtractComponents, vtkImageGaussianSource, vtkImageGradient, vtkImageGradientMagnitude, vtkImageGridSource, vtkImageHSIToRGB, vtkImageHSVToRGB, vtkImageLogarithmicScale, vtkImageLogic, vtkImageMandelbrotSource, vtkImageMaskBits, vtkImageNoiseSource, vtkImagePadFilter, vtkImageRGBToHSI, vtkImageRGBToHSV, vtkImageShiftScale, vtkImageSinusoidSource, vtkTriangularTexture, vtkRendererSource, and vtkWindowToImageFilter.

vtkImageData* vtkImageAlgorithm::GetOutput (   ) 
 

Get the output data object for a port on this algorithm.

vtkImageData* vtkImageAlgorithm::GetOutput (  int   ) 
 

Get the output data object for a port on this algorithm.

virtual int vtkImageAlgorithm::ProcessRequest (  vtkInformation *  ,
vtkInformationVector *  ,
vtkInformationVector * 
)  [virtual]
 

see vtkAlgorithm for details

Reimplemented from vtkAlgorithm.

void vtkImageAlgorithm::SetInput (  vtkDataObject *   ) 
 

Set an input of this algorithm.

Referenced by vtkImageLogic::SetInput1(), and vtkImageLogic::SetInput2().

void vtkImageAlgorithm::SetInput (  int  ,
vtkDataObject * 
) 
 

Set an input of this algorithm.

void vtkImageAlgorithm::AddInput (  vtkDataObject *   ) 
 

Add an input of this algorithm.

void vtkImageAlgorithm::AddInput (  int  ,
vtkDataObject * 
) 
 

Add an input of this algorithm.

virtual void vtkImageAlgorithm::ExecuteInformation (  vtkInformation *  request,
vtkInformationVector *  inputVector,
vtkInformationVector *  outputVector
)  [protected, virtual]
 

Reimplemented in vtkBooleanTexture, vtkExtractVOI, vtkImageCast, vtkImageDivergence, vtkImageEllipsoidSource, vtkImageExtractComponents, vtkImageGaussianSource, vtkImageGradient, vtkImageGradientMagnitude, vtkImageGridSource, vtkImageLuminance, vtkImageMagnitude, vtkImageMandelbrotSource, vtkImageNoiseSource, vtkImageNormalize, vtkImagePadFilter, vtkImageShiftScale, vtkImageSinusoidSource, vtkTriangularTexture, vtkRendererSource, and vtkWindowToImageFilter.

virtual void vtkImageAlgorithm::RequestUpdateExtent (  vtkInformation *  ,
vtkInformationVector *  ,
vtkInformationVector * 
)  [protected, virtual]
 

Reimplemented in vtkExtractVOI, vtkImageDivergence, vtkImageGradient, vtkImageGradientMagnitude, and vtkImagePadFilter.

virtual void vtkImageAlgorithm::RequestData (  vtkInformation *  request,
vtkInformationVector *  inputVector,
vtkInformationVector *  outputVector
)  [protected, virtual]
 

Reimplemented in vtkThreadedImageAlgorithm, vtkExtractVOI, and vtkRendererSource.

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

This method is the old style execute method

Reimplemented in vtkBooleanTexture, vtkImageEllipsoidSource, vtkImageGaussianSource, vtkImageGridSource, vtkImageMandelbrotSource, vtkImageNoiseSource, vtkImageSinusoidSource, vtkTriangularTexture, and vtkWindowToImageFilter.

virtual void vtkImageAlgorithm::Execute (   )  [protected, virtual]
 

This method is the old style execute method

virtual void vtkImageAlgorithm::AllocateOutputData (  vtkImageData *  out,
int *  uExtent
)  [protected, virtual]
 

virtual vtkImageData* vtkImageAlgorithm::AllocateOutputData (  vtkDataObject *  out  )  [protected, virtual]
 

virtual void vtkImageAlgorithm::CopyAttributeData (  vtkImageData *  in,
vtkImageData *  out
)  [protected, virtual]
 

virtual int vtkImageAlgorithm::FillOutputPortInformation (  int  port,
vtkInformation *  info
)  [protected, virtual]
 

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

Reimplemented from vtkAlgorithm.

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

virtual void vtkImageAlgorithm::SetInputScalarsSelection (  const char *   )  [protected, virtual]
 

Referenced by vtkImageGradientMagnitude::SelectInputScalars(), and vtkImageGradient::SelectInputScalars().

Member Data Documentation

char* vtkImageAlgorithm::InputScalarsSelection [protected]
 

Definition at line 114 of file vtkImageAlgorithm.h.

The documentation for this class was generated from the following file:
Generated on Tue Oct 5 08:46:21 2004 for VTK by Doxygen 1.3.8-20040913