Time based linear equation class. More...

#include <Basis1VariableFunction.h>

Inheritance diagram for Isis::Basis1VariableFunction:

Collaboration diagram for Isis::Basis1VariableFunction:

Public Member Functions
	Basis1VariableFunction (const QString &name, int numCoefs)
	Creates a Basis Function with a single variable.

virtual	~Basis1VariableFunction ()
	Destroys the Basis1VariableFunction object.

virtual double	DerivativeVar (const double value)=0
	This will take the Derivative with respect to the variable and evaluate at given value.

virtual double	DerivativeCoef (const double value, const int coefIndex)=0
	Evaluate the derivative defined by the given coefficients with respect to the coefficient at the given index, at the current value.

void	SetCoefficients (const std::vector< double > &coefs)
	Set the coefficients for the equation.

double	Evaluate (const std::vector< double > &vars)
	Compute the equation using the input variables.

double	Evaluate (const double &var)
	Compute the equation using the input variable.

virtual void	Expand (const std::vector< double > &vars)
	This is the function you should replace depending on your needs.

int	Coefficients () const
	Returns the number of coefficients for the equation.

int	Variables () const
	Returns the number of variables in the equation.

QString	Name () const
	Returns the name of the equation.

double	Term (int c) const
	Returns the cth term.

double	Coefficient (int i) const
	Returns the ith coefficient.

Protected Attributes
QString	p_name
	The name of the equation. Call it by using Name()

int	p_numVars
	The number of variables in the equation. Call it by using Variables()

int	p_numCoefs
	The number of coefficients in the equation.

std::vector< double >	p_coefs
	A vector of the coefficients in the equation.

std::vector< double >	p_terms
	A vector of the terms in the equation.

Detailed Description

Time based linear equation class.

This is a class for generating a general one-variable equation for the Isis least squares fitting algorithm (IsisLSQ). It allows the programmer to set up equations in the form of:

\[ x = C1*T1 + C2*T2 + ... + CN*TN; \]

where C1-CN are coefficients and T1-TN are terms with a single variable. For example,

\[ x = C1 + C2*t + C3*t**2 \]

Author: 2004-06-24 Jeff Anderson

Todo: Add coded example

History

2005-03-16 Leah Dahmer - modified file to support Doxygen documentation.

2008-01-08 Tracie Sucharski - Derived from BasisFunction class for a single variable function. Added Derivative methods as pure virtuals. This class was developed as a convenience to simplify the Derivative methods and any other methods that might need to be developed in the future.

2017-08-30 Summer Stapleton - Updated documentation. References #4807.

Definition at line 50 of file Basis1VariableFunction.h.

Constructor & Destructor Documentation

◆ Basis1VariableFunction()

Isis::Basis1VariableFunction::Basis1VariableFunction	(	const QString &	name,
		int	numCoefs )

Creates a Basis Function with a single variable.

Parameters

name	Name of the Basis1VariableFunction. For example, "affine".
numCoefs	Number of coefficients in the equation. For example: \[ x = C1 + C2 * x + C3 * x**2 \] has three coefficients: C1, C2 & C3.

Definition at line 25 of file Basis1VariableFunction.cpp.

◆ ~Basis1VariableFunction()

virtual Isis::Basis1VariableFunction::~Basis1VariableFunction ( )

inlinevirtual

Destroys the Basis1VariableFunction object.

Definition at line 54 of file Basis1VariableFunction.h.

Member Function Documentation

◆ Coefficient()

double Isis::BasisFunction::Coefficient ( int i ) const

inlineinherited

Returns the ith coefficient.

Parameters

i	The index for the desired coefficient.

Returns: The ith coefficient

Definition at line 107 of file BasisFunction.h.

References Isis::BasisFunction::p_coefs.

Referenced by Isis::PolynomialUnivariate::DerivativeVar(), Isis::SurfaceModel::MinMax(), and Isis::OverlapNormalization::Solve().

◆ Coefficients()

int Isis::BasisFunction::Coefficients ( ) const

inlineinherited

Returns the number of coefficients for the equation.

Returns: The number of coefficients.

Definition at line 64 of file BasisFunction.h.

References Isis::BasisFunction::p_numCoefs.

Referenced by Isis::PolynomialUnivariate::DerivativeCoef(), Isis::PolynomialUnivariate::DerivativeVar(), Isis::OverlapNormalization::Solve(), Isis::LeastSquares::SolveQRD(), and Isis::LeastSquares::SolveSVD().

◆ DerivativeCoef()

virtual double Isis::Basis1VariableFunction::DerivativeCoef	(	const double	value,
		const int	coefIndex )

pure virtual

Evaluate the derivative defined by the given coefficients with respect to the coefficient at the given index, at the current value.

Parameters

[in]	value	(const double) value at which to evaluate derivative
[in]	coefIndex	(const int) The index of the coefficient to differentiate with respect to

Returns: (double) The derivative evaluated at given value

Implemented in Isis::PolynomialUnivariate.

◆ DerivativeVar()

virtual double Isis::Basis1VariableFunction::DerivativeVar ( const double value )

pure virtual

This will take the Derivative with respect to the variable and evaluate at given value.

Parameters

[in] value (const double) value at which to evaluate derivative

Returns: (double) The derivative evaluated at given value

Implemented in Isis::PolynomialUnivariate.

◆ Evaluate() [1/2]

double Isis::BasisFunction::Evaluate ( const double & var )

inherited

Compute the equation using the input variable.

Parameters

var	A single double value to use for the equation.

Returns: The output double value resulting from the equation.

Definition at line 101 of file BasisFunction.cpp.

References Isis::BasisFunction::Evaluate().

◆ Evaluate() [2/2]

double Isis::BasisFunction::Evaluate ( const std::vector< double > & vars )

inherited

Compute the equation using the input variables.

Parameters

vars	A vector of double values to use for the equation. After setting the coefficients, this can be invoked many times to compute output values given input values.

Returns: The output value.

Definition at line 64 of file BasisFunction.cpp.

References Isis::BasisFunction::Expand(), Isis::BasisFunction::p_coefs, Isis::BasisFunction::p_numCoefs, Isis::BasisFunction::p_numVars, Isis::BasisFunction::p_terms, Isis::IException::Programmer, and Isis::toString().

Referenced by Isis::BasisFunction::Evaluate(), Isis::LeastSquares::Evaluate(), Isis::LeastSquares::SolveQRD(), and Isis::LeastSquares::SolveSVD().

◆ Expand()

void Isis::BasisFunction::Expand ( const std::vector< double > & vars )

virtualinherited

This is the function you should replace depending on your needs.

It will expand the variables into the terms of the equation. For example,

\[ x = C1 + C2*y + C3*z + C4*y*z \]

must be expanded into the p_terms vector as (1.0, y, z, y*z). Note that the term expansion is not limited, you can use cos, sin, sqrt, abs, etc. This virtual method is automatically invoked by the Evaluate method. We provide a default expansion of p_terms = vars, just a linear combination of the variables.

Parameters