Gromacs
2024.3
|
#include <gromacs/analysisdata/modules/histogram.h>
Contains parameters that specify histogram bin locations.
Methods in this class do not throw.
Public Member Functions | |
AnalysisHistogramSettings () | |
Initializes undefined parameters. | |
AnalysisHistogramSettings (const AnalysisHistogramSettingsInitializer &settings) | |
Initializes parameters based on a named parameter object. More... | |
real | firstEdge () const |
Returns the left edge of the first bin. | |
real | lastEdge () const |
Returns the right edge of the first bin. | |
int | binCount () const |
Returns the number of bins in the histogram. | |
real | binWidth () const |
Returns the width of a bin in the histogram. | |
bool | includeAll () const |
Whether values beyond the edges are mapped to the edge bins. | |
int | findBin (real y) const |
Returns a zero-based bin index for a value, or -1 if not in range. | |
gmx::AnalysisHistogramSettings::AnalysisHistogramSettings | ( | const AnalysisHistogramSettingsInitializer & | settings | ) |
Initializes parameters based on a named parameter object.
This constructor is not explicit to allow initialization of histograms directly from AnalysisHistogramSettingsInitializer: