SynAPSE  0.6.0
Synergistic Analysis of Phase Space Evolution
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Bunch.hh
1 #ifndef BUNCH_HH
2 #define BUNCH_HH
3 
4 // C++ includes
5 #include <stdlib.h>
6 #include <map>
7 #include <vector>
8 
9 // QHULL includes
10 #include "Qhull.h"
11 
12 // ROOT includes
13 #include "TEllipse.h"
14 #include "TH1F.h"
15 #include "TH2F.h"
16 #include "TF1.h"
17 
18 // Other includes
19 #include "Statistics.hh"
20 #include "DGaus.hh"
21 #include "DChiSquared.hh"
22 #include "DensityEstimator.hh"
23 #include "ProbabilityContour.hh"
24 #include "BunchData.hh"
25 #include "Variable.hh"
26 #include "Drawer.hh"
27 
29 namespace Beam {
30 
39 class Bunch {
40  public:
42  Bunch();
43 
51  Bunch(const BunchMap& samples,
52  const double pos = 0,
53  const std::string& name = "",
54  const double mass = 105.66);
55 
64  Bunch(const BunchMap& samples,
65  const BunchMap& errors,
66  const double pos = 0,
67  const std::string& name = "",
68  const double mass = 105.66);
69 
71  Bunch(const Bunch& bunch);
72 
74  Bunch& operator=(const Bunch& bunch);
75 
77  ~Bunch();
78 
80  const std::string& Name() const { return _name; }
81 
83  void SetName(const std::string& name) { _name = name; }
84 
86  const size_t& Dimension() const { return _dim; }
87 
89  const double& Position() const { return _pos; }
90 
92  const double& Mass() const { return _mass; }
93 
95  void SetPosition(const double& pos) { _pos = pos; }
96 
98  const size_t Size() const { return _data.Size(); }
99 
101  const size_t CoreSize() const { return _core.Size(); }
102 
104  const std::vector<double>& Samples(const std::string var) const;
105 
107  const std::vector<double>& Errors(const std::string var) const;
108 
110  double Radius(const size_t i) const;
111 
113  std::vector<double> Radii() const;
114 
116  Variable Mean(const std::string& var) const;
117 
119  const Matrix<double>& CovarianceMatrix() const { return _data.S(); }
120 
122  const Variable& Alpha() const { return _alpha; }
123 
125  Variable Alpha(const std::string axis) const;
126 
128  const Variable& Beta() const { return _beta; }
129 
131  Variable Beta(const std::string axis) const;
132 
134  const Variable Gamma() const { return _gamma; }
135 
137  Variable Gamma(const std::string axis) const;
138 
140  const Variable& MechanicalL() const { return _mecl; }
141 
143  const Variable& Emittance() const { return _eps; }
144 
146  const Variable& NormEmittance() const { return _neps; }
147 
149  const Variable& SubEmittance() const { return _seps; }
150 
152  const Variable& FracEmittance() const { return _feps; }
153 
155  const Variable& AmplitudeQuantile() const { return _qamp; }
156 
158  Variable NormEmittanceEstimate(const SumStat& stat) const;
159 
161  Variable SummaryStatistic(const SumStat& stat) const;
162 
164  const std::vector<double>& Amplitudes() const { return _amps; }
165 
167  const std::vector<double>& VoronoiVolumes() const { return _vols; }
168 
170  void SetFraction(const double frac) { _fraction = frac; }
171 
176  void SetCoreFraction(const double frac);
177 
182  void SetCoreSize(const size_t size);
183 
189  void SetCoreVolume(const std::string algo="hull",
190  const double norm=1.);
191 
195  void SetCorrectedAmplitudes();
196 
200  void SetMCDAmplitudes();
201 
207  void SetGeneralisedAmplitudes(const double norm=1.);
208 
215  void SetVoronoiVolumes();
216 
227  TEllipse* Ellipse(const std::string& vara,
228  const std::string& varb,
229  const double p=.39347) const;
230 
239  TEllipse* RobustEllipse(const std::string& vara,
240  const std::string& varb,
241  const double p=.39347) const;
242 
251  TH1F* Histogram(const std::string& var,
252  double min=0,
253  double max=0) const;
254 
266  TH2F* Histogram(const std::string& vara,
267  const std::string& varb,
268  double mina=0,
269  double maxa=0,
270  double minb=0,
271  double maxb=0) const;
272 
280  ScatterGraph* AmplitudeScatter(const std::string& vara,
281  const std::string& varb) const;
282 
283  private:
284 
290  void Initialize(const BunchMap& samples,
291  const BunchMap& errors);
292 
294  bool Contains(const std::string& var) const { return _data.Contains(var); }
295 
297  void AssertContains(const std::string& var) const { _data.AssertContains(var); }
298 
305  void Arrays(const std::string& var,
306  std::vector<double>& samples,
307  std::vector<double>& errors) const;
308 
310  double TotalMomentum(const size_t i) const;
311 
313  std::vector<double> TotalMomenta() const;
314 
316  double TotalMomentumError(const size_t i) const;
317 
319  std::vector<double> TotalMomentumErrors() const;
320 
322  void SetTwiss();
323 
331  double TwissMError(const std::string& name,
332  std::map<std::string, double>& means,
333  const double& detr,
334  const Matrix<double>& C) const;
335 
340  double TwissSError(const double& twiss) const;
341 
343  void SetEmittance();
344 
346  void SetNormEmittance();
347 
349  void SetSubEmittance();
350 
352  void SetAmplitudeQuantile(const double& qamp);
353 
355  double NormEmittanceValue(const Matrix<double>& covmat) const;
356 
358  void SetAmplitudes();
359 
367  double AmplitudeValue(const Matrix<double>& invcovmat,
368  const std::vector<double>& means,
369  const std::vector<double>& vec,
370  const double& neps) const;
371 
372  std::string _name;
373  size_t _dim;
374  double _pos;
375  double _mass;
376  double _fraction;
388  std::vector<double> _amps;
389  std::vector<double> _vols;
391 };
392 } // namespace Beam
393 
394 #endif
const std::vector< double > & Amplitudes() const
Returns the array of amplitudes of the samples.
Definition: Bunch.hh:164
double NormEmittanceValue(const Matrix< double > &covmat) const
Computes the RMS emittance provided with the covariance matrix.
Definition: Bunch.cc:898
Variable _qamp
Lagest amplitude in the core.
Definition: Bunch.hh:387
const double & Mass() const
Returns the mass of the particles that make up the beam [MeV/c^2].
Definition: Bunch.hh:92
BunchData _core
Core fraction of beam.
Definition: Bunch.hh:378
size_t _dim
Dimension of the transverse phase space.
Definition: Bunch.hh:373
void SetCorrectedAmplitudes()
Compute the corrected transverse amplitudes of every particle in the sample by only considering parti...
Definition: Bunch.cc:376
const Matrix< double > & CovarianceMatrix() const
Returns the covariance matrix of the bunch.
Definition: Bunch.hh:119
double AmplitudeValue(const Matrix< double > &invcovmat, const std::vector< double > &means, const std::vector< double > &vec, const double &neps) const
Compute the transverse amplitude provided with S^-1 and the PS vector.
Definition: Bunch.cc:918
void SetAmplitudeQuantile(const double &qamp)
Sets the amplitude quantile and its uncertainty.
Definition: Bunch.cc:886
const double & Position() const
Returns the z position at which the bunch was sampled [mm].
Definition: Bunch.hh:89
void SetSubEmittance()
Computes the subemittance of the core.
Definition: Bunch.cc:869
const Variable & Alpha() const
Returns the Twiss parameter alpha of the bunch.
Definition: Bunch.hh:122
double TwissMError(const std::string &name, std::map< std::string, double > &means, const double &detr, const Matrix< double > &C) const
Computes the measurement error on the requested Twiss parameter.
Definition: Bunch.cc:775
TH1F * Histogram(const std::string &var, double min=0, double max=0) const
Returns the 1D distrubution of the requested variable.
Definition: Bunch.cc:572
void SetPosition(const double &pos)
Sets the position of the bunch.
Definition: Bunch.hh:95
std::map< std::string, std::vector< double > > BunchMap
Strutcure of a bunch map (maps variable tags to vectors)
Definition: BunchData.hh:16
const Variable & Emittance() const
Returns the RMS normalised emittance of the bunch.
Definition: Bunch.hh:143
Variable _beta
Twiss parameter beta.
Definition: Bunch.hh:380
Variable _feps
Fractional emittance.
Definition: Bunch.hh:386
const Variable & Beta() const
Returns the Twiss parameter beta of the bunch.
Definition: Bunch.hh:128
void SetFraction(const double frac)
Defines the fraction the core represents (in case of transmission losses)
Definition: Bunch.hh:170
void SetCoreVolume(const std::string algo="hull", const double norm=1.)
Computes the volume of the fraction of the beam contained in the core.
Definition: Bunch.cc:321
const size_t CoreSize() const
Returns the size of the core sample.
Definition: Bunch.hh:101
Bunch()
Default constructor, initilizes everything to 0.
Definition: Bunch.cc:5
std::vector< double > TotalMomentumErrors() const
Returns the error on the total momentum of all the samples.
Definition: Bunch.cc:720
const Variable & AmplitudeQuantile() const
Returns the maximum amplitude in the core.
Definition: Bunch.hh:155
TEllipse * Ellipse(const std::string &vara, const std::string &varb, const double p=.39347) const
Returns the n-RMS ellipse of a sample of two variables.
Definition: Bunch.cc:523
Set of functions that compose the Statistics package.
SumStat
Enumerates the types of summary statistics of a beam bunch.
Definition: Definitions.hh:44
void SetName(const std::string &name)
Sets the name of the bunch.
Definition: Bunch.hh:83
Computes the non parametric density estimator of a set of points.
Definition: DensityEstimator.hh:31
Variable _neps
Normalised RMS emittance.
Definition: Bunch.hh:384
bool Contains(const std::string &var) const
Checks if the variable is provided.
Definition: BunchData.cc:83
Variable _alpha
Twiss parameter alpha.
Definition: Bunch.hh:379
BunchData _data
Underlying phase space vectors.
Definition: Bunch.hh:377
const std::vector< double > & Samples(const std::string var) const
Returns the array of samples of variable var.
Definition: Bunch.cc:78
const Variable & MechanicalL() const
Returns the mechanical angular momentum of the bunch.
Definition: Bunch.hh:140
const Variable & FracEmittance() const
Returns the volume of the core.
Definition: Bunch.hh:152
void SetCoreFraction(const double frac)
Defines the fraction of the beam contained in the core.
Definition: Bunch.cc:265
const Matrix< double > & S() const
Returns one element of the covariance matrix of the bunch.
Definition: BunchData.hh:61
Holds a bunch of particles at a specific position along the beam line.
Definition: Bunch.hh:39
double _mass
Mass of the particles.
Definition: Bunch.hh:375
const size_t Size() const
Returns the size of the whole sample.
Definition: Bunch.hh:98
const size_t Size() const
Returns the dimension of space in which the bunch lives.
Definition: BunchData.hh:85
void SetAmplitudes()
Compute the transverse amplitudes of every particle in the sample.
Definition: Bunch.cc:903
Variable _gamma
Twiss parameter gamma.
Definition: Bunch.hh:381
void Arrays(const std::string &var, std::vector< double > &samples, std::vector< double > &errors) const
Returns the value and unertainty arrays corresponding to the requested variable.
Definition: Bunch.cc:668
DensityEstimator _de
Density estimation of the bunch.
Definition: Bunch.hh:390
Bunch & operator=(const Bunch &bunch)
Equality operator.
Definition: Bunch.cc:49
void AssertContains(const std::string &var) const
Checks if the variable is provided, throws if not.
Definition: BunchData.cc:91
void SetGeneralisedAmplitudes(const double norm=1.)
Compute the generalised transverse amplitude of every particle in the sample by basing it on density ...
Definition: Bunch.cc:449
TEllipse * RobustEllipse(const std::string &vara, const std::string &varb, const double p=.39347) const
Returns the n-RMS robust ellipse of a sample of two variables.
Definition: Bunch.cc:547
Variable _eps
Geometric RMS emittance.
Definition: Bunch.hh:383
double _pos
Position at which the bunch was sampled.
Definition: Bunch.hh:374
void Initialize(const BunchMap &samples, const BunchMap &errors)
Normal initializer, sets the particle sample and bunch variables.
Definition: Bunch.cc:646
Holds a the underlying phase space vectors that form a Bunch.
Definition: BunchData.hh:23
ScatterGraph * AmplitudeScatter(const std::string &vara, const std::string &varb) const
Returns the 2D scatter plot of particle amplitudes.
Definition: Bunch.cc:623
void AssertContains(const std::string &var) const
Checks if the variable is provided, throws if not.
Definition: Bunch.hh:297
const std::vector< double > & VoronoiVolumes() const
Returns the array of Voronoi volumes of the samples.
Definition: Bunch.hh:167
const Variable & SubEmittance() const
Returns the subemittance of the core.
Definition: Bunch.hh:149
Variable SummaryStatistic(const SumStat &stat) const
Returns the requested summary statistic.
Definition: Bunch.cc:217
double TwissSError(const double &twiss) const
Computes the statistical error on the provided Twiss parameter.
Definition: Bunch.cc:830
Variable _seps
Subemittance.
Definition: Bunch.hh:385
const Variable Gamma() const
Returns the Twiss parameter gamma of the bunch.
Definition: Bunch.hh:134
std::vector< double > TotalMomenta() const
Returns the total momentum of all the samples.
Definition: Bunch.cc:698
Variable Mean(const std::string &var) const
Returns the mean of the requested quantity.
Definition: Bunch.cc:102
double _fraction
Fraction contained in the beam core.
Definition: Bunch.hh:376
Defines functions that allow to plot a ROOT scatter graph with a color scale.
Definition: ScatterGraph.hh:31
~Bunch()
Destructor.
Definition: Bunch.cc:76
void SetEmittance()
Computes the RMS geometric emittance of the bunch.
Definition: Bunch.cc:835
const std::vector< double > & Errors(const std::string var) const
Returns the array of errors on the samples of variable var.
Definition: Bunch.cc:83
double TotalMomentum(const size_t i) const
Returns the total momentum of a given sample.
Definition: Bunch.cc:689
std::vector< double > Radii() const
Returns the array of radii of the samples.
Definition: Bunch.cc:93
const Variable & NormEmittance() const
Returns the RMS geometric emittance of the bunch.
Definition: Bunch.hh:146
const std::string & Name() const
Returns the name of the bunch.
Definition: Bunch.hh:80
bool Contains(const std::string &var) const
Checks if the variable is provided.
Definition: Bunch.hh:294
std::vector< double > _vols
Voronoi cell volumes of the particles.
Definition: Bunch.hh:389
void SetNormEmittance()
Computes the RMS normalised emittance of the bunch.
Definition: Bunch.cc:852
const size_t & Dimension() const
Returns the dimension of space in which the bunch lives.
Definition: Bunch.hh:86
double TotalMomentumError(const size_t i) const
Returns the error on the total momentum of a given sample.
Definition: Bunch.cc:707
Variable _mecl
Normalised mechanical angular momentum.
Definition: Bunch.hh:382
void SetMCDAmplitudes()
Compute the MCD transverse amplitude of every particle in the sample by selecting a subsample optimiz...
Definition: Bunch.cc:433
void SetVoronoiVolumes()
Compute the Voronoi volumes around each particle.
Definition: Bunch.cc:505
void SetCoreSize(const size_t size)
Assigns a certain amount of core particles.
Definition: Bunch.cc:277
void SetTwiss()
Computes the Twiss parameter alpha of the bunch.
Definition: Bunch.cc:729
double Radius(const size_t i) const
Returns the radius of the i^th sample.
Definition: Bunch.cc:88
std::vector< double > _amps
Amplitudes of the particles.
Definition: Bunch.hh:388
std::string _name
Name of the bunch.
Definition: Bunch.hh:372
Contains the value, measurement uncertainty and statistical uncertainty of a variable.
Definition: Variable.hh:10
Variable NormEmittanceEstimate(const SumStat &stat) const
Returns the estimated normalised emittance from the measured fractional quantity. ...
Definition: Bunch.cc:181