vtkSimpleImageToImageFilter Class Reference

#include <vtkSimpleImageToImageFilter.h>

Inheritance diagram for vtkSimpleImageToImageFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkSimpleImageToImageFilter:

Collaboration graph
[legend]

List of all members.


Detailed Description

Generic image filter with one input.

vtkSimpleImageToImageFilter is a filter which aims to avoid much of the complexity associated with vtkImageAlgorithm (i.e. support for pieces, multi-threaded operation). If you need to write a simple image-image filter which operates on the whole input, use this as the superclass. The subclass has to provide only an execute method which takes input and output as arguments. Memory allocation is handled in vtkSimpleImageToImageFilter. Also, you are guaranteed to have a valid input in the Execute(input, output) method. By default, this filter requests it's input's whole extent and copies the input's information (spacing, whole extent etc...) to the output. If the output's setup is different (for example, if it performs some sort of sub-sampling), ExecuteInformation has to be overwritten. As an example of how this can be done, you can look at vtkImageShrink3D::ExecuteInformation. For a complete example which uses templates to support generic data types, see vtkSimpleImageToImageFilter.

See also:
vtkImageAlgorithm vtkSimpleImageFilterExample

Definition at line 44 of file vtkSimpleImageToImageFilter.h.


Public Types

typedef vtkImageAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

Static Public Member Functions

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

Protected Member Functions

 vtkSimpleImageToImageFilter ()
 ~vtkSimpleImageToImageFilter ()
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void SimpleExecute (vtkImageData *input, vtkImageData *output)=0

Member Typedef Documentation

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkSimpleImageFilterExample.

Definition at line 47 of file vtkSimpleImageToImageFilter.h.


Constructor & Destructor Documentation

vtkSimpleImageToImageFilter::vtkSimpleImageToImageFilter (  )  [protected]

vtkSimpleImageToImageFilter::~vtkSimpleImageToImageFilter (  )  [protected]


Member Function Documentation

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

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkSimpleImageFilterExample.

static int vtkSimpleImageToImageFilter::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 vtkImageAlgorithm.

Reimplemented in vtkSimpleImageFilterExample.

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

Reimplemented in vtkSimpleImageFilterExample.

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

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkSimpleImageFilterExample.

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

virtual int vtkSimpleImageToImageFilter::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkImageAlgorithm.

virtual int vtkSimpleImageToImageFilter::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkImageAlgorithm.

virtual void vtkSimpleImageToImageFilter::SimpleExecute ( vtkImageData input,
vtkImageData output 
) [protected, pure virtual]

Implemented in vtkSimpleImageFilterExample.


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

Generated on Wed Aug 24 12:06:16 2011 for VTK by  doxygen 1.5.6