#include <boost/shared_ptr.hpp>
-#include "../abstractdata.h"
-#include "../arraydata.h"
-#include "../datamodule.h"
+#include "gromacs/analysisdata/abstractdata.h"
+#include "gromacs/analysisdata/arraydata.h"
+#include "gromacs/analysisdata/datamodule.h"
namespace gmx
{
};
-namespace internal
-{
-
-class BasicHistogramImpl;
-
-} // namespace internal
-
class AbstractAverageHistogram;
//! Smart pointer to manage an AbstractAverageHistogram object.
*
* This class can represent multiple histograms in one object: each column in
* the data is an independent histogram.
+ * The X values correspond to center of the bins, except for a cumulative
+ * histogram made with makeCumulative().
*
* \inpublicapi
* \ingroup module_analysisdata
AverageHistogramPointer clone() const;
//! Normalizes the histogram such that the integral over it is one.
void normalizeProbability();
+ /*! \brief
+ * Makes the histograms cumulative by summing up each bin to all bins
+ * after it.
+ *
+ * The X values in the data are adjusted such that they match the right
+ * edges of bins instead of bin centers.
+ */
+ void makeCumulative();
//! Scales a single histogram by a uniform scaling factor.
void scaleSingle(int index, real factor);
//! Scales all histograms by a uniform scaling factor.
* The number of columns for all data sets equals the number of bins in the
* histogram.
*
+ * The histograms are accumulated as 64-bit integers within a frame and summed
+ * in double precision across frames, even if the output data is in single
+ * precision.
+ *
* \inpublicapi
* \ingroup module_analysisdata
*/
virtual AnalysisDataFrameRef tryGetDataFrameInternal(int index) const;
virtual bool requestStorageInternal(int nframes);
- PrivateImplPointer<internal::BasicHistogramImpl> impl_;
+ class Impl;
+
+ PrivateImplPointer<Impl> impl_;
// Copy and assign disallowed by base.
};
* The number of columns for all data sets equals the number of bins in the
* histogram.
*
+ * The histograms are accumulated in double precision, even if the output data
+ * is in single precision.
+ *
* \inpublicapi
* \ingroup module_analysisdata
*/
virtual AnalysisDataFrameRef tryGetDataFrameInternal(int index) const;
virtual bool requestStorageInternal(int nframes);
- PrivateImplPointer<internal::BasicHistogramImpl> impl_;
+ class Impl;
+
+ PrivateImplPointer<Impl> impl_;
// Copy and assign disallowed by base.
};