---

vtkImageCorrelation Class Reference

Correlation imageof the two inputs. More...

#include <vtkImageCorrelation.h>

Inheritance diagram for vtkImageCorrelation:

[legend]Collaboration diagram for vtkImageCorrelation:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetDimensionality (int)
virtual int	GetDimensionality ()
Static Public Methods
vtkImageCorrelation *	New ()
int	IsTypeOf (const char *type)
vtkImageCorrelation *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkImageCorrelation ()
	~vtkImageCorrelation ()
void	ExecuteInformation (vtkImageData **inDatas, vtkImageData *outData)
virtual void	ComputeInputUpdateExtent (int inExt[6], int outExt[6], int whichInput)
void	ExecuteInformation ()
void	ThreadedExecute (vtkImageData **inDatas, vtkImageData *outData, int extent[6], int id)
Protected Attributes
int	Dimensionality

---

Detailed Description

Correlation imageof the two inputs.

Date:

2001/11/13 14:32:32

Revision:

1.22

Thanks:

Thanks to C. Charles Law who developed this class.

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 float. 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 65 of file vtkImageCorrelation.h.

---

Constructor & Destructor Documentation

vtkImageCorrelation::vtkImageCorrelation (    )  [protected]

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

Definition at line 80 of file vtkImageCorrelation.h.

---

Member Function Documentation

vtkImageCorrelation* vtkImageCorrelation::New (    )  [static]

Instantiate object with no start, end, or progress methods. Reimplemented from vtkImageTwoInputFilter.

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImageTwoInputFilter.

int vtkImageCorrelation::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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImageTwoInputFilter.

virtual int vtkImageCorrelation::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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImageTwoInputFilter.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImageTwoInputFilter.

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

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

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

virtual int vtkImageCorrelation::GetDimensionality (    )  [virtual]

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

void vtkImageCorrelation::ExecuteInformation (  vtkImageData **    inDatas, vtkImageData *    outData )  [protected, virtual]

Reimplemented from vtkImageMultipleInputFilter.

virtual void vtkImageCorrelation::ComputeInputUpdateExtent (  int    inExt[6], int    outExt[6], int    whichInput )  [protected, virtual]

Reimplemented from vtkImageMultipleInputFilter.

void vtkImageCorrelation::ExecuteInformation (    )  [inline, protected, virtual]

Reimplemented from vtkImageMultipleInputFilter. Definition at line 86 of file vtkImageCorrelation.h.

void vtkImageCorrelation::ThreadedExecute (  vtkImageData **    inDatas, vtkImageData *    outData, int    extent[6], int    id )  [protected, virtual]

The execute method created by the subclass. This is kept public instead of protected since it is called from a non-member thread function. Reimplemented from vtkImageMultipleInputFilter.

---

Member Data Documentation

int vtkImageCorrelation::Dimensionality [protected]

Definition at line 82 of file vtkImageCorrelation.h.

---

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

• Imaging/vtkImageCorrelation.h

---