casacore::SincParam< T > Class Template Reference

A one dimensional sin(x)/x. More...

#include <SincParam.h>

Inheritance diagram for casacore::SincParam< T >:

List of all members.

Public Types
enum	{   HEIGHT,   CENTER,   WIDTH }
	Parameter numbers. More...
Public Member Functions
	SincParam ()
	Constructs the Sinc, Defaults: height=1, center=0, width=1.
	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)
	Copy constructor (deep copy).
template<class W >
	SincParam (const SincParam< W > &other)
SincParam< T > &	operator= (const SincParam< T > &other)
	Copy assignment (deep copy).
virtual	~SincParam ()
	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::SincParam< T >

A one dimensional sin(x)/x.

Intended use:

Internal

Review Status

Reviewed By:

UNKNOWN

Date Reviewed:

before2004/08/25

Test programs:

tFunctionHolder

Prerequisite

• FunctionParam class
• Function class

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)

• T should have standard numerical operators

Thrown Exceptions

• AipsError if incorrect parameter number specified.

Definition at line 85 of file SincParam.h.

---

Member Enumeration Documentation

template<class T>

anonymous enum

Parameter numbers.

Enumerator:

HEIGHT
CENTER
WIDTH

Definition at line 90 of file SincParam.h.

---

Constructor & Destructor Documentation

template<class T>

casacore::SincParam< T >::SincParam

(

)

Constructs the Sinc, Defaults: height=1, center=0, width=1.

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

template<class T>

casacore::SincParam< T >::SincParam

(

const T &

height

)

[explicit]

template<class T>

casacore::SincParam< T >::SincParam	(	const T &	height,
		const T &	center
	)

template<class T>

casacore::SincParam< T >::SincParam	(	const T &	height,
		const T &	center,
		const T &	width
	)

template<class T>

casacore::SincParam< T >::SincParam

(

const SincParam< T > &

other

)

Copy constructor (deep copy).

template<class T>

template<class W >

casacore::SincParam< T >::SincParam

(

const SincParam< W > &

other

)

[inline]

Definition at line 108 of file SincParam.h.

template<class T>

virtual casacore::SincParam< T >::~SincParam

(

)

[virtual]

Destructor.

---

Member Function Documentation

template<class T>

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

(

)

const [inline, virtual]

Give name of function.

Reimplemented from casacore::Function< T >.

Definition at line 123 of file SincParam.h.

template<class T>

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

(

)

const [inline, virtual]

Returns the number of dimensions of function.

Implements casacore::Function< T >.

Definition at line 119 of file SincParam.h.

template<class T>

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

(

const SincParam< T > &

other

)

Copy assignment (deep copy).

Reimplemented in casacore::SincFunction< T >.

---

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

• casacore/scimath/Functionals/SincParam.h