casacore::SincParam< T > Class Template Reference

More...

#include <SincParam.h>

Public Types
enum	{   HEIGHT ,   CENTER ,   WIDTH }
	Parameter numbers. More...
Public Types inherited from casacore::Function< T, U >
typedef FunctionTraits< T >::ArgType	ArgType
typedef const ArgType *	FunctionArg

Public Member Functions
	SincParam ()
	Constructs the Sinc, Defaults: height=1, center=0, width=1. More...
	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) More...
template<class W >
	SincParam (const SincParam< W > &other)
SincParam< T > &	operator= (const SincParam< T > &other)
	Copy assignment (deep copy) More...
virtual	~SincParam ()
	Destructor. More...
virtual uInt	ndim () const
	Returns the number of dimensions of function. More...
virtual const String &	name () const
	Give name of function. More...
Public Member Functions inherited from casacore::Function< T, U >
	Function ()
	Constructors. More...
	Function (const uInt n)
	Function (const Vector< T > &in)
	Function (const FunctionParam< T > &other)
template<class W , class X >
	Function (const Function< W, X > &other)
virtual	~Function ()
	Destructor. More...
uInt	nparameters () const
	Returns the number of parameters. More...
virtual U	eval (FunctionArg x) const =0
	Evaluate the function object. More...
T &	operator[] (const uInt n)
	Manipulate the nth parameter (0-based) with no index check. More...
const T &	operator[] (const uInt n) const
virtual U	operator() () const
	Evaluate this function object at xor at x, y. More...
virtual U	operator() (const ArgType &x) const
virtual U	operator() (const Vector< ArgType > &x) const
virtual U	operator() (FunctionArg x) const
virtual U	operator() (const ArgType &x, const ArgType &y) const
virtual U	operator() (const ArgType &x, const ArgType &y, const ArgType &z) const
Bool &	mask (const uInt n)
	Manipulate the mask associated with the nth parameter (e.g. More...
const Bool &	mask (const uInt n) const
const FunctionParam< T > &	parameters () const
	Return the parameter interface. More...
FunctionParam< T > &	parameters ()
const Vector< ArgType > &	argp () const
	Get arg_p and parset_p. More...
Bool	parsetp () const
void	lockParam ()
	Compiler cannot always find the correct 'const' version of parameter access. More...
void	unlockParam ()
virtual void	setMode (const RecordInterface &mode)
	get/set the function mode. More...
virtual void	getMode (RecordInterface &mode) const
virtual Bool	hasMode () const
	return True if the implementing function supports a mode. More...
ostream &	print (ostream &os) const
	Print the function (i.e. More...
virtual Function< T, U > *	clone () const =0
	Return a copy of this object from the heap. More...
virtual Function< typename FunctionTraits< T >::DiffType > *	cloneAD () const
virtual Function< typename FunctionTraits< T >::BaseType > *	cloneNonAD () const
Public Member Functions inherited from casacore::Functional< FunctionTraits< T >::ArgType, T >
virtual	~Functional ()
	Destructor. More...
virtual T	operator() (const FunctionTraits< T >::ArgType &x) const=0
	Map a Domain x into a Range y value. More...
Public Member Functions inherited from casacore::Functional< Vector< FunctionTraits< T >::ArgType >, T >
virtual	~Functional ()
	Destructor. More...
virtual T	operator() (const Vector< FunctionTraits< T >::ArgType > &x) const=0
	Map a Domain x into a Range y value. More...

Additional Inherited Members
Protected Attributes inherited from casacore::Function< T, U >
FunctionParam< T >	param_p
	The parameters and masks. More...
Vector< ArgType >	arg_p
	Aid for non-contiguous argument storage. More...
Bool	parset_p
	Indicate parameter written. More...
Bool	locked_p
	Indicate that parameters are expected to be locked from changing. More...

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

anonymous enum

template<class T >

anonymous enum

Parameter numbers.

Enumerator
HEIGHT
CENTER
WIDTH

Definition at line 90 of file SincParam.h.

Constructor & Destructor Documentation

SincParam() [1/6]

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

SincParam() [2/6]

template<class T >

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

explicit

SincParam() [3/6]

template<class T >

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

SincParam() [4/6]

template<class T >

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

SincParam() [5/6]

template<class T >

casacore::SincParam< T >::SincParam

(

const SincParam< T > &

other

)

Copy constructor (deep copy)

SincParam() [6/6]

template<class T >

template<class W >

casacore::SincParam< T >::SincParam ( const SincParam< W > &  other )

inline

Definition at line 108 of file SincParam.h.

~SincParam()

template<class T >

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

virtual

Destructor.

Member Function Documentation

name()

template<class T >

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

inlinevirtual

Give name of function.

Reimplemented from casacore::Function< T, U >.

Definition at line 123 of file SincParam.h.

ndim()

template<class T >

virtual uInt casacore::SincParam< T >::ndim ( ) const

inlinevirtual

Returns the number of dimensions of function.

Implements casacore::Function< T, U >.

Definition at line 119 of file SincParam.h.

operator=()

template<class T >

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

(

const SincParam< T > &

other

)

Copy assignment (deep copy)

Referenced by casacore::SincFunction< T >::operator=().

---

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

• scimath/Functionals/SincParam.h