casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions
casa::Sinusoid1DParam< T > Class Template Reference

Parameter handling for one dimensional Sinusoid class. More...

#include <Sinusoid1DParam.h>

Inheritance diagram for casa::Sinusoid1DParam< T >:
casa::Function1D< T > casa::Function< T, T > casa::Functional< FunctionTraits< T >::ArgType, T > casa::Functional< Vector< FunctionTraits< T >::ArgType >, T > casa::Sinusoid1D< T >

List of all members.

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 &amplitude)
 Sinusoid1DParam (const T &amplitude, const T &period)
 Sinusoid1DParam (const T &amplitude, 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 Stringname () const
 Give name of function.
amplitude () const
 Get or set the amplitude of the Sinusoid.
void setAmplitude (const T &amplitude)
x0 () const
 Get or set the x0 of the Sinusoid, the location of a peak.
void setX0 (const T &x0)
period () const
 Get or set the period of the Sinusoid in full cycles.
void setPeriod (const T &period)

Detailed Description

template<class T>
class casa::Sinusoid1DParam< T >

Parameter handling for one dimensional Sinusoid class.

Intended use:

Internal

Review Status

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

Prerequisite

Etymology

A 1-dimensional sinusoid's parameters.

Synopsis

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:

  1. The amplitude of the Sinusoid. This is the value returned using the amplitude member function.
  2. The period of the Sinusoid in the x direction. This is the value returned using the period member function. The period is expressed in full cycles.
  3. The location of a peak of the Sinusoid (i.e. where 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.

Example

       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

Template Type Argument Requirements (T)

Thrown Exceptions

Definition at line 109 of file Sinusoid1DParam.h.


Member Enumeration Documentation

template<class T>
anonymous enum

Parameter numbers.

Enumerator:
AMPLITUDE 
PERIOD 
X0 

Definition at line 114 of file Sinusoid1DParam.h.


Constructor & Destructor Documentation

template<class T>
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

template<class T>
casa::Sinusoid1DParam< T >::Sinusoid1DParam ( const T &  amplitude) [explicit]
template<class T>
casa::Sinusoid1DParam< T >::Sinusoid1DParam ( const T &  amplitude,
const T &  period 
)
template<class T>
casa::Sinusoid1DParam< T >::Sinusoid1DParam ( const T &  amplitude,
const T &  period,
const T &  x0 
)
template<class T>
casa::Sinusoid1DParam< T >::Sinusoid1DParam ( const Sinusoid1DParam< T > &  other)

Copy constructor (deep copy)

template<class T>
template<class W >
casa::Sinusoid1DParam< T >::Sinusoid1DParam ( const Sinusoid1DParam< W > &  other) [inline]

Definition at line 132 of file Sinusoid1DParam.h.

template<class T>
virtual casa::Sinusoid1DParam< T >::~Sinusoid1DParam ( ) [virtual]

Destructor.


Member Function Documentation

template<class T>
T casa::Sinusoid1DParam< T >::amplitude ( ) const [inline]

Get or set the amplitude of the Sinusoid.

Definition at line 151 of file Sinusoid1DParam.h.

Referenced by casa::Sinusoid1DParam< AutoDiff< T > >::setAmplitude().

template<class T>
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.

template<class T>
Sinusoid1DParam<T>& casa::Sinusoid1DParam< T >::operator= ( const Sinusoid1DParam< T > &  other)

Copy assignment (deep copy)

template<class T>
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.

Referenced by casa::Sinusoid1DParam< AutoDiff< T > >::setPeriod().

template<class T>
void casa::Sinusoid1DParam< T >::setAmplitude ( const T &  amplitude) [inline]

Definition at line 152 of file Sinusoid1DParam.h.

template<class T>
void casa::Sinusoid1DParam< T >::setPeriod ( const T &  period) [inline]

Definition at line 164 of file Sinusoid1DParam.h.

template<class T>
void casa::Sinusoid1DParam< T >::setX0 ( const T &  x0) [inline]

Definition at line 158 of file Sinusoid1DParam.h.

template<class T>
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.

Referenced by casa::Sinusoid1DParam< AutoDiff< T > >::setX0().


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