SynAPSE  0.6.0
Synergistic Analysis of Phase Space Evolution
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
DSpiral.hh
1 #ifndef DSPIRAL_HH
2 #define DSPIRAL_HH
3 
4 // C++ includes
5 #include <iostream>
6 #include <vector>
7 #include <cmath>
8 
9 // ROOT includes
10 #include "TMath.h"
11 #include "TEllipse.h"
12 
13 // Other includes
14 #include "DFunction.hh"
15 #include "Matrix.hh"
16 
29 class DSpiral : public DFunction {
30  public:
31 
37  DSpiral(const size_t n=1,
38  const double turn=1);
39 
48  DSpiral(const double mu,
49  const double sigma,
50  const double turn=1);
51 
58  DSpiral(const std::vector<double>& mu,
59  const std::vector<double>& sigma,
60  const double turn=1);
61 
68  DSpiral(const std::vector<double>& mu,
69  const Matrix<double>& cov,
70  const double turn=1);
71 
73  DSpiral(const DSpiral& df);
74 
76  DSpiral& operator=(const DSpiral& df);
77 
79  ~DSpiral();
80 
85  double CDF(const double& v) const;
86 
91  double CDFRadial(const double& R) const;
92 
97  std::vector<TLine*> Contour1D(const double alpha) const;
98 
103  std::vector<TObject*> Contour2D(const double alpha) const;
104 
109  TF3* Contour3D(const double alpha) const;
110 
115  std::vector<TLine*> ContourRadial(const double alpha) const;
116 
121  double ContourVolume(const double alpha) const;
122 
127  double Evaluate(const std::vector<double>& v) const;
128 
133  double Level(const double alpha) const;
134 
136  double Norm() const;
137 
142  double Radial(const double R) const;
143 
148  double Radius(const double alpha) const;
149 
151  double Random();
152 
154  std::vector<double> RandomVector();
155 
156  private:
157 
159  bool Initialize();
160 
165  double Norm1D(const size_t i) const;
166 
168  std::vector<double> Parameters() const;
169 
174  std::vector<double> OffsetParameters(const double C) const;
175 
180  Matrix<double> TwistingMatrix(const double R2) const;
181 
182  std::vector<double> _mean;
186  double _det;
187  double _turn;
188 };
189 
190 #endif
Matrix< double > _invcov
Inverse covariance matrix.
Definition: DSpiral.hh:184
double Norm() const
Returns the probability content within the defined interval.
Definition: DSpiral.cc:271
Matrix< double > TwistingMatrix(const double R2) const
Returns the twisting matrix at a given squared radius R2.
Definition: DSpiral.cc:428
double Radial(const double R) const
Return the value of the spiral for an R following the L2 symmetry.
Definition: DSpiral.cc:310
double Evaluate(const std::vector< double > &v) const
Returns the value of the distribution in v.
Definition: DSpiral.cc:241
double _turn
Controls the turning strength.
Definition: DSpiral.hh:187
Defines the methods associated with the Spiral distribution in any dimension.
Definition: DSpiral.hh:29
std::vector< double > OffsetParameters(const double C) const
Returns the parameters necessary to produce a ROOT 3D contour.
Definition: DSpiral.cc:421
double Random()
Returns a random value sampled from the spiral distribution.
Definition: DSpiral.cc:324
DSpiral & operator=(const DSpiral &df)
Equality operator.
Definition: DSpiral.cc:140
std::vector< TLine * > Contour1D(const double alpha) const
Segment that encompass a certain p-value in 1 dimension.
Definition: DSpiral.cc:170
std::vector< double > RandomVector()
Returns a random vector sampled from the spiral distribution.
Definition: DSpiral.cc:329
double CDFRadial(const double &R) const
If the function has an L1, L2 or Linf symmetry, returns its CDF at radius R.
Definition: DSpiral.cc:163
std::vector< double > _mean
Vector mean.
Definition: DSpiral.hh:182
std::vector< TObject * > Contour2D(const double alpha) const
Ellipse that encompasses a certain p-value in 2 dimensions.
Definition: DSpiral.cc:181
double CDF(const double &v) const
Cumulative distribution function at v.
Definition: DSpiral.cc:156
double _det
Determinant of the covariance matrix.
Definition: DSpiral.hh:186
DSpiral(const size_t n=1, const double turn=1)
Normal constructor, initilizes a Spiral distribution of dimension n.
Definition: DSpiral.cc:58
std::vector< double > Parameters() const
Returns the parameters to produce a ROOT type spiral function.
Definition: DSpiral.cc:401
Parent class for all the probability density functions D*.
Definition: DFunction.hh:27
double Level(const double alpha) const
Returns the level of the alpha-contour of the distribution.
Definition: DSpiral.cc:264
double Norm1D(const size_t i) const
Retuns the 1D normalisation for an arbitrary interval.
Definition: DSpiral.cc:391
Matrix< double > _J
Jacobian of variable change.
Definition: DSpiral.hh:185
std::vector< TLine * > ContourRadial(const double alpha) const
Segment that encompass a certain p-value in radius.
Definition: DSpiral.cc:215
bool Initialize()
Initializes the distribution.
Definition: DSpiral.cc:352
double ContourVolume(const double alpha) const
Volume of the smallest contour of a given p-value.
Definition: DSpiral.cc:225
Matrix< double > _cov
Covariance matrix.
Definition: DSpiral.hh:183
TF3 * Contour3D(const double alpha) const
Ellipsoid that encompasses a certain p-value in 3 dimensions.
Definition: DSpiral.cc:198
~DSpiral()
Destructor.
Definition: DSpiral.cc:154
double Radius(const double alpha) const
Returns the radius of the alpha-contour, following an L2 symmetry.
Definition: DSpiral.cc:316