SynAPSE  0.6.0
Synergistic Analysis of Phase Space Evolution
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
BunchData.hh
1 #ifndef BUNCHDATA_HH
2 #define BUNCHDATA_HH
3 
4 // C++ includes
5 #include <map>
6 #include <vector>
7 
8 // Other includes
9 #include "Statistics.hh"
10 #include "Definitions.hh"
11 
13 namespace Beam {
14 
16 typedef std::map<std::string, std::vector<double>> BunchMap;
17 
23 class BunchData {
24  public:
26  BunchData();
27 
33  BunchData(const BunchMap& samples,
34  const BunchMap& errors);
35 
37  BunchData(const BunchData& bunchdata);
38 
40  BunchData& operator=(const BunchData& bunchdata);
41 
43  ~BunchData();
44 
46  const std::vector<double>& operator[](const std::string& var) const { return Samples(var); }
47 
49  const Matrix<double>& PhaseSpace() const { return _trans; }
50 
52  const Matrix<double>& PhaseSpaceErrors() const { return _etrans; }
53 
55  const std::vector<double>& Samples(const std::string var) const;
56 
58  const std::vector<double>& Errors(const std::string var) const;
59 
61  const Matrix<double>& S() const { return _S; }
62 
64  const double& S(const std::string vara, const std::string varb) const;
65 
67  const Matrix<double>& TraceSpace() const { return _opt; }
68 
70  const Matrix<double>& TraceSpaceErrors() const { return _eopt; }
71 
73  const std::vector<double>& Opticals(const std::string var) const;
74 
76  const std::vector<double>& OpticalErrors(const std::string var) const;
77 
79  const Matrix<double>& T() const { return _T; }
80 
82  const double& T(const std::string vara, const std::string varb) const;
83 
85  const size_t Size() const { return _trans.Ncols(); }
86 
88  const std::vector<std::string>& Axes() const { return _axes; }
89 
91  const std::vector<std::string>& Keys() const { return _keys; }
92 
94  const size_t& Id(const std::string& key) const { return _ids.at(key); }
95 
97  bool Contains(const std::string& var) const;
98 
100  void AssertContains(const std::string& var) const;
101 
102  private:
103 
109  void Initialize(const BunchMap& samples,
110  const BunchMap& errors);
111 
118  std::vector<double> _pz;
119  std::vector<double> _epz;
120  std::vector<std::string> _axes;
121  std::vector<std::string> _keys;
122  std::map<std::string, size_t> _ids;
123 };
124 } // namespace Beam
125 
126 #endif
const size_t Ncols() const
Returns the number of columns.
Definition: Matrix-inl.hh:486
Matrix< double > _trans
Transverse phase space.
Definition: BunchData.hh:112
BunchData & operator=(const BunchData &bunchdata)
Equality operator.
Definition: BunchData.cc:26
std::vector< double > _pz
Vector of longitudinal momenta.
Definition: BunchData.hh:118
const Matrix< double > & T() const
Returns one element of the covariance matrix of the bunch.
Definition: BunchData.hh:79
const std::vector< double > & OpticalErrors(const std::string var) const
Returns the array of uncertainties on the optical samples of variable var.
Definition: BunchData.cc:73
const std::vector< std::string > & Keys() const
Returns the list of BunchMap dictionary keys.
Definition: BunchData.hh:91
const Matrix< double > & TraceSpace() const
Returns the matrix of transverse optical samples.
Definition: BunchData.hh:67
const size_t & Id(const std::string &key) const
Returns the position of the requested key.
Definition: BunchData.hh:94
std::map< std::string, std::vector< double > > BunchMap
Strutcure of a bunch map (maps variable tags to vectors)
Definition: BunchData.hh:16
BunchData()
Default constructor, initilizes everything to 0.
Definition: BunchData.cc:5
const std::vector< double > & Opticals(const std::string var) const
Returns the array of optical samples of variable var.
Definition: BunchData.cc:68
std::map< std::string, size_t > _ids
Reciprocal of BunchMap keys, return id of var.
Definition: BunchData.hh:122
std::vector< std::string > _axes
List of transverse axes.
Definition: BunchData.hh:120
Matrix< double > _eopt
Transverse trace space uncertainties.
Definition: BunchData.hh:116
const Matrix< double > & TraceSpaceErrors() const
Returns the matrix of uncertainties on the transverse optical samples.
Definition: BunchData.hh:70
Set of functions that compose the Statistics package.
bool Contains(const std::string &var) const
Checks if the variable is provided.
Definition: BunchData.cc:83
Matrix< double > _T
Transverse trace space covariance matrix.
Definition: BunchData.hh:117
Matrix< double > _S
Transverse phase space covariance matrix.
Definition: BunchData.hh:114
const Matrix< double > & S() const
Returns one element of the covariance matrix of the bunch.
Definition: BunchData.hh:61
const size_t Size() const
Returns the dimension of space in which the bunch lives.
Definition: BunchData.hh:85
void AssertContains(const std::string &var) const
Checks if the variable is provided, throws if not.
Definition: BunchData.cc:91
Matrix< double > _etrans
Transverse phase space uncertainties.
Definition: BunchData.hh:113
const Matrix< double > & PhaseSpace() const
Returns the matrix of transverse samples.
Definition: BunchData.hh:49
const std::vector< double > & Samples(const std::string var) const
Returns the array of samples of variable var.
Definition: BunchData.cc:47
Holds a the underlying phase space vectors that form a Bunch.
Definition: BunchData.hh:23
Matrix< double > _opt
Transverse trace space.
Definition: BunchData.hh:115
std::vector< std::string > _keys
List of transverse variables.
Definition: BunchData.hh:121
void Initialize(const BunchMap &samples, const BunchMap &errors)
Normal initializer, sets the particle sample and bunch variables.
Definition: BunchData.cc:99
const std::vector< double > & operator[](const std::string &var) const
Overload the subscript operator, return the samples for the requested variable.
Definition: BunchData.hh:46
const std::vector< std::string > & Axes() const
Returns the list of transverse axes.
Definition: BunchData.hh:88
std::vector< double > _epz
Vector of longitudinal momenta uncertainties.
Definition: BunchData.hh:119
~BunchData()
Destructor.
Definition: BunchData.cc:45
const std::vector< double > & Errors(const std::string var) const
Returns the array of uncertainties on the samples of variable var.
Definition: BunchData.cc:55
const Matrix< double > & PhaseSpaceErrors() const
Returns the matrix of uncertainties on the transverse samples.
Definition: BunchData.hh:52