vtkImagePRELUDE Class Reference

#include <vtkImagePRELUDE.h>

Inheritance diagram for vtkImagePRELUDE:

Inheritance graph
[legend]
Collaboration diagram for vtkImagePRELUDE:

Collaboration graph
[legend]
List of all members.

Detailed Description

Phase Region Expanding Labeller for Unwrapping Discrete Estimates (PRELUDE).

This performs 3D phase unwrapping of images. Receives as input a complex image of any type and outputs the phase as type float. It also requires a second input of labeled phase components, which may be created using vtkImageFindPhaseLabels. This filter is a VTK implementation of the method described in the following paper:

Mark Jenkinson, "Fast, Automated, N-Dimensional Phase-Unwrapping Algorithm", Magnetic Resonance in Medicine 49:193-197 (2003).

Contains portions of code from the FMRIB Software Library.

See also:
vtkImageThresholdByPercentile, vtkImageConnectedComponents, vtkImageEstimatePhaseLinearRamps, vtkImageAdjustPhaseLinearRamps, vtkImageFindPhaseLabels

Definition at line 58 of file vtkImagePRELUDE.h.

Public Member Functions

 vtkTypeRevisionMacro (vtkImagePRELUDE, vtkThreadedImageAlgorithm)
void PrintSelf (ostream &os, vtkIndent indent)
void SetPhaseInput (vtkDataObject *in)
void SetPhaseLabelInput (vtkDataObject *in)
virtual void SetNumberOfSlicesPerVolume (int)
virtual int GetNumberOfSlicesPerVolume ()
virtual void SetUnwrapOperation (int)
virtual int GetUnwrapOperation ()
void SetUnwrapOperationTo2D ()
void SetUnwrapOperationTo3D ()
void SetUnwrapOperationTo4D ()
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 vtkImagePRELUDENew ()

Protected Member Functions

 vtkImagePRELUDE ()
 ~vtkImagePRELUDE ()
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)

Protected Attributes

int DiagnosticMessages
int UnwrapOperation
int NumberOfSlicesPerVolume


Constructor & Destructor Documentation

vtkImagePRELUDE::vtkImagePRELUDE (  )  [protected]

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

Definition at line 109 of file vtkImagePRELUDE.h.


Member Function Documentation

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

Reimplemented from vtkAlgorithm.

vtkImagePRELUDE::vtkTypeRevisionMacro ( vtkImagePRELUDE  ,
vtkThreadedImageAlgorithm   
)

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

Reimplemented from vtkThreadedImageAlgorithm.

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

Set the phase image to be unwrapped.

Definition at line 66 of file vtkImagePRELUDE.h.

References vtkImageAlgorithm::SetInput().

void vtkImagePRELUDE::SetPhaseLabelInput ( vtkDataObject in  )  [inline]

Set the required phase label input.

Definition at line 69 of file vtkImagePRELUDE.h.

References vtkImageAlgorithm::SetInput().

virtual void vtkImagePRELUDE::SetNumberOfSlicesPerVolume ( int   )  [virtual]

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

virtual int vtkImagePRELUDE::GetNumberOfSlicesPerVolume (  )  [virtual]

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

virtual void vtkImagePRELUDE::SetUnwrapOperation ( int   )  [virtual]

Set/Get the unwrap operation (default is 3D).

virtual int vtkImagePRELUDE::GetUnwrapOperation (  )  [virtual]

Set/Get the unwrap operation (default is 3D).

void vtkImagePRELUDE::SetUnwrapOperationTo2D (  )  [inline]

Set/Get the unwrap operation (default is 3D).

Definition at line 86 of file vtkImagePRELUDE.h.

References VTK_PRELUDE_UNWRAP_2D.

void vtkImagePRELUDE::SetUnwrapOperationTo3D (  )  [inline]

Set/Get the unwrap operation (default is 3D).

Definition at line 87 of file vtkImagePRELUDE.h.

References VTK_PRELUDE_UNWRAP_3D.

void vtkImagePRELUDE::SetUnwrapOperationTo4D (  )  [inline]

Set/Get the unwrap operation (default is 3D).

Definition at line 88 of file vtkImagePRELUDE.h.

References VTK_PRELUDE_UNWRAP_4D.

virtual void vtkImagePRELUDE::SetDiagnosticMessages ( int   )  [virtual]

Switch on diagnostic messages (off by default).

virtual int vtkImagePRELUDE::GetDiagnosticMessages (  )  [virtual]

Switch on diagnostic messages (off by default).

virtual void vtkImagePRELUDE::DiagnosticMessagesOn (  )  [virtual]

Switch on diagnostic messages (off by default).

virtual void vtkImagePRELUDE::DiagnosticMessagesOff (  )  [virtual]

Switch on diagnostic messages (off by default).

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

Reimplemented from vtkImageAlgorithm.

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

Reimplemented from vtkImageAlgorithm.

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

Reimplemented from vtkThreadedImageAlgorithm.


Member Data Documentation

int vtkImagePRELUDE::DiagnosticMessages [protected]

Definition at line 109 of file vtkImagePRELUDE.h.

int vtkImagePRELUDE::UnwrapOperation [protected]

Definition at line 113 of file vtkImagePRELUDE.h.

int vtkImagePRELUDE::NumberOfSlicesPerVolume [protected]

Definition at line 115 of file vtkImagePRELUDE.h.


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