clHankel Class Reference

Class implementation of (modified) Hankel-transform. More...

#include <Hankel.hh>

Collaboration diagram for clHankel:


Public Member Functions
	clHankel ()
	~clHankel ()
void	Initialize (long, const float *)
	Initialize Hankel transform.
void	Initialize (long, const double *)
void	Uninitialize ()
	Uninitialize, destructor also does this.
void	Process0 (float , const float )
	Process data (0th order).
void	Process0 (double , const double )
void	Process1 (float , const float )
	Process data (1st order).
void	Process1 (double , const double )
Private Member Functions
void	InitAbel (const float *)
	Initialize Abel transformer.
void	InitAbel (const double *)
void	DoAbel (float , const float )
	Do Abel transform.
void	DoAbel (double , const double )
void	UninitAbel ()
	Unintialize Abel transformer.
Private Attributes
long	lSize
long	lFFTSize
float	fOutScale0
float	fOutScale1
double	dOutScale0
double	dOutScale1
clDSPAlloc	A
clDSPAlloc	B0
clDSPAlloc	B1
clDSPAlloc	GX
clDSPAlloc	GK
clDSPOp	DSP

Detailed Description

Class implementation of (modified) Hankel-transform.

Author:: Colorado School of Mines
Jussi Laako

: Source converted from cwplib (by Dave Hale and Lydia Deng / Colorado School of Mines).

: Transform is significantly sped-up by doing Abel-transform followed by inverse-FFT.

References: Hansen, E. W., 1985, Fast Hankel transform algorithm: IEEE Trans. on Acoustics, Speech and Signal Processing, v. ASSP-33, n. 3, p. 666-671. (Beware of several errors in the equations in this paper!)

Definition at line 58 of file Hankel.hh.

Constructor & Destructor Documentation

clHankel::clHankel ( )

Definition at line 229 of file Hankel.cc.
References lSize.

clHankel::~clHankel ( )

Definition at line 235 of file Hankel.cc.
References lSize, and Uninitialize().

Member Function Documentation

void clHankel::InitAbel ( const float * ) [private]

Initialize Abel transformer.

Parameters:

NullPtr NULL pointer

Definition at line 89 of file Hankel.cc.
References A, ABEL_NSE, B0, B1, fpH, fpLambda, lSize, and clAlloc::Size().
Referenced by Initialize().

void clHankel::InitAbel ( const double * ) [private]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 118 of file Hankel.cc.
References A, ABEL_NSE, B0, B1, fpH, fpLambda, lSize, and clAlloc::Size().

void clHankel::DoAbel ( float * ,

const float *

) [private]

Do Abel transform.

Parameters:

Dest Destination

Src Source

Definition at line 147 of file Hankel.cc.
References A, ABEL_NSE, B0, B1, clAlloc::GetPtr(), and lSize.
Referenced by Process0(), and Process1().

void clHankel::DoAbel ( double * ,

const double *

) [private]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 184 of file Hankel.cc.
References A, ABEL_NSE, B0, B1, clAlloc::GetPtr(), and lSize.

void clHankel::UninitAbel ( ) [private]

Unintialize Abel transformer.

Definition at line 221 of file Hankel.cc.
References A, B0, B1, and clAlloc::Free().
Referenced by Uninitialize().

void clHankel::Initialize ( long ,

const float *

)

Initialize Hankel transform.
The NULL pointer is used make C++ compiler select correct datatype for the transform from overloaded method set.

Parameters:

Size Window size

NullPtr NULL pointer

Definition at line 241 of file Hankel.cc.
References DSP, clDSPOp::FFTInitialize(), fOutScale0, fOutScale1, GK, GX, InitAbel(), lFFTSize, lSize, and clAlloc::Size().

void clHankel::Initialize ( long ,

const double *

)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 255 of file Hankel.cc.
References dOutScale0, dOutScale1, DSP, clDSPOp::FFTInitialize(), GK, GX, InitAbel(), lFFTSize, lSize, and clAlloc::Size().

void clHankel::Uninitialize ( )

Uninitialize, destructor also does this.

Definition at line 269 of file Hankel.cc.
References clAlloc::Free(), GK, GX, lSize, and UninitAbel().
Referenced by ~clHankel().

void clHankel::Process0 ( float * ,

const float *

)

Process data (0th order).
Definition:
$h_{0}(k)=\int_{0}^{\infty}rj_{0}(kr)f(r)\mathrm{d}r$

Note:
Input and output is window size / 2 + 1!

Parameters:

Dest Destination

Src Source

Definition at line 278 of file Hankel.cc.
References DoAbel(), DSP, GK, GX, _sSCplx::I, clDSPOp::IFFTo(), lFFTSize, lSize, and _sSCplx::R.

void clHankel::Process0 ( double * ,

const double *

)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 319 of file Hankel.cc.
References DoAbel(), DSP, GK, GX, _sDCplx::I, clDSPOp::IFFTo(), lFFTSize, lSize, and _sDCplx::R.

void clHankel::Process1 ( float * ,

const float *

)

Process data (1st order).
Definition:
$h_{1}(k)=\int_{0}^{\infty}rj_{1}(kr)f(r)\mathrm{d}r$

Note:
Input and output is window size / 2 + 1!

Parameters:

Dest Destination

Src Source

Definition at line 360 of file Hankel.cc.
References DoAbel(), DSP, GK, GX, _sSCplx::I, clDSPOp::IFFTo(), lFFTSize, lSize, and _sSCplx::R.

void clHankel::Process1 ( double * ,

const double *

)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 401 of file Hankel.cc.
References DoAbel(), DSP, GK, GX, _sDCplx::I, clDSPOp::IFFTo(), lFFTSize, lSize, and _sDCplx::R.

Member Data Documentation

long clHankel::lSize [private]

Definition at line 60 of file Hankel.hh.
Referenced by clHankel(), DoAbel(), InitAbel(), Initialize(), Process0(), Process1(), Uninitialize(), and ~clHankel().

long clHankel::lFFTSize [private]

Definition at line 61 of file Hankel.hh.
Referenced by Initialize(), Process0(), and Process1().

float clHankel::fOutScale0 [private]

Definition at line 62 of file Hankel.hh.
Referenced by Initialize().

float clHankel::fOutScale1 [private]

Definition at line 63 of file Hankel.hh.
Referenced by Initialize().

double clHankel::dOutScale0 [private]

Definition at line 64 of file Hankel.hh.
Referenced by Initialize().

double clHankel::dOutScale1 [private]

Definition at line 65 of file Hankel.hh.
Referenced by Initialize().

clDSPAlloc clHankel::A [private]

Definition at line 66 of file Hankel.hh.
Referenced by DoAbel(), InitAbel(), and UninitAbel().

clDSPAlloc clHankel::B0 [private]

Definition at line 67 of file Hankel.hh.
Referenced by DoAbel(), InitAbel(), and UninitAbel().

clDSPAlloc clHankel::B1 [private]

Definition at line 68 of file Hankel.hh.
Referenced by DoAbel(), InitAbel(), and UninitAbel().

clDSPAlloc clHankel::GX [private]

Definition at line 69 of file Hankel.hh.
Referenced by Initialize(), Process0(), Process1(), and Uninitialize().

clDSPAlloc clHankel::GK [private]

Definition at line 70 of file Hankel.hh.
Referenced by Initialize(), Process0(), Process1(), and Uninitialize().

clDSPOp clHankel::DSP [private]

Definition at line 71 of file Hankel.hh.
Referenced by Initialize(), Process0(), and Process1().

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

Generated on Sun Oct 26 00:09:43 2003 for libDSP by

1.3.3

clHankel Class Reference

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation