SIVIC API  0.9.26
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
svkMetaboliteMap Class Reference

#include <svkMetaboliteMap.h>

Inheritance diagram for svkMetaboliteMap:
svkImageAlgorithm

Public Types

enum  algorithm {
  INTEGRATE = 0, PEAK_HT = 1, MAG_PEAK_HT = 2, LINE_WIDTH = 3,
  MAG_LINE_WIDTH = 4, MAG_INTEGRATE = 5
}
 

Public Member Functions

 vtkTypeMacro (svkMetaboliteMap, svkImageAlgorithm)
 
void SetSeriesDescription (vtkstd::string newSeriesDescription)
 
void SetOutputDataType (svkDcmHeader::DcmPixelDataFormat dataType)
 
void SetZeroCopy (bool zeroCopy)
 
void SetPeakPosPPM (float peak_center_ppm)
 
void SetPeakWidthPPM (float peak_width_ppm)
 
void SetAlgorithmToIntegrate ()
 
void SetAlgorithmToPeakHeight ()
 
void SetAlgorithmToMagPeakHeight ()
 
void SetAlgorithmToLineWidth ()
 
void SetAlgorithmToMagLineWidth ()
 
void SetAlgorithmToMagIntegrate ()
 
void SetAlgorithm (vtkstd::string algo)
 
void SetVerbose (bool isVerbose)
 
void LimitToSelectedVolume (float fraction=0.5001)
 
short * GetSelectedVolumeMask ()
 
- Public Member Functions inherited from svkImageAlgorithm
 vtkTypeMacro (svkImageAlgorithm, vtkImageAlgorithm)
 
svkImageDataGetOutput ()
 
svkImageDataGetOutput (int port)
 
svkImageDataGetImageDataInput (int port)
 

Static Public Member Functions

static svkMetaboliteMapNew ()
 
static double GetIntegral (float *specPtr, int startPt, int endPt)
 
static double GetMagIntegral (float *specPtr, int startPt, int endPt)
 
static double GetPeakHt (float *specPtr, int startPt, int endPt)
 
static double GetMagPeakHt (float *specPtr, int startPt, int endPt)
 

Protected Member Functions

 svkMetaboliteMap ()
 
 ~svkMetaboliteMap ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
void ZeroData ()
 
virtual int FillInputPortInformation (int vtkNotUsed(port), vtkInformation *info)
 
virtual int FillOutputPortInformation (int vtkNotUsed(port), vtkInformation *info)
 
- Protected Member Functions inherited from svkImageAlgorithm
 svkImageAlgorithm ()
 
 ~svkImageAlgorithm ()
 

Detailed Description

Class to extract an svkMriImageData object out of an svkMrsImageData object. This is useful for generating metaboite maps or other maps from spectral, dynamic or other multi- volumetric data.

Member Enumeration Documentation

enum algorithm
Enumerator
INTEGRATE 
PEAK_HT 
MAG_PEAK_HT 
LINE_WIDTH 
MAG_LINE_WIDTH 
MAG_INTEGRATE 

Constructor & Destructor Documentation

svkMetaboliteMap ( )
protected
~svkMetaboliteMap ( )
protected

Member Function Documentation

int FillInputPortInformation ( int   vtkNotUsedport,
vtkInformation *  info 
)
protectedvirtual

Default input type is svkImageData base class. Override with a specific concrete type in sub class if necessary.

Reimplemented from svkImageAlgorithm.

int FillOutputPortInformation ( int   vtkNotUsedport,
vtkInformation *  info 
)
protectedvirtual

Output from this algo is an svkMriImageData object.

Reimplemented from svkImageAlgorithm.

double GetIntegral ( float *  specPtr,
int  startPt,
int  endPt 
)
static

Gets integral of real component over the specified range from startPt to endPt.

double GetMagIntegral ( float *  specPtr,
int  startPt,
int  endPt 
)
static

Gets integral of real component over the specified range from startPt to endPt.

double GetMagPeakHt ( float *  specPtr,
int  startPt,
int  endPt 
)
static

Gets max peak ht of magnitude spectrum over the specified range from startPt to endPt.

double GetPeakHt ( float *  specPtr,
int  startPt,
int  endPt 
)
static

Gets max peak ht of real component over the specified range from startPt to endPt.

Referenced by svkMRSZeroOrderPhaseCostFunction::GetZeroOrderPhaseCost_2().

short * GetSelectedVolumeMask ( )
void LimitToSelectedVolume ( float  fraction = 0.5001)
static svkMetaboliteMap* New ( )
static
int RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual
int RequestInformation ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Resets the origin and extent for correct initialization of output svkMriImageData object from input svkMrsImageData object.

References svkImageData::GetDcmHeader(), svkImageAlgorithm::GetImageDataInput(), and svkDcmHeader::GetOrigin().

void SetAlgorithm ( vtkstd::string  algo)
void SetAlgorithmToIntegrate ( )
void SetAlgorithmToLineWidth ( )
void SetAlgorithmToMagIntegrate ( )
void SetAlgorithmToMagLineWidth ( )
void SetAlgorithmToMagPeakHeight ( )
void SetAlgorithmToPeakHeight ( )
void SetOutputDataType ( svkDcmHeader::DcmPixelDataFormat  dataType)
void SetPeakPosPPM ( float  centerPPM)

Set the chemical shift of the peak position to integrate over.

void SetPeakWidthPPM ( float  widthPPM)

Set the chemical shift range to integrate over. Integration will be +/- 1/2 this width about the peak position.

void SetSeriesDescription ( vtkstd::string  newSeriesDescription)

Set the series description for the DICOM header of the copy.

void SetVerbose ( bool  isVerbose)

Write the integrals for each voxel to stdout. Default is false.

void SetZeroCopy ( bool  zeroCopy)
vtkTypeMacro ( svkMetaboliteMap  ,
svkImageAlgorithm   
)
void ZeroData ( )
protected

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