casacore::DiracDParam< T > Class Template Reference

A one dimensional Dirac delta function. More...

#include <DiracDParam.h>

Inheritance diagram for casacore::DiracDParam< T >:

List of all members.

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

A one dimensional Dirac delta function.

Intended use:

Internal

Review Status

Test programs:

tFunctionHolder

Prerequisite

• FunctionParam class
• Function class

Etymology

A 1-dimensional Dirac delta.

Synopsis

A DiracD is described by a height and a center The value is:

 height          (|x-center| == 0.0)
 0               (|x-center| != 0.0)

The parameters are enumerated by HEIGHT, CENTER. They have default values of (1, 0).

Example

 DiracDFunction<Double> sf(5.0, 25.0);
 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 84 of file DiracDParam.h.

---

Member Enumeration Documentation

template<class T>

anonymous enum

Parameter numbers.

Enumerator:

HEIGHT
CENTER

Definition at line 89 of file DiracDParam.h.

---

Constructor & Destructor Documentation

template<class T>

casacore::DiracDParam< T >::DiracDParam

(

)

Constructs the DiracD, Defaults: height=1, center=0.

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

template<class T>

casacore::DiracDParam< T >::DiracDParam

(

const T &

height

)

[explicit]

template<class T>

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

template<class T>

casacore::DiracDParam< T >::DiracDParam

(

const DiracDParam< T > &

other

)

Copy constructor (deep copy).

template<class T>

template<class W >

casacore::DiracDParam< T >::DiracDParam

(

const DiracDParam< W > &

other

)

[inline]

Definition at line 106 of file DiracDParam.h.

template<class T>

virtual casacore::DiracDParam< T >::~DiracDParam

(

)

[virtual]

Destructor.

---

Member Function Documentation

template<class T>

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

(

)

const [inline, virtual]

Give name of function.

Reimplemented from casacore::Function< T >.

Definition at line 120 of file DiracDParam.h.

template<class T>

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

(

)

const [inline, virtual]

Returns the number of dimensions of function.

Implements casacore::Function< T >.

Definition at line 116 of file DiracDParam.h.

template<class T>

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

(

const DiracDParam< T > &

other

)

Copy assignment (deep copy).

Reimplemented in casacore::DiracDFunction< T >.

---

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

• casacore/scimath/Functionals/DiracDParam.h