SynAPSE  0.6.0
Synergistic Analysis of Phase Space Evolution
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Histogram.hh
1 #ifndef HISTOGRAM_HH
2 #define HISTOGRAM_HH
3 
4 // C++ includes
5 #include <iostream>
6 #include <ctime>
7 #include <cmath>
8 #include <vector>
9 #include <map>
10 
11 // ROOT includes
12 #include "TROOT.h"
13 #include "TCanvas.h"
14 #include "TObject.h"
15 #include "TH1F.h"
16 #include "TH2F.h"
17 #include "TH3F.h"
18 
19 // Other includes
20 #include "Bin.hh"
21 #include "Grid.hh"
22 
32 class Histogram {
33  public:
35  Histogram();
36 
43  Histogram(std::vector<size_t> number,
44  const std::vector<double>& lower,
45  const std::vector<double>& upper);
46 
48  Histogram(const Histogram& hist);
49 
51  Histogram& operator=(const Histogram& hist);
52 
54  ~Histogram();
55 
57  void Initialize();
58 
60  void Fill(const std::vector<double>& point, const double w=1.);
61 
63  void FillN(const std::vector<std::vector<double>>& points,
64  const std::vector<double> w=std::vector<double>());
65 
67  Bin GetBin(const std::vector<size_t>& indices) const;
68 
70  std::vector<Bin> GetBinArray() const;
71 
73  std::vector<double> GetBinBarycentre(const std::vector<size_t>& indices) const;
74 
76  double GetBinCentre(const size_t index, const size_t i=0) const;
77 
79  void SetBinContent(const std::vector<size_t>& indices, const double value);
80 
82  const double& GetBinContent(const std::vector<size_t>& indices) const;
83 
85  double GetBinDensity(const std::vector<size_t>& indices) const;
86 
88  std::vector<size_t> GetBinID(const std::vector<double>& point) const;
89 
91  double GetBinVolume() const;
92 
94  const double& GetBinWidth(const size_t i=0) const { return _grid.GetPeriod(i); }
95 
97  const size_t GetEntries() const { return _points.size(); }
98 
100  const size_t& GetDimension() const { return _grid.GetDimension(); }
101 
103  const std::vector<double>& GetLowerBoundArray() const { return _grid.GetLowerBoundArray(); }
104 
106  const double& GetLowerBound(const size_t i=0) const { return _grid.GetLowerBound(i); }
107 
109  const std::vector<double>& GetUpperBoundArray() const { return _grid.GetUpperBoundArray(); }
110 
112  const double& GetUpperBound(const size_t i=0) const { return _grid.GetUpperBound(i); }
113 
115  const Grid& GetGrid() const { return _grid; }
116 
118  Grid GetInterpolationGrid() const;
119 
121  size_t GetNbins() const;
122 
124  size_t GetNbins(const size_t i=0) const { return _grid.GetNpoints(i)-1; }
125 
127  void Scale(const double factor);
128 
130  void ScaleToDensity(const double norm=1.);
131 
133  TObject* ToROOT(const std::string name="") const;
134 
135  private:
136 
138  std::vector<std::vector<double>> _points;
139  std::vector<double> _contents;
140  std::vector<double> _outflows;
141 };
142 
143 #endif
~Histogram()
Destructor.
Definition: Histogram.cc:43
const size_t GetEntries() const
Returns the amount of entries.
Definition: Histogram.hh:97
std::vector< size_t > GetBinID(const std::vector< double > &point) const
Returns the ids of the bin that contains the requested point.
Definition: Histogram.cc:181
const size_t & GetDimension() const
Returns the dimension of the space in which the grid is constructed.
Definition: Grid.hh:133
std::vector< Bin > GetBinArray() const
Returns all the bins as an array of Bin objects.
Definition: Histogram.cc:120
size_t GetNbins() const
Returns the amount of total amount of bins (n-dimensional buckets)
Definition: Histogram.cc:207
const std::vector< double > & GetLowerBoundArray() const
Returns the array of lower bounds in each dimension.
Definition: Histogram.hh:103
void Scale(const double factor)
Scales the histogram by a certain factor.
Definition: Histogram.cc:217
std::vector< double > GetBinBarycentre(const std::vector< size_t > &indices) const
Returns the bin barycentre in the dimension of the space.
Definition: Histogram.cc:140
void SetBinContent(const std::vector< size_t > &indices, const double value)
Sets the content of bin indices.
Definition: Histogram.cc:166
Data structure for a grid of points and their mapping onto a scalar field.
Definition: Grid.hh:19
const size_t & GetNpoints(const size_t i) const
Returns the number of points in dimension i.
Definition: Grid.hh:139
std::vector< double > _outflows
Under/overflow bins (3^_dim-1 bins)
Definition: Histogram.hh:140
const double & GetUpperBound(const size_t i=0) const
Returns the upper bound in dimension i.
Definition: Histogram.hh:112
void FillN(const std::vector< std::vector< double >> &points, const std::vector< double > w=std::vector< double >())
Fills the histogram with an array of points with weights w.
Definition: Histogram.cc:96
std::vector< double > _contents
Binned data.
Definition: Histogram.hh:139
const double & GetUpperBound(const size_t i) const
Returns the upper bound in dimension i.
Definition: Grid.hh:163
Grid GetInterpolationGrid() const
Returns a grid of the bin centres on which to interpolate.
Definition: Histogram.cc:196
Defines the most general n-dimensional bin.
Definition: Bin.hh:14
double GetBinDensity(const std::vector< size_t > &indices) const
Returns an estimation of the probability density function in bin indices.
Definition: Histogram.cc:176
double GetBinCentre(const size_t index, const size_t i=0) const
Returns the bin centre in a particular dimension.
Definition: Histogram.cc:150
Histogram & operator=(const Histogram &hist)
Equality operator.
Definition: Histogram.cc:31
Grid _grid
Grid that contains the space division.
Definition: Histogram.hh:137
size_t GetNbins(const size_t i=0) const
Returns the amount of bins in one projection.
Definition: Histogram.hh:124
const std::vector< double > & GetLowerBoundArray() const
Returns the array of lower bounds in each dimension.
Definition: Grid.hh:154
void Initialize()
Initializes the histogram from the produced grid.
Definition: Histogram.cc:45
const size_t & GetDimension() const
Returns the dimension of the space.
Definition: Histogram.hh:100
const double & GetPeriod(const size_t i) const
Returns the period size in dimension i.
Definition: Grid.hh:151
const double & GetLowerBound(const size_t i) const
Returns the lower bound in dimension i.
Definition: Grid.hh:157
Histogram()
Default constructor, initilizes everything to 0.
Definition: Histogram.cc:3
Bin GetBin(const std::vector< size_t > &indices) const
Returns the bin as a Bin object (knows its indices, bounds and content)
Definition: Histogram.cc:111
const double & GetBinContent(const std::vector< size_t > &indices) const
Returns the content of bin indices.
Definition: Histogram.cc:171
Data stucture for histograms of arbitray large dimensions.
Definition: Histogram.hh:32
void ScaleToDensity(const double norm=1.)
Scales the histogram contents to the estimated density.
Definition: Histogram.cc:224
const std::vector< double > & GetUpperBoundArray() const
Returns the array of upper bounds in each dimension.
Definition: Histogram.hh:109
const Grid & GetGrid() const
Returns the grid that encompasses the bins.
Definition: Histogram.hh:115
const std::vector< double > & GetUpperBoundArray() const
Returns the array of upper bounds in each dimension.
Definition: Grid.hh:160
TObject * ToROOT(const std::string name="") const
Returns a ROOT histogram for dimensions below 3.
Definition: Histogram.cc:231
double GetBinVolume() const
Returns the volume of a bin in this bucketting.
Definition: Histogram.cc:186
const double & GetLowerBound(const size_t i=0) const
Returns the lower bound in dimension i.
Definition: Histogram.hh:106
const double & GetBinWidth(const size_t i=0) const
Returns the bin width in a particular dimension.
Definition: Histogram.hh:94
void Fill(const std::vector< double > &point, const double w=1.)
Fills the histogram with a given point and weight w.
Definition: Histogram.cc:56
std::vector< std::vector< double > > _points
Points that filled the histogram.
Definition: Histogram.hh:138