SMILE  v2.5
Schwarzschild Modelling Interactive expLoratory Environment
Public Member Functions | List of all members
smile::CPericenterInformation< NumT > Class Template Reference

information object for pericenter data (distribution of angular momentum at pericenter passages) More...

#include <orbitan.h>

Inheritance diagram for smile::CPericenterInformation< NumT >:
Inheritance graph
[legend]
Collaboration diagram for smile::CPericenterInformation< NumT >:
Collaboration graph
[legend]

Public Member Functions

 CPericenterInformation (const NumT _fitIntercept, const NumT _fitSlope, const NumT _fitScatter, const NumT _fitSignificance, const NumT _Lcirc2)
 
virtual INFOTYPE infoType () const
 return the derived class type
 
virtual std::string toString () const
 present a textual representation of the data contained in this class (may be empty string)
 
void getParams (NumT *_fitIntercept, NumT *_fitSlope, NumT *_fitScatter, NumT *_fitSignificance, NumT *_Lcirc2) const
 get data (all output parameters must point to existing variables which are filled with the values of parameters)
 

Private Attributes

fitting coefficients for distribution of squared angular momentum at pericenter
NumT fitIntercept
 L_{min}^2 - estimated lower bound on angular momentum at pericenter passage (0 means a centrophilic orbit)
 
NumT fitSlope
 slope of the regression L^2_{k} = L^2_{min} + slope*k/N_{peri} for k=1..N_{peri}
 
NumT fitScatter
 scatter of points around the best-fit regression, normalized to the `typical' value (should generally be <0.5 for the regressionto be reliable)
 
NumT fitSignificance
 difference of L_{min}^2 from zero, measured in `sigma's (if less than a few, probably the orbit is centrophilic)
 
NumT Lcirc2
 approximate squared angular momentum of a circular orbit
 

Additional Inherited Members

- Public Types inherited from smile::CBasicInformation
enum  INFOTYPE {
  IT_UNKNOWN, IT_TRAJ_ANALYSIS, IT_TRAJ_SAMPLE, IT_POINCARE,
  IT_PERICENTER, IT_SCHW, IT_VEL_PERTURBER
}
 lists all possible information types More...
 

Detailed Description

template<typename NumT>
class smile::CPericenterInformation< NumT >

information object for pericenter data (distribution of angular momentum at pericenter passages)


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