vtkImageGradientMagnitude Class Reference

#include <vtkImageGradientMagnitude.h>

Inheritance diagram for vtkImageGradientMagnitude:

[legend]Collaboration diagram for vtkImageGradientMagnitude:

[legend]List of all members.

Detailed Description

Computes magnitude of the gradient.

vtkImageGradientMagnitude computes the gradient magnitude of an image. Setting the dimensionality determines whether the gradient is computed on 2D images, or 3D volumes. The default is two dimensional XY images.

See also:: vtkImageGradient vtkImageMagnitude

Created by:

Law, Charles

CVS contributions (if > 5%):

Law, Charles (52%)
Martin, Ken (34%)

CVS logs (CVSweb):

.cxx (/Imaging/vtkImageGradientMagnitude.cxx)
.h (/Imaging/vtkImageGradientMagnitude.h)

Examples:: vtkImageGradientMagnitude (Examples)

Tests:: vtkImageGradientMagnitude (Tests)

Definition at line 50 of file vtkImageGradientMagnitude.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 SetHandleBoundaries (int)

virtual int GetHandleBoundaries ()

virtual void HandleBoundariesOn ()

virtual void HandleBoundariesOff ()

virtual void SetDimensionality (int)

virtual int GetDimensionality ()

virtual char * GetInputScalarsSelection ()

void SelectInputScalars (const char *fieldName)

Static Public Member Functions

vtkImageGradientMagnitude * New ()

int IsTypeOf (const char *type)

vtkImageGradientMagnitude * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkImageGradientMagnitude ()

~vtkImageGradientMagnitude ()

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 vtkImageGradientMagnitude::Superclass

Reimplemented from vtkThreadedImageAlgorithm.
Definition at line 54 of file vtkImageGradientMagnitude.h.

Constructor & Destructor Documentation

vtkImageGradientMagnitude::vtkImageGradientMagnitude ( ) [protected]

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

Definition at line 82 of file vtkImageGradientMagnitude.h.

Member Function Documentation

vtkImageGradientMagnitude* vtkImageGradientMagnitude::New ( ) [static]

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

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

Reimplemented from vtkThreadedImageAlgorithm.

int vtkImageGradientMagnitude::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 vtkImageGradientMagnitude::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.

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

Reimplemented from vtkThreadedImageAlgorithm.

void vtkImageGradientMagnitude::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 vtkImageGradientMagnitude::SetHandleBoundaries ( int ) [virtual]

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

virtual int vtkImageGradientMagnitude::GetHandleBoundaries ( ) [virtual]

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

virtual void vtkImageGradientMagnitude::HandleBoundariesOn ( ) [virtual]

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

virtual void vtkImageGradientMagnitude::HandleBoundariesOff ( ) [virtual]

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

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

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

virtual int vtkImageGradientMagnitude::GetDimensionality ( ) [virtual]

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

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

If you want to compute the gradient magnitude 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 vtkImageGradientMagnitude::SelectInputScalars ( const char * fieldName ) [inline]

If you want to compute the gradient magnitude 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 76 of file vtkImageGradientMagnitude.h.
References vtkImageAlgorithm::SetInputScalarsSelection().

void vtkImageGradientMagnitude::ExecuteInformation ( vtkInformation * ,

vtkInformationVector * ,

vtkInformationVector *

) [protected, virtual]

Reimplemented from vtkImageAlgorithm.

void vtkImageGradientMagnitude::RequestUpdateExtent ( vtkInformation * ,

vtkInformationVector * ,

vtkInformationVector *

) [protected, virtual]

Reimplemented from vtkImageAlgorithm.

void vtkImageGradientMagnitude::ThreadedExecute ( vtkImageData * inData,

vtkImageData * outData,

int extent[6],

int id

) [protected, virtual]

Reimplemented from vtkThreadedImageAlgorithm.

Member Data Documentation

int vtkImageGradientMagnitude::HandleBoundaries [protected]

Definition at line 84 of file vtkImageGradientMagnitude.h.

int vtkImageGradientMagnitude::Dimensionality [protected]

Definition at line 85 of file vtkImageGradientMagnitude.h.

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

dox/Imaging/vtkImageGradientMagnitude.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	SetHandleBoundaries (int)
virtual int	GetHandleBoundaries ()
virtual void	HandleBoundariesOn ()
virtual void	HandleBoundariesOff ()

virtual void	SetDimensionality (int)
virtual int	GetDimensionality ()

virtual char *	GetInputScalarsSelection ()
void	SelectInputScalars (const char *fieldName)
Static Public Member Functions
vtkImageGradientMagnitude *	New ()
int	IsTypeOf (const char *type)
vtkImageGradientMagnitude *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkImageGradientMagnitude ()
	~vtkImageGradientMagnitude ()
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