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

Exponential times a Sinc. More...

#include <MathFunc.h>

Public Member Functions

 ExpSincConv (T cut=MathFunc< T >::defcutoff(), T sincparm=MathFunc< T >::defSincparm(), T exppow=MathFunc< T >::defExpPower(), T expscale=MathFunc< T >::defExpScale())
 default constructor More...
 
 ExpSincConv (const ExpSincConv< T > &)
 copy constructor More...
 
ExpSincConv< T > & operator= (const ExpSincConv< T > &)
 assignment operator More...
 
sup_value () const
 get access to the support width More...
 
value (const T &) const
 and get the value of the function More...
 
FuncId id () const
 return FuncID structure for Table storage/retrieval. More...
 
- Public Member Functions inherited from casacore::MathFunc< T >
 MathFunc (FUNCTYPE)
 constructors More...
 
 MathFunc (FUNCTYPE, T cutoff, T arg1=1.0e+30, T arg2=1.0e+30, T arg3=1.0e+30)
 accept up to 4 arguments, the first being the support radius More...
 
 MathFunc (String &, Vector< double > &)
 
 MathFunc (const MathFunc< T > &)
 
 MathFunc (MathFunc< T > *)
 
virtual ~MathFunc ()
 Destructor. More...
 
MathFunc< T > & operator= (const MathFunc< T > &)
 Assignment operator - Note: this function works only for envelops. More...
 

Private Member Functions

MathFunc< T > * clone () const
 for every derived class, return new of that class with its own parameters More...
 

Private Attributes

sup_width
 
scale
 
exponent
 
sincpByPi
 

Additional Inherited Members

- Static Public Member Functions inherited from casacore::MathFunc< T >
static MathFunc< T > * newMathFunc (const MathFunc< T > &)
 create a new math function More...
 
static T defcutoff ()
 These functions return the static constants used as default parameters for the various derived functions. More...
 
static T defwidth ()
 The default width for Gaussian_Conv. More...
 
static T defKBwidth ()
 The default width for KB_Conv and Mod_KB_Conv. More...
 
static T defKBparm ()
 A default parameter for KB_Conv and Mod_KB_Conv. More...
 
static T defmodKBparm ()
 A default parameter for Mod_KB_Conv. More...
 
static T defSphcutoff ()
 The default support radius for Sinc_Conv and Sph_Conv. More...
 
static T defSincparm ()
 The default Sinc parameter for Sinc_Conv and Exp_Sinc_Conv. More...
 
static T defSphparm ()
 The default parameter for Sph_Conv. More...
 
static T defExpPower ()
 The default exponential power for Exp_Sinc_Conv. More...
 
static T defExpScale ()
 The default exponential scale length for Exp_Sinc_Conv. More...
 
- Protected Member Functions inherited from casacore::MathFunc< T >
 MathFunc ()
 Default constructor (Null) More...
 
- Protected Attributes inherited from casacore::MathFunc< T >
MathFunc< T > * object
 pointer to letter class More...
 

Detailed Description

template<class T>
class casacore::ExpSincConv< T >

Exponential times a Sinc.

Synopsis

An Exponential times a Sinc

The value(T &x) is given by Exp(-(abs(x) / expscale) ** exppow) * Sinc(pi * x / sincparm)

where the 3 paramaters correspond to those in the default constructor Note that the default case of exppow = 2 is a Gaussian times a Sinc. Since this is often a useful case, that parameter appears last in the constructor.

Definition at line 505 of file MathFunc.h.

Constructor & Destructor Documentation

◆ ExpSincConv() [1/2]

template<class T >
casacore::ExpSincConv< T >::ExpSincConv ( cut = MathFunc< T >::defcutoff(),
sincparm = MathFunc< T >::defSincparm(),
exppow = MathFunc< T >::defExpPower(),
expscale = MathFunc< T >::defExpScale() 
)

default constructor

◆ ExpSincConv() [2/2]

template<class T >
casacore::ExpSincConv< T >::ExpSincConv ( const ExpSincConv< T > &  )

copy constructor

Member Function Documentation

◆ clone()

template<class T >
MathFunc<T>* casacore::ExpSincConv< T >::clone ( ) const
privatevirtual

for every derived class, return new of that class with its own parameters

Reimplemented from casacore::MathFunc< T >.

◆ id()

template<class T >
FuncId casacore::ExpSincConv< T >::id ( ) const
virtual

return FuncID structure for Table storage/retrieval.

Reimplemented from casacore::MathFunc< T >.

◆ operator=()

template<class T >
ExpSincConv<T>& casacore::ExpSincConv< T >::operator= ( const ExpSincConv< T > &  )

assignment operator

◆ sup_value()

template<class T >
T casacore::ExpSincConv< T >::sup_value ( ) const
inlinevirtual

get access to the support width

Reimplemented from casacore::MathFunc< T >.

Definition at line 522 of file MathFunc.h.

References casacore::ExpSincConv< T >::sup_width.

◆ value()

template<class T >
T casacore::ExpSincConv< T >::value ( const T &  ) const
virtual

and get the value of the function

Reimplemented from casacore::MathFunc< T >.

Member Data Documentation

◆ exponent

template<class T >
T casacore::ExpSincConv< T >::exponent
private

Definition at line 534 of file MathFunc.h.

◆ scale

template<class T >
T casacore::ExpSincConv< T >::scale
private

Definition at line 534 of file MathFunc.h.

◆ sincpByPi

template<class T >
T casacore::ExpSincConv< T >::sincpByPi
private

Definition at line 534 of file MathFunc.h.

◆ sup_width

template<class T >
T casacore::ExpSincConv< T >::sup_width
private

Definition at line 534 of file MathFunc.h.

Referenced by casacore::ExpSincConv< T >::sup_value().


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