vtkImageGradient Class Reference

#include <vtkImageGradient.h>

Inheritance diagram for vtkImageGradient:

[legend]Collaboration diagram for vtkImageGradient:

[legend]List of all members.

Detailed Description

Computes the gradient vector.

vtkImageGradient computes the gradient vector of an image. The vector results are stored as scalar components. The Dimensionality determines whether to perform a 2d or 3d gradient. The default is two dimensional XY gradient. OutputScalarType is always double. Gradient is computed using central differences.

Created by:

Law, Charles

CVS contributions (if > 5%):

Law, Charles (64%)
Martin, Ken (26%)

CVS logs (CVSweb):

.cxx (/Imaging/vtkImageGradient.cxx)
.h (/Imaging/vtkImageGradient.h)

Examples:: vtkImageGradient (Examples)

Tests:: vtkImageGradient (Tests)

Definition at line 48 of file vtkImageGradient.h.

Public Types

typedef vtkThreadedImageAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

virtual void SetDimensionality (int)

virtual int GetDimensionality ()

virtual void SetHandleBoundaries (int)

virtual int GetHandleBoundaries ()

virtual void HandleBoundariesOn ()

virtual void HandleBoundariesOff ()

virtual char * GetInputScalarsSelection ()

void SelectInputScalars (const char *fieldName)

Static Public Member Functions

vtkImageGradient * New ()

int IsTypeOf (const char *type)

vtkImageGradient * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkImageGradient ()

~vtkImageGradient ()

void ExecuteInformation (vtkInformation *, vtkInformationVector *, vtkInformationVector *)

void RequestUpdateExtent (vtkInformation *, vtkInformationVector *, vtkInformationVector *)

void ThreadedExecute (vtkImageData *inData, vtkImageData *outData, int extent[6], int id)

Protected Attributes

int HandleBoundaries

int Dimensionality

Member Typedef Documentation

typedef vtkThreadedImageAlgorithm vtkImageGradient::Superclass

Reimplemented from vtkThreadedImageAlgorithm.
Definition at line 53 of file vtkImageGradient.h.

Constructor & Destructor Documentation

vtkImageGradient::vtkImageGradient ( ) [protected]

vtkImageGradient::~vtkImageGradient ( ) [inline, protected]

Definition at line 81 of file vtkImageGradient.h.

Member Function Documentation

vtkImageGradient* vtkImageGradient::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkAlgorithm.

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

Reimplemented from vtkThreadedImageAlgorithm.

int vtkImageGradient::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 vtkThreadedImageAlgorithm.

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

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

Reimplemented from vtkThreadedImageAlgorithm.

void vtkImageGradient::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 vtkThreadedImageAlgorithm.

virtual void vtkImageGradient::SetDimensionality ( int ) [virtual]

Determines how the input is interpreted (set of 2d slices ...)

virtual int vtkImageGradient::GetDimensionality ( ) [virtual]

Determines how the input is interpreted (set of 2d slices ...)

virtual void vtkImageGradient::SetHandleBoundaries ( int ) [virtual]

If "HandleBoundariesOn" then boundary pixels are duplicated So central differences can get values.

virtual int vtkImageGradient::GetHandleBoundaries ( ) [virtual]

If "HandleBoundariesOn" then boundary pixels are duplicated So central differences can get values.

virtual void vtkImageGradient::HandleBoundariesOn ( ) [virtual]

If "HandleBoundariesOn" then boundary pixels are duplicated So central differences can get values.

virtual void vtkImageGradient::HandleBoundariesOff ( ) [virtual]

If "HandleBoundariesOn" then boundary pixels are duplicated So central differences can get values.

virtual char* vtkImageGradient::GetInputScalarsSelection ( ) [virtual]

If you want to compute the gradient of an arbitrary point scalar array, then set its name here. By default this in NULL and the filter will use the active scalar array.

void vtkImageGradient::SelectInputScalars ( const char * fieldName ) [inline]

If you want to compute the gradient of an arbitrary point scalar array, then set its name here. By default this in NULL and the filter will use the active scalar array.
Definition at line 75 of file vtkImageGradient.h.
References vtkImageAlgorithm::SetInputScalarsSelection().

void vtkImageGradient::ExecuteInformation ( vtkInformation * ,

vtkInformationVector * ,

vtkInformationVector *

) [protected, virtual]

Reimplemented from vtkImageAlgorithm.

void vtkImageGradient::RequestUpdateExtent ( vtkInformation * ,

vtkInformationVector * ,

vtkInformationVector *

) [protected, virtual]

Reimplemented from vtkImageAlgorithm.

void vtkImageGradient::ThreadedExecute ( vtkImageData * inData,

vtkImageData * outData,

int extent[6],

int id

) [protected, virtual]

Reimplemented from vtkThreadedImageAlgorithm.

Member Data Documentation

int vtkImageGradient::HandleBoundaries [protected]

Definition at line 83 of file vtkImageGradient.h.

int vtkImageGradient::Dimensionality [protected]

Definition at line 84 of file vtkImageGradient.h.

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

dox/Imaging/vtkImageGradient.h


Public Types
typedef vtkThreadedImageAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetDimensionality (int)
virtual int	GetDimensionality ()

virtual void	SetHandleBoundaries (int)
virtual int	GetHandleBoundaries ()
virtual void	HandleBoundariesOn ()
virtual void	HandleBoundariesOff ()

virtual char *	GetInputScalarsSelection ()
void	SelectInputScalars (const char *fieldName)
Static Public Member Functions
vtkImageGradient *	New ()
int	IsTypeOf (const char *type)
vtkImageGradient *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkImageGradient ()
	~vtkImageGradient ()
void	ExecuteInformation (vtkInformation , vtkInformationVector , vtkInformationVector *)
void	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector *)
void	ThreadedExecute (vtkImageData inData, vtkImageData outData, int extent[6], int id)
Protected Attributes
int	HandleBoundaries
int	Dimensionality