casacore
Loading...
Searching...
No Matches
casacore::KaiserBFunction< T > Class Template Reference

More...

#include <KaiserBFunction.h>

Public Member Functions

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

Additional Inherited Members

- Public Types inherited from casacore::KaiserBParam< T >
enum  {
  HEIGHT ,
  CENTER ,
  WIDTH ,
  KBPAR
}
 Parameter numbers. More...
 
- Public Types inherited from casacore::Function< T, U >
typedef FunctionTraits< T >::ArgType ArgType
 
typedef const ArgTypeFunctionArg
 
- Protected Attributes inherited from casacore::Function< T, U >
FunctionParam< T > param_p
 The parameters and masks.
 
Vector< ArgTypearg_p
 Aid for non-contiguous argument storage.
 
Bool parset_p
 Indicate parameter written.
 
Bool locked_p
 Indicate that parameters are expected to be locked from changing.
 

Detailed Description

template<class T>
class casacore::KaiserBFunction< T >

A one dimensional Kaiser-Bessel function

Intended use:

Public interface

Review Status

Test programs:
tFunctionHolder

Prerequisite

Etymology

A Kaiser-Bessel function

Synopsis

A Kaiser-Bessel is described by a height, a center, a width (halfwidth) and a parameter. The parameters are enumerated by HEIGHT, CENTER, WIDTH, KBPAR. They have default values of (1, 0, 1, 2.5).

Example

Template Type Argument Requirements (T)

  • T should have standard numerical operators

Thrown Exceptions

  • AipsError if incorrect parameter number specified.

Definition at line 79 of file KaiserBFunction.h.

Constructor & Destructor Documentation

◆ KaiserBFunction() [1/4]

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

Constructs the KaiserBFunction, Defaults: height=1, center=0, width=1, kbpar=2.5.


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

Definition at line 88 of file KaiserBFunction.h.

Referenced by casacore::KaiserBFunction< T >::clone().

◆ KaiserBFunction() [2/4]

template<class T >
casacore::KaiserBFunction< T >::KaiserBFunction ( const T & kbpar)
inlineexplicit

Definition at line 89 of file KaiserBFunction.h.

◆ KaiserBFunction() [3/4]

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

Copy constructor (deep copy)

Definition at line 95 of file KaiserBFunction.h.

◆ KaiserBFunction() [4/4]

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

Definition at line 97 of file KaiserBFunction.h.

◆ ~KaiserBFunction()

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

Destructor.

Definition at line 106 of file KaiserBFunction.h.

Member Function Documentation

◆ clone()

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

Return a copy of this object from the heap.

The caller is responsible for deleting this pointer.

Implements casacore::Function< T, U >.

Definition at line 119 of file KaiserBFunction.h.

References casacore::KaiserBFunction< T >::KaiserBFunction().

◆ cloneAD()

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

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

Definition at line 120 of file KaiserBFunction.h.

◆ cloneNonAD()

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

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

Definition at line 122 of file KaiserBFunction.h.

◆ eval()

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

Evaluate the KaiserB at x.

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

◆ operator=()

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

Copy assignment (deep copy)

Definition at line 102 of file KaiserBFunction.h.

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


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