|
Isis 3.0 Object Programmers' Reference |
Home |
#include <Parabola.h>
Inheritance diagram for Isis::Parabola:
This is a derived class from the BasisFunction class which creates a parabola (second degree equation in 1 variable). The parabolic function has the following form:
![\[ x = A + B*y + C*y**2 \]](form_71.png)
For internal use only.
Definition at line 50 of file Parabola.h.
Public Member Functions | |
| Parabola (const std::string &bname="Parabola") | |
| Create a Parabola object. | |
| ~Parabola () | |
| Destroys the Parabola object. | |
| void | Expand (const std::vector< double > &vars) |
| This is the the overriding virtual function that provides the expansion into the parabolic 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. | |
| Isis::Parabola::Parabola | ( | const std::string & | bname = "Parabola" |
) | [inline] |
| Isis::Parabola::~Parabola | ( | ) | [inline] |
| double Isis::BasisFunction::Coefficient | ( | int | i | ) | const [inline, inherited] |
Returns the ith coefficient.
| i | The index for the desired 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.
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.
| 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. |
Definition at line 73 of file BasisFunction.cpp.
References _FILEINFO_, Isis::BasisFunction::Expand(), Isis::iException::Message(), Isis::BasisFunction::p_coefs, Isis::BasisFunction::p_numCoefs, Isis::BasisFunction::p_numVars, and Isis::BasisFunction::p_terms.
Referenced by Isis::LeastSquares::Evaluate(), Isis::SpicePosition::ReloadCache(), Isis::LeastSquares::SolveQRD(), Isis::LeastSquares::SolveSparse(), and Isis::LeastSquares::SolveSVD().
| void Isis::Parabola::Expand | ( | const std::vector< double > & | vars | ) | [virtual] |
This is the the overriding virtual function that provides the expansion into the parabolic equation.
See BasisFunction for more information.
| vars | A vector of double values to use for the expansion. |
Reimplemented from Isis::BasisFunction.
Definition at line 39 of file Parabola.cpp.
References Isis::BasisFunction::p_terms, and Isis::BasisFunction::Variables().
| std::string Isis::BasisFunction::Name | ( | ) | const [inline, inherited] |
Returns the name of the equation.
Definition at line 86 of file BasisFunction.h.
References Isis::BasisFunction::p_name.
Referenced by Isis::LeastSquares::AddKnown().
| void Isis::BasisFunction::SetCoefficients | ( | const std::vector< double > & | coefs | ) | [inherited] |
Set the coefficients for the equation.
| coefs | A vector of coefficients for the equation. |
Definition at line 55 of file BasisFunction.cpp.
References _FILEINFO_, Isis::iException::Message(), Isis::BasisFunction::p_coefs, and Isis::BasisFunction::p_numCoefs.
Referenced by Isis::SpicePosition::SetPolynomial(), Isis::LeastSquares::SolveQRD(), Isis::LeastSquares::SolveSparse(), and Isis::LeastSquares::SolveSVD().
| double Isis::BasisFunction::Term | ( | int | c | ) | const [inline, inherited] |
Returns the cth term.
This is only valid after a Evalute/Expand has been invoked. It represents the expansion of the variables into the ith term. For example,
![\[ x = C1 + C2*x + C3*y + C4*x*y \]](form_22.png)
would return x*y for the 3rd term (zero-based)
| c | The index for the desired coefficient. |
Definition at line 101 of file BasisFunction.h.
References Isis::BasisFunction::p_terms.
Referenced by Isis::LeastSquares::FillSparseA(), Isis::LeastSquares::SolveQRD(), and Isis::LeastSquares::SolveSVD().
| int Isis::BasisFunction::Variables | ( | ) | const [inline, inherited] |
Returns the number of variables in the equation.
Definition at line 80 of file BasisFunction.h.
References Isis::BasisFunction::p_numVars.
Referenced by Isis::LeastSquares::AddKnown(), and Expand().
std::vector<double> Isis::BasisFunction::p_coefs [protected, inherited] |
A vector of the coefficients in the equation.
Call it by using Coefficient()
Definition at line 123 of file BasisFunction.h.
Referenced by Isis::BasisFunction::Evaluate(), and Isis::BasisFunction::SetCoefficients().
std::string Isis::BasisFunction::p_name [protected, inherited] |
The name of the equation. Call it by using Name().
Definition at line 109 of file BasisFunction.h.
Referenced by Isis::BasisFunction::BasisFunction(), and Isis::BasisFunction::Name().
int Isis::BasisFunction::p_numCoefs [protected, inherited] |
The number of coefficients in the equation.
Call it by using Coefficients()
Definition at line 119 of file BasisFunction.h.
Referenced by Isis::BasisFunction::BasisFunction(), Isis::BasisFunction::Coefficients(), Isis::BasisFunction::Evaluate(), and Isis::BasisFunction::SetCoefficients().
int Isis::BasisFunction::p_numVars [protected, inherited] |
The number of variables in the equation. Call it by using Variables().
Definition at line 115 of file BasisFunction.h.
Referenced by Isis::BasisFunction::BasisFunction(), Isis::BasisFunction::Evaluate(), and Isis::BasisFunction::Variables().
std::vector<double> Isis::BasisFunction::p_terms [protected, inherited] |
A vector of the terms in the equation.
Call it by using Term()
Definition at line 127 of file BasisFunction.h.
Referenced by Isis::BasisFunction::Evaluate(), Isis::PolynomialUnivariate::Expand(), Isis::PolynomialBivariate::Expand(), Expand(), Isis::BasisFunction::Expand(), and Isis::BasisFunction::Term().