USGS Astrogeology Isis API

This is a derived class from BasisFunction which provides the capabilities of a polynomial equation in two variables with degree n, where n is specified during the object construction. For example, Degree = 1 z = a + b*x + c*y Degree = 2 z = a + b*x + c*y + d*x**2 + e*x*y + f*y**2 Degree = 3 z = a + b*x + c*y + d*x**2 + e*x*y + f*y**2 + g*x**3 + h*x**2*y + i*x*y**2 + j*y**3 In general the number of coefficients will be ((degree+1)*(degree+2))/2.

Definition at line 53 of file PolynomialBivariate.h.


Public Member Functions
	PolynomialBivariate (int degree)
	Create a PolynomialBivariate object.
	~PolynomialBivariate ()
	Destroys the PolynomialBivariate object.
void	Expand (const std::vector< double > &vars)
	This is the the overriding virtual function that provides the expansion of the two input variables into the polynomial equation.
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.
int	Coefficients () const
	Returns the number of coefficients for the equation.
int	Variables () const
	Returns the number of variables in the equation.
std::string	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
std::string	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.
Private Attributes
int	p_degree
	The order/degree of the polynomial.

Constructor & Destructor Documentation

Isis::PolynomialBivariate::PolynomialBivariate ( int degree )

Create a PolynomialBivariate object.

Parameters:

degree

The order/degree of the polynomial

Definition at line 33 of file PolynomialBivariate.cpp.

References p_degree.

Isis::PolynomialBivariate::~PolynomialBivariate ( ) [inline]

Destroys the PolynomialBivariate object.

Definition at line 58 of file PolynomialBivariate.h.

Member Function Documentation

double Isis::BasisFunction::Coefficient ( int i ) const [inline, inherited]

Returns the ith coefficient.

Parameters:

The index for the desired coefficient.

Returns:: The ith coefficient

Definition at line 109 of file BasisFunction.h.

Referenced by Isis::PolynomialUnivariate::DerivativeVar(), Isis::SurfaceModel::MinMax(), Isis::AutoReg::ModelSurface(), Isis::SpicePosition::ReloadCache(), Isis::SpicePosition::SetPolynomial(), Isis::OverlapNormalization::Solve(), Isis::Affine::Solve(), and Isis::BundleAdjust::Update().

int Isis::BasisFunction::Coefficients ( ) const [inline, inherited]

Returns the number of coefficients for the equation.

Returns:: The number of coefficients.

Definition at line 74 of file BasisFunction.h.

References Isis::BasisFunction::p_numCoefs.

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

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.