vtkImageAdjustPhaseLinearRamps Class Reference

#include <vtkImageAdjustPhaseLinearRamps.h>

Inheritance diagram for vtkImageAdjustPhaseLinearRamps:

Inheritance graph
[legend]
Collaboration diagram for vtkImageAdjustPhaseLinearRamps:

Collaboration graph
[legend]
List of all members.

Detailed Description

Remove or restore linear phase ramps in a complex phase image.

vtkImageAdjustPhaseLinearRamps - This filter will reomve or restore the linear phase ramps estimated using vtkImageEstimatePhaseLinearRamps. The phase input must be single component VTK_FLOAT or VTK_DOUBLE. The estimates input must be the same type as the input and must be 1D with 3 values. The output will be the same size and data type as the phase input. This filter may be used to remove and restore linear phase ramps before and after calculating the unwrapped phase using vtkImagePRELUDE. An optional mask may be supplied as a third input. 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:
vtkImagePRELUDE, vtkImageEstimatePhaseLinearRamps, vtkImageThresholdByPercentile, vtkImageConnectedComponents

Definition at line 58 of file vtkImageAdjustPhaseLinearRamps.h.

Public Member Functions

 vtkTypeRevisionMacro (vtkImageAdjustPhaseLinearRamps, vtkThreadedImageAlgorithm)
void PrintSelf (ostream &os, vtkIndent indent)
void SetPhaseInput (vtkDataObject *in)
void SetLinearPhaseEstimatesInput (vtkDataObject *in)
void SetMaskInput (vtkDataObject *in)
virtual void SetRestoreLinearRamps (int)
virtual int GetRestoreLinearRamps ()
virtual void RestoreLinearRampsOn ()
virtual void RestoreLinearRampsOff ()
virtual void SetNumberOfSlicesPerVolume (int)
virtual int GetNumberOfSlicesPerVolume ()
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 vtkImageAdjustPhaseLinearRampsNew ()

Protected Member Functions

 vtkImageAdjustPhaseLinearRamps ()
 ~vtkImageAdjustPhaseLinearRamps ()
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 RestoreLinearRamps
int NumberOfSlicesPerVolume
int DiagnosticMessages


Constructor & Destructor Documentation

vtkImageAdjustPhaseLinearRamps::vtkImageAdjustPhaseLinearRamps (  )  [protected]

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

Definition at line 108 of file vtkImageAdjustPhaseLinearRamps.h.


Member Function Documentation

static vtkImageAdjustPhaseLinearRamps* vtkImageAdjustPhaseLinearRamps::New (  )  [static]

Reimplemented from vtkAlgorithm.

vtkImageAdjustPhaseLinearRamps::vtkTypeRevisionMacro ( vtkImageAdjustPhaseLinearRamps  ,
vtkThreadedImageAlgorithm   
)

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

Reimplemented from vtkThreadedImageAlgorithm.

void vtkImageAdjustPhaseLinearRamps::SetPhaseInput ( vtkDataObject in  )  [inline]

Set the phase image.

Definition at line 66 of file vtkImageAdjustPhaseLinearRamps.h.

References vtkImageAlgorithm::SetInput().

void vtkImageAdjustPhaseLinearRamps::SetLinearPhaseEstimatesInput ( vtkDataObject in  )  [inline]

Set the required linear phase estimates (vtkImageEstimatePhaseLinearRamps).

Definition at line 70 of file vtkImageAdjustPhaseLinearRamps.h.

References vtkImageAlgorithm::SetInput().

void vtkImageAdjustPhaseLinearRamps::SetMaskInput ( vtkDataObject in  )  [inline]

Set the optional image mask.

Definition at line 73 of file vtkImageAdjustPhaseLinearRamps.h.

References vtkImageAlgorithm::SetInput().

virtual void vtkImageAdjustPhaseLinearRamps::SetRestoreLinearRamps ( int   )  [virtual]

Switch on restoring linear phase ramps (removes by default).

virtual int vtkImageAdjustPhaseLinearRamps::GetRestoreLinearRamps (  )  [virtual]

Switch on restoring linear phase ramps (removes by default).

virtual void vtkImageAdjustPhaseLinearRamps::RestoreLinearRampsOn (  )  [virtual]

Switch on restoring linear phase ramps (removes by default).

virtual void vtkImageAdjustPhaseLinearRamps::RestoreLinearRampsOff (  )  [virtual]

Switch on restoring linear phase ramps (removes by default).

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

Switch on diagnostic messages (off by default).

virtual int vtkImageAdjustPhaseLinearRamps::GetDiagnosticMessages (  )  [virtual]

Switch on diagnostic messages (off by default).

virtual void vtkImageAdjustPhaseLinearRamps::DiagnosticMessagesOn (  )  [virtual]

Switch on diagnostic messages (off by default).

virtual void vtkImageAdjustPhaseLinearRamps::DiagnosticMessagesOff (  )  [virtual]

Switch on diagnostic messages (off by default).

virtual int vtkImageAdjustPhaseLinearRamps::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 vtkImageAdjustPhaseLinearRamps::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkImageAlgorithm.

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

Reimplemented from vtkImageAlgorithm.

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

Reimplemented from vtkThreadedImageAlgorithm.

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

Reimplemented from vtkImageAlgorithm.


Member Data Documentation

int vtkImageAdjustPhaseLinearRamps::RestoreLinearRamps [protected]

Definition at line 108 of file vtkImageAdjustPhaseLinearRamps.h.

int vtkImageAdjustPhaseLinearRamps::NumberOfSlicesPerVolume [protected]

Definition at line 111 of file vtkImageAdjustPhaseLinearRamps.h.

int vtkImageAdjustPhaseLinearRamps::DiagnosticMessages [protected]

Definition at line 112 of file vtkImageAdjustPhaseLinearRamps.h.


The documentation for this class was generated from the following file:
Generated on Tue May 12 14:53:20 2009 for vtkCNMRRLibrary by  doxygen 1.4.7