casacore
Public Member Functions | List of all members
casacore::SincFunction< T > Class Template Reference

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

#include <SincFunction.h>

Public Member Functions

 SincFunction ()
 Constructs the SincFunction, Defaults: height=1, center=0, width=1. More...
 
 SincFunction (const T &height)
 
 SincFunction (const T &height, const T &center)
 
 SincFunction (const T &height, const T &center, const T &width)
 
 SincFunction (const SincFunction< T > &other)
 Copy constructor (deep copy) More...
 
template<class W >
 SincFunction (const SincFunction< W > &other)
 
SincFunction< T > & operator= (const SincFunction< T > &other)
 Copy assignment (deep copy) More...
 
virtual ~SincFunction ()
 Destructor. More...
 
virtual T eval (typename Function< T >::FunctionArg x) const
 Evaluate the Sinc at x. More...
 
virtual Function< T > * clone () const
 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::SincParam< T >
 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
 
virtual const Stringname () const
 Give name of function. More...
 
- Public Member Functions inherited from casacore::Function< T >
 Function ()
 Constructors. More...
 
 Function (const uInt n)
 
 Function (const Vector< T > &in)
 
 Function (const FunctionParam< T > &other)
 
 Function (const Function< W, X > &other)
 
 Function (const Function< T, T > &other)
 
virtual ~Function ()
 Destructor. More...
 
virtual uInt ndim () const=0
 Returns the number of dimensions of function. More...
 
uInt nparameters () const
 Returns the number of parameters. More...
 
virtual T 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 T operator() () const
 Evaluate this function object at xor at x, y. More...
 
virtual T operator() (const ArgType &x) const
 
virtual T operator() (const Vector< ArgType > &x) const
 
virtual T operator() (FunctionArg x) const
 
virtual T operator() (const ArgType &x, const ArgType &y) const
 
virtual T operator() (const ArgType &x, const ArgType &y, const ArgType &z) const
 
virtual const Stringname () const
 Specify the name associated with the function (default will be unknown) More...
 
Boolmask (const uInt n)
 Manipulate the mask associated with the nth parameter (e.g. More...
 
const Boolmask (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, T > * 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
 

Additional Inherited Members

- Public Types inherited from casacore::SincParam< T >
enum  {
  HEIGHT,
  CENTER,
  WIDTH
}
 Parameter numbers. More...
 
- Public Types inherited from casacore::Function< T >
typedef FunctionTraits< T >::ArgType ArgType
 
- Public Attributes inherited from casacore::Function< T >
const typedef ArgTypeFunctionArg
 
- Protected Attributes inherited from casacore::Function< T >
FunctionParam< T > param_p
 The parameters and masks. More...
 
Vector< ArgTypearg_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::SincFunction< T >

A one dimensional sin(x)/x.

Intended use:

Public interface

Review Status

Reviewed By:
UNKNOWN
Date Reviewed:
before2004/08/25
Test programs:
tFunctionHolder

Prerequisite

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)

Thrown Exceptions

Definition at line 86 of file SincFunction.h.

Constructor & Destructor Documentation

◆ SincFunction() [1/6]

template<class T >
casacore::SincFunction< T >::SincFunction ( )
inline

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


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

Definition at line 95 of file SincFunction.h.

◆ SincFunction() [2/6]

template<class T >
casacore::SincFunction< T >::SincFunction ( const T &  height)
inlineexplicit

Definition at line 96 of file SincFunction.h.

◆ SincFunction() [3/6]

template<class T >
casacore::SincFunction< T >::SincFunction ( const T &  height,
const T &  center 
)
inline

Definition at line 98 of file SincFunction.h.

◆ SincFunction() [4/6]

template<class T >
casacore::SincFunction< T >::SincFunction ( const T &  height,
const T &  center,
const T &  width 
)
inline

Definition at line 100 of file SincFunction.h.

◆ SincFunction() [5/6]

template<class T >
casacore::SincFunction< T >::SincFunction ( const SincFunction< T > &  other)
inline

Copy constructor (deep copy)

Definition at line 106 of file SincFunction.h.

◆ SincFunction() [6/6]

template<class T >
template<class W >
casacore::SincFunction< T >::SincFunction ( const SincFunction< W > &  other)
inline

Definition at line 108 of file SincFunction.h.

◆ ~SincFunction()

template<class T >
virtual casacore::SincFunction< T >::~SincFunction ( )
inlinevirtual

Destructor.

Definition at line 116 of file SincFunction.h.

Member Function Documentation

◆ clone()

template<class T >
virtual Function<T>* casacore::SincFunction< T >::clone ( ) const
inlinevirtual

Return a copy of this object from the heap.

The caller is responsible for deleting this pointer.

Definition at line 129 of file SincFunction.h.

◆ cloneAD()

template<class T >
virtual Function<typename FunctionTraits<T>::DiffType>* casacore::SincFunction< T >::cloneAD ( ) const
inlinevirtual

Definition at line 130 of file SincFunction.h.

◆ cloneNonAD()

template<class T >
virtual Function<typename FunctionTraits<T>::BaseType>* casacore::SincFunction< T >::cloneNonAD ( ) const
inlinevirtual

Definition at line 132 of file SincFunction.h.

◆ eval()

template<class T >
virtual T casacore::SincFunction< T >::eval ( typename Function< T >::FunctionArg  x) const
virtual

Evaluate the Sinc at x.

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

◆ operator=()

template<class T >
SincFunction<T>& casacore::SincFunction< T >::operator= ( const SincFunction< T > &  other)
inline

Copy assignment (deep copy)

Definition at line 112 of file SincFunction.h.

References casacore::SincParam< T >::operator=().


The documentation for this class was generated from the following file:
casacore::C::pi
const Double pi
Pi and functions thereof:
casacore::sin
LatticeExprNode sin(const LatticeExprNode &expr)
Numerical 1-argument functions.