Документ взят из кэша поисковой машины. Адрес
оригинального документа
: http://www.atnf.csiro.au/computing/software/casacore/casacore-1.2.0/doc/html/classcasa_1_1Sinusoid1DParam.html
Дата изменения: Unknown Дата индексирования: Mon Feb 14 22:41:01 2011 Кодировка: Поисковые слова: antarctica |
Parameter handling for one dimensional Sinusoid class. More...
#include <Sinusoid1DParam.h>
Public Types | |
enum | { AMPLITUDE, PERIOD, X0 } |
Parameter numbers. More... | |
Public Member Functions | |
Sinusoid1DParam () | |
Constructs the Sinusoids, Defaults: amplitude=1, period==1, x0=0. | |
Sinusoid1DParam (const T &litude) | |
Sinusoid1DParam (const T &litude, const T &period) | |
Sinusoid1DParam (const T &litude, const T &period, const T &x0) | |
Sinusoid1DParam (const Sinusoid1DParam &other) | |
Copy constructor (deep copy). | |
template<class W > | |
Sinusoid1DParam (const Sinusoid1DParam< W > &other) | |
Sinusoid1DParam< T > & | operator= (const Sinusoid1DParam< T > &other) |
Copy assignment (deep copy). | |
virtual | ~Sinusoid1DParam () |
Destructor. | |
virtual const String & | name () const |
Give name of function. | |
T | amplitude () const |
Get or set the amplitude of the Sinusoid. | |
void | setAmplitude (const T &litude) |
T | x0 () const |
Get or set the x0 of the Sinusoid, the location of a peak. | |
void | setX0 (const T &x0) |
T | period () const |
Get or set the period of the Sinusoid in full cycles. | |
void | setPeriod (const T &period) |
Parameter handling for one dimensional Sinusoid class.
Internal
A 1-dimensional sinusoid's parameters.
A Sinusoid1D
is described by an amplitude, a period, and a location of a peak. The parameters (amplitude, period, and x0) may be changed at run time.
The functional form is A*cos(2*pi(x-x0)/P)
The parameter interface (see FunctionParam class), is used to provide an interface to the Fitting classes.
There are 3 parameters that are used to describe the Sinusoid:
amplitude
member function. period
member function. The period is expressed in full cycles. x=pi+k.2pi
) An enumeration for the AMPLITUDE
, PERIOD
and X0
parameter index is provided.
This class is in general used implicitly by the Sinusoid1D
class only.
Sinusoid1D<Double> sf(5.0, 25.0, 7); sf(25); // = -4.911 sf.setAmplitude(1.0); sf[Sinusoid1D<Double>::PERIOD] = 2.0; sf.setX0(0.0); sf(0.5); // = 1.0
Definition at line 109 of file Sinusoid1DParam.h.
anonymous enum |
Parameter numbers.
Definition at line 114 of file Sinusoid1DParam.h.
casa::Sinusoid1DParam< T >::Sinusoid1DParam | ( | ) |
Constructs the Sinusoids, Defaults: amplitude=1, period==1, x0=0.
I.e. a cosinusoid with cos(x)
.
Warning: Could not use default arguments that worked both with gcc and IRIX
casa::Sinusoid1DParam< T >::Sinusoid1DParam | ( | const T & | amplitude | ) | [explicit] |
casa::Sinusoid1DParam< T >::Sinusoid1DParam | ( | const T & | amplitude, | |
const T & | period | |||
) |
casa::Sinusoid1DParam< T >::Sinusoid1DParam | ( | const T & | amplitude, | |
const T & | period, | |||
const T & | x0 | |||
) |
casa::Sinusoid1DParam< T >::Sinusoid1DParam | ( | const Sinusoid1DParam< T > & | other | ) |
Copy constructor (deep copy).
casa::Sinusoid1DParam< T >::Sinusoid1DParam | ( | const Sinusoid1DParam< W > & | other | ) | [inline] |
Definition at line 132 of file Sinusoid1DParam.h.
virtual casa::Sinusoid1DParam< T >::~Sinusoid1DParam | ( | ) | [virtual] |
Destructor.
T casa::Sinusoid1DParam< T >::amplitude | ( | ) | const [inline] |
Get or set the amplitude of the Sinusoid.
Definition at line 151 of file Sinusoid1DParam.h.
virtual const String& casa::Sinusoid1DParam< T >::name | ( | ) | const [inline, virtual] |
Give name of function.
Reimplemented from casa::Function< T, T >.
Definition at line 146 of file Sinusoid1DParam.h.
Sinusoid1DParam<T>& casa::Sinusoid1DParam< T >::operator= | ( | const Sinusoid1DParam< T > & | other | ) |
Copy assignment (deep copy).
T casa::Sinusoid1DParam< T >::period | ( | ) | const [inline] |
Get or set the period of the Sinusoid in full cycles.
Definition at line 163 of file Sinusoid1DParam.h.
void casa::Sinusoid1DParam< T >::setAmplitude | ( | const T & | amplitude | ) | [inline] |
Definition at line 152 of file Sinusoid1DParam.h.
void casa::Sinusoid1DParam< T >::setPeriod | ( | const T & | period | ) | [inline] |
Definition at line 164 of file Sinusoid1DParam.h.
void casa::Sinusoid1DParam< T >::setX0 | ( | const T & | x0 | ) | [inline] |
Definition at line 158 of file Sinusoid1DParam.h.
T casa::Sinusoid1DParam< T >::x0 | ( | ) | const [inline] |
Get or set the x0 of the Sinusoid, the location of a peak.
Definition at line 157 of file Sinusoid1DParam.h.