cppCORE/Histogram.h at master · marc-sturm/cppCORE · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
#ifndef HISTOGRAM_H
#define HISTOGRAM_H

#include "cppCORE_global.h"
#include "BasicStatistics.h"

#include <QVector>
#include <QTextStream>

///Histogram representation
class CPPCORESHARED_EXPORT Histogram
{
public:
	/// Default constructor
	Histogram(double min, double max, double bin_size);

	/// Increases the bin corresponding to value @p val by one
	void inc(double val, bool ignore_bounds_errors=false)
	{
		bins_[binIndex(val, ignore_bounds_errors)]+=1;
		bin_sum_ += 1;
	}

	/// Increases the bin corresponding to the values in @p data by one
	void inc(const QVector<double>& data, bool ignore_bounds_errors=false)
	{
		for (int i=0; i<data.size(); ++i)
		{
			inc(data[i], ignore_bounds_errors);
		}
	}

	/// Returns the lower bound position (x-axis)
	double min() const
	{
		return min_;
	}
	/// Returns the upper bound position (x-axis)
	double max() const
	{
		return max_;
	}
	/// Returns the bin size
	double binSize() const
	{
		return bin_size_;
	}

	/// Returns the number of bins
	int binCount() const
	{
		return bins_.size();
	}
	/// Returns the sum of all bins (i.e. the number of data points added)
	long long binSum()
	{
		return bin_sum_;
	}

	/// Returns the bin a given position belongs to.
	int binIndex(double val, bool ignore_bounds_errors=false) const;

	/// Returns the highest value of all bins (y-axis)
	double maxValue(bool as_percentage=false) const;
	/// Returns the lowest value of all bins (y-axis)
	double minValue(bool as_percentage=false) const;

	/// Returns the value of the bin corresponding to the position @p val
	double binValue(double val, bool as_percentage=false, bool ignore_bounds_errors=false) const;
	/// Returns the value of the bin with the index @p index
	double binValue(int index, bool as_percentage=false) const;

    /// Returns the start position of the bin with the index @p index
    double startOfBin(int index) const;

    /// Prints the histogram to a stream
    void print(QTextStream &stream, QString indentation="", int position_precision=2, int data_precision=2, bool ascending=true) const;

	/// Returns an array of X-coordinates (position).
	QVector<double> xCoords()
	{
		return BasicStatistics::range(binCount(), startOfBin(0) + 0.5 * binSize(), binSize());
	}
	/// Returns an array of Y-coordinates (values).
	QVector<double> yCoords(bool as_percentage=false);

	/// store
	void store(QString filename, bool x_log_scale=false, bool y_log_scale=false, double min_offset=1e-6);
	/// stores a combined histogram of different histograms
	static void storeCombinedHistogram(QString filename, QList<Histogram> histograms, QString xlabel, QString ylabel);

	void setYLabel(QString ylabel)
	{
		ylabel_ = ylabel;
	}

	void setXLabel(QString xlabel)
	{
		xlabel_ = xlabel;
	}

	void setLabel(QString label)
	{
		label_ = label;
	}

	void setColor(QString color)
	{
		color_ = color;
	}

	void setAlpha(double alpha)
	{
		alpha_ = alpha;
	}

protected:
	/// lower bound position
	double min_;
	/// upper bound position
	double max_;
	/// bin size
	double bin_size_;
	/// sum of all bins (used for percentage mode)
	long long bin_sum_;
	QString xlabel_;
	QString ylabel_;
	QString label_;
	QString color_;
	double alpha_;

	/// vector of bins
	QVector<double> bins_;
};

#endif