SincParam.h

Classes

SincParam -- A one dimensional sin(x)/x (full description)

template<class T> class SincParam : public Function<T>

Types

enum

HEIGHT = 0
CENTER
WIDTH

Interface

Public Members
SincParam()
explicit SincParam(const T &height)
SincParam(const T &height, const T &center)
SincParam(const T &height, const T &center, const T &width)
SincParam(const SincParam<T> &other)
SincParam<T> &operator=(const SincParam<T> &other)
virtual ~SincParam()
virtual uInt ndim() const

Description

Prerequisite

Etymology

A 1-dimensional sinc function.

Synopsis

A Sinc is described by a height, a center and a width (halfwidth). The value is: 
      let y = (x-center)/width
      height                              (x == center)
      height*sin(pi*y)/(pi*y)             (x |= center)
The parameters are enumerated by HEIGHT, CENTER and WIDTH. They have default values of (1, 0, 1).

Example

    SincFunction<Double> sf(5.0, 25.0, 7);
    sf(25);            // = 5.0

Template Type Argument Requirements (T)

Thrown Exceptions

Member Description

enum

Parameter numbers

SincParam()
explicit SincParam(const T &height)
SincParam(const T &height, const T &center)
SincParam(const T &height, const T &center, const T &width)

Constructs the Sinc, Defaults: height=1, center=0, width=1.
Warning Could not use default arguments that worked both with gcc and IRIX

SincParam(const SincParam<T> &other)

Copy constructor (deep copy)

SincParam<T> &operator=(const SincParam<T> &other)

Copy assignment (deep copy)

virtual ~SincParam()

Destructor

virtual uInt ndim() const