casa::DiracDFunction< T > Class Template Reference

A one dimensional Dirac delta function. More...

#include <DiracDFunction.h>

Inheritance diagram for casa::DiracDFunction< T >:

List of all members.

Public Member Functions
	DiracDFunction ()
	Constructs the DiracDFunction, Defaults: height=1, center=0.
	DiracDFunction (const T &height)
	DiracDFunction (const T &height, const T &center)
	DiracDFunction (const DiracDFunction< T > &other)
	Copy constructor (deep copy)
template<class W >
	DiracDFunction (const DiracDFunction< W > &other)
DiracDFunction< T > &	operator= (const DiracDFunction< T > &other)
	Copy assignment (deep copy)
virtual	~DiracDFunction ()
	Destructor.
virtual T	eval (typename Function< T >::FunctionArg x) const
	Evaluate the DiracD 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::DiracDFunction< T >

A one dimensional Dirac delta function.

Intended use:

Public interface

Review Status

Test programs:

tFunctionHolder

Prerequisite

• DiracDParam
• Function

Etymology

A 1-dimensional Dirac delta.

Synopsis

A DiracD is described by a height, a center and a width (halfwidth). The value is:

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

The parameters are enumerated by HEIGHT, CENTER and WIDTH. 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 85 of file DiracDFunction.h.

---

Constructor & Destructor Documentation

template<class T>

casa::DiracDFunction< T >::DiracDFunction

(

)

[inline]

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

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

Definition at line 94 of file DiracDFunction.h.

template<class T>

casa::DiracDFunction< T >::DiracDFunction

(

const T &

height

)

[inline, explicit]

Definition at line 95 of file DiracDFunction.h.

template<class T>

casa::DiracDFunction< T >::DiracDFunction	(	const T &	height,
		const T &	center
	)		[inline]

Definition at line 97 of file DiracDFunction.h.

template<class T>

casa::DiracDFunction< T >::DiracDFunction

(

const DiracDFunction< T > &

other

)

[inline]

Copy constructor (deep copy)

Definition at line 103 of file DiracDFunction.h.

template<class T>

template<class W >

casa::DiracDFunction< T >::DiracDFunction

(

const DiracDFunction< W > &

other

)

[inline]

Definition at line 105 of file DiracDFunction.h.

template<class T>

virtual casa::DiracDFunction< T >::~DiracDFunction

(

)

[inline, virtual]

Destructor.

Definition at line 113 of file DiracDFunction.h.

---

Member Function Documentation

template<class T>

virtual Function<T>* casa::DiracDFunction< 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 126 of file DiracDFunction.h.

template<class T>

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

(

)

const [inline, virtual]

Reimplemented from casa::Function< T >.

Definition at line 127 of file DiracDFunction.h.

template<class T>

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

(

)

const [inline, virtual]

Reimplemented from casa::Function< T >.

Definition at line 129 of file DiracDFunction.h.

template<class T>

virtual T casa::DiracDFunction< T >::eval

(

typename Function< T >::FunctionArg

x

)

const [virtual]

Evaluate the DiracD at x.

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

template<class T>

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

(

const DiracDFunction< T > &

other

)

[inline]

Copy assignment (deep copy)

Definition at line 109 of file DiracDFunction.h.

---

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

• casacore/scimath/Functionals/DiracDFunction.h