vtkImageCorrelation Class Reference

Correlation imageof the two inputs. More...

#include <vtkImageCorrelation.h>

Inheritance diagram for vtkImageCorrelation:

Collaboration diagram for vtkImageCorrelation:

List of all members.

Public Types
typedef vtkThreadedImageAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkImageCorrelation *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetInput1Data (vtkDataObject *in)
virtual void	SetInput2Data (vtkDataObject *in)
virtual void	SetDimensionality (int)
virtual int	GetDimensionality ()
Static Public Member Functions
static vtkImageCorrelation *	New ()
static int	IsTypeOf (const char *type)
static vtkImageCorrelation *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImageCorrelation ()
	~vtkImageCorrelation ()
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void	ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int extent[6], int threadId)
Protected Attributes
int	Dimensionality

---

Detailed Description

Correlation imageof the two inputs.

vtkImageCorrelation finds the correlation between two data sets. SetDimensionality determines whether the Correlation will be 3D, 2D or 1D. The default is a 2D Correlation. The Output type will be double. The output size will match the size of the first input. The second input is considered the correlation kernel.

Tests:

vtkImageCorrelation (Tests)

Definition at line 37 of file vtkImageCorrelation.h.

---

Member Typedef Documentation

typedef vtkThreadedImageAlgorithm vtkImageCorrelation::Superclass

Reimplemented from vtkThreadedImageAlgorithm.

Definition at line 41 of file vtkImageCorrelation.h.

---

Constructor & Destructor Documentation

vtkImageCorrelation::vtkImageCorrelation

(

)

[protected]

vtkImageCorrelation::~vtkImageCorrelation

(

)

[inline, protected]

Definition at line 59 of file vtkImageCorrelation.h.

---

Member Function Documentation

static vtkImageCorrelation* vtkImageCorrelation::New

(

)

[static]

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

Reimplemented from vtkAlgorithm.

static int vtkImageCorrelation::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 vtkImageCorrelation::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 vtkImageCorrelation* vtkImageCorrelation::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkThreadedImageAlgorithm.

virtual vtkObjectBase* vtkImageCorrelation::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkThreadedImageAlgorithm.

vtkImageCorrelation* vtkImageCorrelation::NewInstance

(

)

const

Reimplemented from vtkThreadedImageAlgorithm.

void vtkImageCorrelation::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 vtkImageCorrelation::SetDimensionality

(

int

)

[virtual]

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

virtual int vtkImageCorrelation::GetDimensionality

(

)

[virtual]

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

virtual void vtkImageCorrelation::SetInput1Data

(

vtkDataObject *

in

)

[inline, virtual]

Set the input image.

Definition at line 52 of file vtkImageCorrelation.h.

virtual void vtkImageCorrelation::SetInput2Data

(

vtkDataObject *

in

)

[inline, virtual]

Set the correlation kernel.

Definition at line 55 of file vtkImageCorrelation.h.

virtual int vtkImageCorrelation::RequestInformation	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		[protected, virtual]

Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.

Reimplemented from vtkImageAlgorithm.

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

Subclasses can reimplement this method to translate the update extent requests from each output port into update extent requests for the input connections.

Reimplemented from vtkImageAlgorithm.

virtual void vtkImageCorrelation::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.

---

Member Data Documentation

int vtkImageCorrelation::Dimensionality [protected]

Definition at line 59 of file vtkImageCorrelation.h.

---

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

• dox/Imaging/General/vtkImageCorrelation.h