vtkImageEstimatePhaseLinearRamps Class Reference

#include <vtkImageEstimatePhaseLinearRamps.h>

Inheritance diagram for vtkImageEstimatePhaseLinearRamps:

[legend]Collaboration diagram for vtkImageEstimatePhaseLinearRamps:

[legend]List of all members.

---

Detailed Description

Estimate linear ramps in a complex phase image.

vtkImageEstimatePhaseLinearRamps - This filter estimates linear ramps for each axis of a complex phase image. The phase input must be single component VTK_FLOAT or VTK_DOUBLE and be in the range of -pi to pi (i.e. using atan2). The output is 1D or 2D with 3 values in the first dimension; the linear phase estimate in each dimension. The second dimension is determined by the NumberOfSlicesPerVolume parameter. If this value is set, then the second dimension will equal the number of image volumes stored in the z dimension. The output type will be the same as the input. This filter may be used in conjunction with vtkImageAdjustPhaseLinearRamps to remove and restore linear phase ramps before and after calculating the unwrapped phase using vtkImageFindPhaseLabels and vtkImagePRELUDE. An optional mask may be supplied as a second input to estimate the linear ramps for the masked region only. The mask input type must be VTK_UNSIGNED_CHAR. It may be generated using vtkImageThresholdByPercentile, vtkImageConnectedComponents,and vtkImageAccumulate with the complex magnitude as input (essentially automatically find the largest connected component in the magnitude image).

This class uses portions of code from the FMRIB Software Library.

See also:

vtkImageFindPhaseLabels, vtkImagePRELUDE, vtkImageAdjustPhaseLinearRamps, vtkImageThresholdByPercentile, vtkImageConnectedComponents

Definition at line 63 of file vtkImageEstimatePhaseLinearRamps.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkImageEstimatePhaseLinearRamps, vtkThreadedImageAlgorithm)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetPhaseInput (vtkDataObject *in)
void	SetMaskInput (vtkDataObject *in)
virtual void	SetNumberOfSlicesPerVolume (int)
virtual int	GetNumberOfSlicesPerVolume ()
virtual void	SetEstimate4D (int)
virtual int	GetEstimate4D ()
virtual void	Estimate4DOn ()
virtual void	Estimate4DOff ()
virtual void	SetDiagnosticMessages (int)
virtual int	GetDiagnosticMessages ()
virtual void	DiagnosticMessagesOn ()
virtual void	DiagnosticMessagesOff ()
virtual int	SplitExtent (int splitExt[6], int startExt[6], int num, int total)
Static Public Member Functions
static vtkImageEstimatePhaseLinearRamps *	New ()
Protected Member Functions
	vtkImageEstimatePhaseLinearRamps ()
	~vtkImageEstimatePhaseLinearRamps ()
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void	ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int extent[6], int threadId)
virtual int	FillInputPortInformation (int port, vtkInformation *info)
Protected Attributes
int	NumberOfSlicesPerVolume
int	Estimate4D
int	DiagnosticMessages

---

Constructor & Destructor Documentation

vtkImageEstimatePhaseLinearRamps::vtkImageEstimatePhaseLinearRamps

(

)

[protected]

vtkImageEstimatePhaseLinearRamps::~vtkImageEstimatePhaseLinearRamps

(

)

[inline, protected]

Definition at line 109 of file vtkImageEstimatePhaseLinearRamps.h.

---

Member Function Documentation

static vtkImageEstimatePhaseLinearRamps* vtkImageEstimatePhaseLinearRamps::New

(

)

[static]

Reimplemented from vtkAlgorithm.

vtkImageEstimatePhaseLinearRamps::vtkTypeRevisionMacro	(	vtkImageEstimatePhaseLinearRamps	,
		vtkThreadedImageAlgorithm
	)

void vtkImageEstimatePhaseLinearRamps::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			[virtual]

Reimplemented from vtkThreadedImageAlgorithm.

