svkApodizationWindow Class Reference

#include <svkApodizationWindow.h>

Inheritance diagram for svkApodizationWindow:

Public Member Functions
	vtkTypeMacro (svkApodizationWindow, vtkObject)

Static Public Member Functions
static svkApodizationWindow *	New ()
static void	GetLorentzianWindow (vtkFloatArray *window, float fwhh, float dt)
static void	GetLorentzianWindow (vtkFloatArray *window, svkImageData *data, float fwhh)
static void	GetGaussianWindow (vtkFloatArray *window, float fwhh, float dt, float center=0)
static void	GetGaussianWindow (vtkFloatArray *window, svkImageData *data, float fwhh, float center=0)
static void	InitializeWindow (vtkFloatArray *window, svkImageData *data)
static float	GetWindowResolution (svkImageData *data)

Protected Member Functions
	svkApodizationWindow ()
	Constructor. More...
	~svkApodizationWindow ()
	Destructor. More...

Detailed Description

Apodization window.

Constructor & Destructor Documentation

svkApodizationWindow ( )

protected

Constructor.

~svkApodizationWindow ( )

protected

Destructor.

Member Function Documentation

void GetGaussianWindow ( vtkFloatArray *  window, float  fwhh, float  dt, float  center = 0  )

static

Creates a gaussian window using the equation: f(t) = e^( -0.5 * (fwhh * Pi* ( t - center ))/sqrt(2*log(2)))^2 ) from t = 0 to t = N where N the number of tuples in the input array.

NOTE: This window has the properties specified for fwhh in the FREQUENCY DOMAIN not in the time domain. The center is defined in ms in the time domain.

Parameters

window	Pre-allocated array that will be populated with the window. The number of tuples allocated determines the number of points in the window.
fwhh	Defines the shape of the gaussian, also know as the line broadening parameter. Value in Hz.
dt	Temporal resolution of the window in seconds.
center	The center point for the window in ms.

Referenced by svkApodizationWindow::GetGaussianWindow().

void GetGaussianWindow ( vtkFloatArray *  window, svkImageData *  data, float  fwhh, float  center = 0  )

static

Creates a gaussian window using the equation: f(t) = e^((-(t-center)^2 *4*ln(2))/(fwhh(Hz) * dt)^2 ) from t = 0 to t = N where N the number of tuples in the input array.

Parameters

window	Pre-allocated array that will be populated with the window. The number of tuples allocated determines the number of points in the window.
fwhh	Defines the shape of the gaussian, also know as the line broadening parameter. Value in Hz.
dt	Temporal resolution of the window in seconds.
center	The center point for the peak of the Gaussian.

References svkApodizationWindow::GetGaussianWindow(), svkApodizationWindow::GetWindowResolution(), and svkApodizationWindow::InitializeWindow().

void GetLorentzianWindow ( vtkFloatArray *  window, float  fwhh, float  dt  )

static

Creates a lorentzian window using the equation: f(t) = e^(-fwhh * PI * dt) from t = 0 to t = N where N the number of tuples in the input array.

NOTE: This window has the properties specified for fwhh in the FREQUENCY DOMAIN not in the time domain.

Parameters

window	Pre-allocated array that will be populated with the window. The number of tuples allocated determines the number of points in the window.
fwhh	Defines the shape of the Lorentzian, also know as the line broadening parameter. Value in Hz.
dt	Temporal resolution of the window in seconds.

Referenced by svkApodizationWindow::GetLorentzianWindow().

void GetLorentzianWindow ( vtkFloatArray *  window, svkImageData *  data, float  fwhh  )

static

Creates a lorentzian window using the equation: f(t) = e^(-fwhh * PI * dt) from t = 0 to t = N where N the number of tuples in the input array. Extracts parameters from the DICOM header to determine the dt parameter.

Parameters

window	Array that will be populated with the window. The number of tuples allocated determines the number of points in the window.
data	The data set to generate the window for. Based on the type the number of points and dt are determined.
fwhh	Defines the shape of the Lorentzian, also know as the line broadening parameter. Value in Hz.

References svkApodizationWindow::GetLorentzianWindow(), svkApodizationWindow::GetWindowResolution(), and svkApodizationWindow::InitializeWindow().

float GetWindowResolution ( svkImageData *  data )

static

Determines the window resolution from the input dataset.

Parameters

data	The data for which you wish to get the required window resolution

Returns

the resolution, 0 is for failure

References svkImageData::GetDcmHeader(), and svkDcmHeader::GetFloatValue().

Referenced by svkApodizationWindow::GetGaussianWindow(), and svkApodizationWindow::GetLorentzianWindow().

void InitializeWindow ( vtkFloatArray *  window, svkImageData *  data  )

static

Determines the number of components and number of points appropriate for the window array.

Parameters

data	The data for which you wish to get the required window resolution

Returns

the resolution, 0 is for failure

References svkImageData::GetDcmHeader(), svkDcmHeader::GetIntValue(), and svkDcmHeader::GetStringValue().

Referenced by svkApodizationWindow::GetGaussianWindow(), and svkApodizationWindow::GetLorentzianWindow().

static svkApodizationWindow* New ( )

static

vtkTypeMacro	(	svkApodizationWindow	,
		vtkObject
	)

---

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

• svkApodizationWindow.h
• svkApodizationWindow.cc