SMILE  v2.5
Schwarzschild Modelling Interactive expLoratory Environment
Public Member Functions | List of all members
smile::CBasicOrbitFilteringFnc Class Referenceabstract

Parent class for orbit filtering functions which evaluate whether an orbit should be used (in some calculation). More...

#include <common.h>

Inheritance diagram for smile::CBasicOrbitFilteringFnc:
Inheritance graph
[legend]

Public Member Functions

virtual double eval (const COrbitDesc *orbit) const =0
 

Detailed Description

Parent class for orbit filtering functions which evaluate whether an orbit should be used (in some calculation).

Return value is a float number (for example, between 0 and 1 for telling how well an orbit satisfies some criterion, but may be >1 or negative).

Example of the usage of these functions is in COrbitDesc::getOrbitPopulation() routine which computes statistics based on acceptance criteria returned by such a function, or in assigning penalty to orbits of specified sort in Schwarzschild modelling.


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