eLynx::Math::BellSurface Class Reference
#include <BellSurface.h>
Inheritance diagram for eLynx::Math::BellSurface:
Public Member Functions | |
| BellSurface () | |
| Constructor, does nothing. | |
| virtual uint32 | GetVariablesCount () const |
| virtual uint32 | GetParametersCount () const |
| virtual double | Evaluate (const IVector &iVars, const IVector &iParams) const |
| virtual double | EvalDerivativeByParam (const IVector &iVars, const IVector &iParams, uint32 iByParam) const |
Detailed Description
Implementation of gaussian surface using IFunctionNL interface. The gaussian function is implemented in form of z = g * exp(-(x^2+y^2) / 2*h^2) + b, which is suitable to approximate star profiles. The g is the star central intensity (without background), h is star radius at half maximum and b is background offset. Star center position is considered to be (0, 0).Definition at line 33 of file BellSurface.h.
Constructor & Destructor Documentation
| eLynx::Math::BellSurface::BellSurface | ( | ) | [inline] |
Member Function Documentation
| virtual uint32 eLynx::Math::BellSurface::GetVariablesCount | ( | ) | const [inline, virtual] |
Returns the number of function idependent variables (2 (x, y) in this case).
- Returns:
- the number of function variables
Implements eLynx::Math::IFunctionNL.
Definition at line 43 of file BellSurface.h.
| virtual uint32 eLynx::Math::BellSurface::GetParametersCount | ( | ) | const [inline, virtual] |
Returns the number of function parameters or coefficients. There are three parameters in this case (g, h and b).
- Returns:
- the number of function parameters
Implements eLynx::Math::IFunctionNL.
Definition at line 48 of file BellSurface.h.
| virtual double eLynx::Math::BellSurface::Evaluate | ( | const IVector & | iVars, | |
| const IVector & | iParams | |||
| ) | const [virtual] |
Evaluates the function value for given values of variables and parameters.
- Parameters:
-
iVars the vector of independent variables values iParams the vector of function parameters values
- Returns:
- the function value for given inputs
Implements eLynx::Math::IFunctionNL.
| virtual double eLynx::Math::BellSurface::EvalDerivativeByParam | ( | const IVector & | iVars, | |
| const IVector & | iParams, | |||
| uint32 | iByParam | |||
| ) | const [virtual] |
Evaluates the function derivative by given parameter.
- Parameters:
-
iVars the vector of independent variables values iParams the vector of function parameters values iByParam the index of the parameter to compute derivative by
- Returns:
- the value of the function derivative by given parameter
Implements eLynx::Math::IFunctionNL.
The documentation for this class was generated from the following file: