histogram.h File Reference

#include <memory>
#include "gromacs/analysisdata/abstractdata.h"
#include "gromacs/analysisdata/arraydata.h"
#include "gromacs/analysisdata/datamodule.h"

Include dependency graph for histogram.h:

This graph shows which files directly or indirectly include this file:

Description

Declares analysis data modules for calculating histograms.

Author

Teemu Murtola teemu.nosp@m..mur.nosp@m.tola@.nosp@m.gmai.nosp@m.l.com

Classes
class	gmx::AnalysisHistogramSettingsInitializer
	Provides "named parameter" idiom for constructing histograms. More...
class	gmx::AnalysisHistogramSettings
	Contains parameters that specify histogram bin locations. More...
class	gmx::AbstractAverageHistogram
	Base class for representing histograms averaged over frames. More...
class	gmx::AnalysisDataSimpleHistogramModule
	Data module for per-frame histograms. More...
class	gmx::AnalysisDataWeightedHistogramModule
	Data module for per-frame weighted histograms. More...
class	gmx::AnalysisDataBinAverageModule
	Data module for bin averages. More...

Typedefs
typedef std::unique_ptr < AbstractAverageHistogram >	gmx::AverageHistogramPointer
	Smart pointer to manage an AbstractAverageHistogram object.
typedef std::shared_ptr < AnalysisDataSimpleHistogramModule >	gmx::AnalysisDataSimpleHistogramModulePointer
	Smart pointer to manage an AnalysisDataSimpleHistogramModule object.
typedef std::shared_ptr < AnalysisDataWeightedHistogramModule >	gmx::AnalysisDataWeightedHistogramModulePointer
	Smart pointer to manage an AnalysisDataWeightedHistogramModule object.
typedef std::shared_ptr < AnalysisDataBinAverageModule >	gmx::AnalysisDataBinAverageModulePointer
	Smart pointer to manage an AnalysisDataBinAverageModule object.

Functions
AnalysisHistogramSettingsInitializer	gmx::histogramFromRange (real min, real max)
	Initializes a histogram using a range and a bin width. More...
AnalysisHistogramSettingsInitializer	gmx::histogramFromBins (real start, int nbins, real binwidth)
	Initializes a histogram using bin width and the number of bins. More...