KaiserBFunction.h

Classes

KaiserBFunction -- A one dimensional Kaiser-Bessel function (full description)

template<class T> class KaiserBFunction : public KaiserBParam<T>

Interface

Public Members
KaiserBFunction() : KaiserBParam<T>()
explicit KaiserBFunction(const T &kbpar) : KaiserBParam<T>(kbpar)
KaiserBFunction(const KaiserBFunction<T> &other) : other<T>(other)
KaiserBFunction(const KaiserBFunction<W> &other) : other<T>(other)
KaiserBFunction<T> &operator=(const KaiserBFunction<T> &other)
virtual ~KaiserBFunction()
virtual T eval(typename Function<T>::FunctionArg x) const
virtual Function<T> *clone() const
virtual Function<typename FunctionTraits<T>::BaseType> *cloneNonAD() const

Description

Prerequisite

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)

Thrown Exceptions

Member Description

KaiserBFunction() : KaiserBParam<T>()
explicit KaiserBFunction(const T &kbpar) : KaiserBParam<T>(kbpar)

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

KaiserBFunction(const KaiserBFunction<T> &other) : other<T>(other)
KaiserBFunction(const KaiserBFunction<W> &other) : other<T>(other)

Copy constructor (deep copy)

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. If a vector is used as the argument only its first element is used.

virtual Function<T> *clone() const
virtual Function<typename FunctionTraits<T>::BaseType> *cloneNonAD() const

Return a copy of this object from the heap. The caller is responsible for deleting this pointer.