Calibration::SingleAxisPolynomial Class Reference

A SingleAxis parameterized by Polynomial ordinates. More...

#include <SingleAxisPolynomial.h>

Inheritance diagram for Calibration::SingleAxisPolynomial:
MEAL::ChainRule< MEAL::Complex2 >

Public Member Functions

 SingleAxisPolynomial (unsigned ncoef=0)
 Default constructor.
 
 SingleAxisPolynomial (const SingleAxisPolynomial &)
 Copy constructor.
 
SingleAxisPolynomialoperator= (const SingleAxisPolynomial &)
 Assignment operator.
 
 ~SingleAxisPolynomial ()
 Destructor.
 
void set_abscissa (double value)
 Set the abscissa of each of the Polynomial functions. More...
 
void set_infit (unsigned coef, bool fit)
 Set the fit flag for the specified coefficient of each Polynomial.
 
void random (double max_result, double max_abscissa)
 Generate random Polynomial coefficients. More...
 
std::string get_name () const
 Return the name of the class.
 
void set_argument (unsigned dimension, MEAL::Argument *axis)
 Connect the set_abscissa method to the axis value.
 
- Public Member Functions inherited from MEAL::ChainRule< MEAL::Complex2 >
 ChainRule (const ChainRule &rule)
 
ChainRuleoperator= (const ChainRule &rule)
 
void set_model (T *model)
 
void set_constraint (unsigned iparam, Scalar *scalar)
 
std::string get_name () const
 

Static Public Attributes

static const unsigned npoly = 3
 The number of free parameters in the SingleAxis model. More...
 

Protected Attributes

std::vector< Reference::To< MEAL::Polynomial > > polynomial
 The Polynomial Functions.
 
Reference::To< SingleAxisxform
 The SingleAxis Complex2.
 
- Protected Attributes inherited from MEAL::ChainRule< MEAL::Complex2 >
std::vector< ConstrainedParameterconstraints
 
Project< T > model
 

Additional Inherited Members

- Protected Member Functions inherited from MEAL::ChainRule< MEAL::Complex2 >
void calculate (Result &result, std::vector< Result > *gradient)
 
ConstrainedParameterfind_constraint (unsigned iparam)
 

Detailed Description

A SingleAxis parameterized by Polynomial ordinates.

This class provides an example use of the ChainRule class. The SingleAxis Complex2 is used so that the gain, differential gain, and differential phase vary separately as polynomial functions of an independent variable. This class is used in test_ReceptionModel as a verification of the underlying assumptions of the ChainRule.

Member Function Documentation

◆ random()

void Calibration::SingleAxisPolynomial::random ( double  max_result,
double  max_abscissa 
)

Generate random Polynomial coefficients.

Parameters
max_resultthe maximum value produced by the polynomials
max_abscissathe maximum absolute value of the abscissa

◆ set_abscissa()

void Calibration::SingleAxisPolynomial::set_abscissa ( double  value)

Set the abscissa of each of the Polynomial functions.

Set the abscissa of each of the polynomial functions.

Referenced by set_argument().

Member Data Documentation

◆ npoly

const unsigned Calibration::SingleAxisPolynomial::npoly = 3
static

The number of free parameters in the SingleAxis model.

Each of the free parameters will be constrained by a Polynomial Function


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

Generated using doxygen 1.8.17