casacore::KaiserBParam< T > Class Template Reference

A one dimensional Kaiser-Bessel function. More...

#include <KaiserBParam.h>

Inheritance diagram for casacore::KaiserBParam< T >:

List of all members.

Public Types
enum	{   HEIGHT,   CENTER,   WIDTH,   KBPAR }
	Parameter numbers. More...
Public Member Functions
	KaiserBParam ()
	Constructs the KaiserB, Defaults: height=1, center=0, width=1, kbpar=2.5.
	KaiserBParam (const T &kbpar)
	KaiserBParam (const KaiserBParam< T > &other)
	Copy constructor (deep copy).
KaiserBParam< T > &	operator= (const KaiserBParam< T > &other)
	Copy assignment (deep copy).
template<class W >
	KaiserBParam (const KaiserBParam< W > &other)
virtual	~KaiserBParam ()
	Destructor.
virtual uInt	ndim () const
	Returns the number of dimensions of function.
virtual const String &	name () const
	Give name of function.

---

Detailed Description

template<class T>
class casacore::KaiserBParam< T >

A one dimensional Kaiser-Bessel function.

Intended use:

Internal

Review Status

Test programs:

tFunctionHolder

Prerequisite

• FunctionParam class
• Function class

Etymology

A Kaiser-Bessel function

Synopsis

A Kaiser-Bessel is described by a height, a center, a width (halfwidth) and a parameter. The parameters are enumerated by HEIGHT, CENTER, WIDTH, KBPAR. They have default values of (1, 0, 1, 2.5).

Example

 KaiserBFunction<Double> sf;
 sf(0);            // = 1.0

Template Type Argument Requirements (T)

• T should have standard numerical operators

Thrown Exceptions

• AipsError if incorrect parameter number specified.

Definition at line 80 of file KaiserBParam.h.

---

Member Enumeration Documentation

template<class T>

anonymous enum

Parameter numbers.

Enumerator:

HEIGHT
CENTER
WIDTH
KBPAR

Definition at line 85 of file KaiserBParam.h.

---

Constructor & Destructor Documentation

template<class T>

casacore::KaiserBParam< T >::KaiserBParam

(

)

Constructs the KaiserB, Defaults: height=1, center=0, width=1, kbpar=2.5.

Warning: Could not use default arguments that worked both with gcc and IRIX

template<class T>

casacore::KaiserBParam< T >::KaiserBParam

(

const T &

kbpar

)

[explicit]

template<class T>

casacore::KaiserBParam< T >::KaiserBParam

(

const KaiserBParam< T > &

other

)

Copy constructor (deep copy).

template<class T>

template<class W >

casacore::KaiserBParam< T >::KaiserBParam

(

const KaiserBParam< W > &

other

)

[inline]

Definition at line 103 of file KaiserBParam.h.

template<class T>

virtual casacore::KaiserBParam< T >::~KaiserBParam

(

)

[virtual]

Destructor.

---

Member Function Documentation

template<class T>

virtual const String& casacore::KaiserBParam< T >::name

(

)

const [inline, virtual]

Give name of function.

Reimplemented from casacore::Function< T >.

Definition at line 114 of file KaiserBParam.h.

template<class T>

virtual uInt casacore::KaiserBParam< T >::ndim

(

)

const [inline, virtual]

Returns the number of dimensions of function.

Implements casacore::Function< T >.

Definition at line 110 of file KaiserBParam.h.

template<class T>

KaiserBParam<T>& casacore::KaiserBParam< T >::operator=

(

const KaiserBParam< T > &

other

)

Copy assignment (deep copy).

Reimplemented in casacore::KaiserBFunction< T >.

---

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

• casacore/scimath/Functionals/KaiserBParam.h