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.

Examples:: vtkImageGradient (Examples)

Tests:: vtkImageGradient (Tests)

Definition at line 36 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 ()
Static Public Member Functions
static vtkImageGradient *	New ()
static int	IsTypeOf (const char *type)
static vtkImageGradient *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkImageGradient ()
	~vtkImageGradient ()
virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
void	ThreadedRequestData (vtkInformation , vtkInformationVector , vtkInformationVector , vtkImageData *inData, vtkImageData outData, int outExt[6], int threadId)
Protected Attributes
int	HandleBoundaries
int	Dimensionality

Member Typedef Documentation

typedef vtkThreadedImageAlgorithm vtkImageGradient::Superclass

Reimplemented from vtkThreadedImageAlgorithm.

Definition at line 40 of file vtkImageGradient.h.

Constructor & Destructor Documentation

vtkImageGradient::vtkImageGradient ( ) [protected]

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

Definition at line 61 of file vtkImageGradient.h.

Member Function Documentation

static 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.

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

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

static 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]

Get/Set whether to handle boundaries. If enabled, boundary pixels are treated as duplicated so that central differencing works for the boundary pixels. If disabled, the output whole extent of the image is reduced by one pixel.

virtual int vtkImageGradient::GetHandleBoundaries ( ) [virtual]

Get/Set whether to handle boundaries. If enabled, boundary pixels are treated as duplicated so that central differencing works for the boundary pixels. If disabled, the output whole extent of the image is reduced by one pixel.

virtual void vtkImageGradient::HandleBoundariesOn ( ) [virtual]

Get/Set whether to handle boundaries. If enabled, boundary pixels are treated as duplicated so that central differencing works for the boundary pixels. If disabled, the output whole extent of the image is reduced by one pixel.

virtual void vtkImageGradient::HandleBoundariesOff ( ) [virtual]

Get/Set whether to handle boundaries. If enabled, boundary pixels are treated as duplicated so that central differencing works for the boundary pixels. If disabled, the output whole extent of the image is reduced by one pixel.

virtual int vtkImageGradient::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			`[protected, virtual]`

Reimplemented from vtkImageAlgorithm.

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

Reimplemented from vtkImageAlgorithm.

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

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

Reimplemented from vtkThreadedImageAlgorithm.

void vtkImageGradient::ThreadedRequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector,
		vtkImageData ***	inData,
		vtkImageData **	outData,
		int	extent[6],
		int	threadId
	)			`[protected, virtual]`

If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method. It is public so that the thread functions can call this method.

Reimplemented from vtkThreadedImageAlgorithm.