casa::KaiserBFunction< T > Class Template Reference

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

#include <KaiserBFunction.h>

Inheritance diagram for casa::KaiserBFunction< T >:

List of all members.

Public Member Functions
	KaiserBFunction ()
	Constructs the KaiserBFunction, Defaults: height=1, center=0, width=1, kbpar=2.5.
	KaiserBFunction (const T &kbpar)
	KaiserBFunction (const KaiserBFunction< T > &other)
	Copy constructor (deep copy)
template<class W >
	KaiserBFunction (const KaiserBFunction< W > &other)
KaiserBFunction< T > &	operator= (const KaiserBFunction< T > &other)
	Copy assignment (deep copy)
virtual	~KaiserBFunction ()
	Destructor.
virtual T	eval (typename Function< T >::FunctionArg x) const
	Evaluate the KaiserB at x.
virtual Function< T > *	clone () const
	Return a copy of this object from the heap.
virtual Function< typename FunctionTraits< T >::DiffType > *	cloneAD () const
virtual Function< typename FunctionTraits< T >::BaseType > *	cloneNonAD () const

---

Detailed Description

template<class T>
class casa::KaiserBFunction< T >

A one dimensional Kaiser-Bessel function.

Intended use:

Public interface

Review Status

Test programs:

tFunctionHolder

Prerequisite

• KaiserBParam
• Function

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 81 of file KaiserBFunction.h.

---

Constructor & Destructor Documentation

template<class T>

casa::KaiserBFunction< T >::KaiserBFunction

(

)

[inline]

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

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

Definition at line 90 of file KaiserBFunction.h.

template<class T>

casa::KaiserBFunction< T >::KaiserBFunction

(

const T &

kbpar

)

[inline, explicit]

Definition at line 91 of file KaiserBFunction.h.

template<class T>

casa::KaiserBFunction< T >::KaiserBFunction

(

const KaiserBFunction< T > &

other

)

[inline]

Copy constructor (deep copy)

Definition at line 97 of file KaiserBFunction.h.

template<class T>

template<class W >

casa::KaiserBFunction< T >::KaiserBFunction

(

const KaiserBFunction< W > &

other

)

[inline]

Definition at line 99 of file KaiserBFunction.h.

template<class T>

virtual casa::KaiserBFunction< T >::~KaiserBFunction

(

)

[inline, virtual]

Destructor.

Definition at line 108 of file KaiserBFunction.h.

---

Member Function Documentation

template<class T>

virtual Function<T>* casa::KaiserBFunction< T >::clone

(

)

const [inline, virtual]

Return a copy of this object from the heap.

The caller is responsible for deleting this pointer.

Implements casa::Function< T >.

Definition at line 121 of file KaiserBFunction.h.

template<class T>

virtual Function<typename FunctionTraits<T>::DiffType>* casa::KaiserBFunction< T >::cloneAD

(

)

const [inline, virtual]

Reimplemented from casa::Function< T >.

Definition at line 122 of file KaiserBFunction.h.

template<class T>

virtual Function<typename FunctionTraits<T>::BaseType>* casa::KaiserBFunction< T >::cloneNonAD

(

)

const [inline, virtual]

Reimplemented from casa::Function< T >.

Definition at line 124 of file KaiserBFunction.h.

template<class T>

virtual T casa::KaiserBFunction< T >::eval

(

typename Function< T >::FunctionArg

x

)

const [virtual]

Evaluate the KaiserB at x.

If a vector is used as the argument only its first element is used.

template<class T>

KaiserBFunction<T>& casa::KaiserBFunction< T >::operator=

(

const KaiserBFunction< T > &

other

)

[inline]

Copy assignment (deep copy)

Definition at line 104 of file KaiserBFunction.h.

---

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

• casacore/scimath/Functionals/KaiserBFunction.h