void vtkImageEstimatePhaseLinearRamps::SetPhaseInput

(

vtkDataObject *

in

)

[inline]

Set the phase image.

Definition at line 71 of file vtkImageEstimatePhaseLinearRamps.h.

References vtkImageAlgorithm::SetInput().

void vtkImageEstimatePhaseLinearRamps::SetMaskInput

(

vtkDataObject *

in

)

[inline]

Set the optional image mask.

Definition at line 74 of file vtkImageEstimatePhaseLinearRamps.h.

References vtkImageAlgorithm::SetInput().

virtual void vtkImageEstimatePhaseLinearRamps::SetNumberOfSlicesPerVolume

(

int

)

[virtual]

Number of slices per volume (default is undefined). If multiple volumes exist then, NumberOfThreads should be set such that the split extents are a multiple of this value.

virtual int vtkImageEstimatePhaseLinearRamps::GetNumberOfSlicesPerVolume

(

)

[virtual]

Number of slices per volume (default is undefined). If multiple volumes exist then, NumberOfThreads should be set such that the split extents are a multiple of this value.

virtual void vtkImageEstimatePhaseLinearRamps::SetEstimate4D

(

int

)

[virtual]

Switch on 4D estimation (off by default). If this is turned on, NumberOfSlicesPerVolume must be set.

virtual int vtkImageEstimatePhaseLinearRamps::GetEstimate4D

(

)

[virtual]

Switch on 4D estimation (off by default). If this is turned on, NumberOfSlicesPerVolume must be set.

virtual void vtkImageEstimatePhaseLinearRamps::Estimate4DOn

(

)

[virtual]

Switch on 4D estimation (off by default). If this is turned on, NumberOfSlicesPerVolume must be set.

virtual void vtkImageEstimatePhaseLinearRamps::Estimate4DOff

(

)

[virtual]

Switch on 4D estimation (off by default). If this is turned on, NumberOfSlicesPerVolume must be set.

virtual void vtkImageEstimatePhaseLinearRamps::SetDiagnosticMessages

(

int

)

[virtual]

Switch on diagnostic messages (off by default).

virtual int vtkImageEstimatePhaseLinearRamps::GetDiagnosticMessages

(

)

[virtual]

Switch on diagnostic messages (off by default).

virtual void vtkImageEstimatePhaseLinearRamps::DiagnosticMessagesOn

(

)

[virtual]

Switch on diagnostic messages (off by default).

virtual void vtkImageEstimatePhaseLinearRamps::DiagnosticMessagesOff

(

)

[virtual]

Switch on diagnostic messages (off by default).

virtual int vtkImageEstimatePhaseLinearRamps::SplitExtent	(	int	splitExt[6],
		int	startExt[6],
		int	num,
		int	total
	)			[virtual]

Overriding this function to enable threaded execution on multiple volumes.

Reimplemented from vtkThreadedImageAlgorithm.

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

Reimplemented from vtkImageAlgorithm.

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

Reimplemented from vtkImageAlgorithm.

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

Reimplemented from vtkThreadedImageAlgorithm.

virtual int vtkImageEstimatePhaseLinearRamps::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)			[protected, virtual]

Reimplemented from vtkImageAlgorithm.

---

Member Data Documentation

int vtkImageEstimatePhaseLinearRamps::NumberOfSlicesPerVolume [protected]

Definition at line 109 of file vtkImageEstimatePhaseLinearRamps.h.

int vtkImageEstimatePhaseLinearRamps::Estimate4D [protected]

Definition at line 112 of file vtkImageEstimatePhaseLinearRamps.h.

int vtkImageEstimatePhaseLinearRamps::DiagnosticMessages [protected]

Definition at line 113 of file vtkImageEstimatePhaseLinearRamps.h.

---

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

• dox/Imaging/vtkImageEstimatePhaseLinearRamps.h

---