VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkSimpleImageToImageFilter Class Referenceabstract

Generic image filter with one input. More...

#include <vtkSimpleImageToImageFilter.h>

Inheritance diagram for vtkSimpleImageToImageFilter:
[legend]
Collaboration diagram for vtkSimpleImageToImageFilter:
[legend]

Public Types

typedef vtkImageAlgorithm Superclass
 
- Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
- Public Member Functions inherited from vtkImageAlgorithm
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkDataObjectGetInput (int port)
 
vtkDataObjectGetInput ()
 
vtkImageData * GetImageDataInput (int port)
 
vtkImageData * GetOutput ()
 
vtkImageData * GetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void SetInput (vtkDataObject *)
 
void SetInput (int, vtkDataObject *)
 
virtual void AddInput (vtkDataObject *)
 
virtual void AddInput (int, vtkDataObject *)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static
vtkSimpleImageToImageFilter
SafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkImageAlgorithm
static int IsTypeOf (const char *type)
 
static vtkImageAlgorithmSafeDownCast (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
 
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 
 ~vtkImageAlgorithm ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual void CopyInputArrayAttributesToOutput (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, vtkInformationVector **inputVector)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual void ExecuteData (vtkDataObject *output)
 
virtual void Execute ()
 

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.

Member Typedef Documentation

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.

static int vtkSimpleImageToImageFilter::IsTypeOf ( const char *  type)
static
virtual int vtkSimpleImageToImageFilter::IsA ( const char *  type)
virtual

Reimplemented from vtkImageAlgorithm.

static vtkSimpleImageToImageFilter* vtkSimpleImageToImageFilter::SafeDownCast ( vtkObject o)
static
void vtkSimpleImageToImageFilter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual int vtkSimpleImageToImageFilter::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

Reimplemented from vtkImageAlgorithm.

virtual int vtkSimpleImageToImageFilter::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

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

Reimplemented from vtkImageAlgorithm.

virtual void vtkSimpleImageToImageFilter::SimpleExecute ( vtkImageData *  input,
vtkImageData *  output 
)
protectedpure virtual

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