casacore::UnaryParam< T > Class Template Reference

Parameter handling for one dimensional unary function. More...

#include <UnaryParam.h>

Inheritance diagram for casacore::UnaryParam< T >:

List of all members.

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

Parameter handling for one dimensional unary function.

Intended use:

Internal

Review Status

Test programs:

tFunctionHolder

Prerequisite

• FunctionParam class
• Function class

Etymology

A 1-dimensional unary hat.

Synopsis

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

 height          (|x-center| <  width)
 0.5height          (|x-center| == width)
 0               (|x-center| >  width)

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

Example

 UnaryFunction<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 UnaryParam.h.

---

Member Enumeration Documentation

template<class T>

anonymous enum

Parameter numbers.

Enumerator:

HEIGHT
CENTER
WIDTH

Definition at line 90 of file UnaryParam.h.

---

Constructor & Destructor Documentation

template<class T>

casacore::UnaryParam< T >::UnaryParam

(

)

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

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

template<class T>

casacore::UnaryParam< T >::UnaryParam

(

const T &

height

)

[explicit]

template<class T>

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

template<class T>

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

template<class T>

casacore::UnaryParam< T >::UnaryParam

(

const UnaryParam< T > &

other

)

Copy constructor (deep copy).

template<class T>

template<class W >

casacore::UnaryParam< T >::UnaryParam

(

const UnaryParam< W > &

other

)

[inline]

Definition at line 108 of file UnaryParam.h.

template<class T>

virtual casacore::UnaryParam< T >::~UnaryParam

(

)

[virtual]

Destructor.

---

Member Function Documentation

template<class T>

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

(

)

const [inline, virtual]

Give name of function.

Reimplemented from casacore::Function< T >.

Definition at line 123 of file UnaryParam.h.

template<class T>

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

(

)

const [inline, virtual]

Returns the number of dimensions of function.

Implements casacore::Function< T >.

Definition at line 119 of file UnaryParam.h.

template<class T>

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

(

const UnaryParam< T > &

other

)

Copy assignment (deep copy).

Reimplemented in casacore::UnaryFunction< T >.

---

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

• casacore/scimath/Functionals/UnaryParam.h