2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2010,2011,2012,2013,2014, by the GROMACS development team, led by
5 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 * and including many others, as listed in the AUTHORS file in the
7 * top-level source directory and at http://www.gromacs.org.
9 * GROMACS is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * as published by the Free Software Foundation; either version 2.1
12 * of the License, or (at your option) any later version.
14 * GROMACS is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with GROMACS; if not, see
21 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * If you want to redistribute modifications to GROMACS, please
25 * consider that scientific software is very special. Version
26 * control is crucial - bugs must be traceable. We will be happy to
27 * consider code for inclusion in the official distribution, but
28 * derived work must not be called official GROMACS. Details are found
29 * in the README & COPYING files - if they are missing, get the
30 * official version at http://www.gromacs.org.
32 * To help us fund GROMACS development, we humbly ask that you cite
33 * the research papers on the package. Check out http://www.gromacs.org.
37 * Declares analysis data modules for calculating histograms.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_analysisdata
43 #ifndef GMX_ANALYSISDATA_MODULES_HISTOGRAM_H
44 #define GMX_ANALYSISDATA_MODULES_HISTOGRAM_H
46 #include <boost/shared_ptr.hpp>
48 #include "gromacs/analysisdata/abstractdata.h"
49 #include "gromacs/analysisdata/arraydata.h"
50 #include "gromacs/analysisdata/datamodule.h"
55 class AnalysisHistogramSettings;
58 * Provides "named parameter" idiom for constructing histograms.
60 * \see histogramFromBins()
61 * \see histogramFromRange()
63 * Methods in this class do not throw.
66 * \ingroup module_analysisdata
68 class AnalysisHistogramSettingsInitializer
72 * Creates an empty initializer.
74 * Should not be called directly, but histogramFromRange() or
75 * histogramFromBins() should be used instead.
77 AnalysisHistogramSettingsInitializer();
80 * Sets the first bin location.
82 * Typically should not be called directly, but through
83 * histogramFromBins().
85 AnalysisHistogramSettingsInitializer &start(real min)
86 { min_ = min; return *this; }
88 * Sets the number of bins in the histogram.
90 * If only the first bin location is specified, this value is required
91 * (and automatically provided if histogramFromBins() is used).
92 * If both the first and last bins are specified, either this value or
93 * binWidth() is required.
95 AnalysisHistogramSettingsInitializer &binCount(int binCount)
96 { binCount_ = binCount; return *this; }
98 * Sets the first and last bin locations.
100 * Typically should not be called directly, but through
101 * histogramFromRange().
103 AnalysisHistogramSettingsInitializer &range(real min, real max)
104 { min_ = min; max_ = max; return *this; }
106 * Sets the bin width of the histogram.
108 * If only the first bin location is specified, this value is required
109 * (and automatically provided if histogramFromBins() is used).
110 * If both the first and last bins are specified, either this value or
111 * binCount() is required.
112 * If a bin width is provided with both first and last bin locations,
113 * and the given bin width does not divide the range exactly, the last
114 * bin location is adjusted to match.
116 AnalysisHistogramSettingsInitializer &binWidth(real binWidth)
117 { binWidth_ = binWidth; return *this; }
119 * Indicate that first and last bin locations to specify bin centers.
121 * If set, the first and last bin locations are interpreted as bin
123 * If not set (the default), the first and last bin locations are
124 * interpreted as the edges of the whole histogram.
126 * Cannot be specified together with roundRange().
128 AnalysisHistogramSettingsInitializer &integerBins(bool enabled = true)
129 { bIntegerBins_ = enabled; return *this; }
131 * Round first and last bin locations.
133 * If set, the resulting histogram will cover the range specified, but
134 * the actual bin locations will be rounded such that the edges fall
135 * on multiples of the bin width.
136 * Only implemented when both first and last bin location and bin width
138 * Cannot be specified together with integerBins() or with binCount().
140 AnalysisHistogramSettingsInitializer &roundRange(bool enabled = true)
141 { bRoundRange_ = enabled; return *this; }
143 * Sets the histogram to match all values.
145 * If set, the histogram behaves as if the bins at the ends extended to
148 AnalysisHistogramSettingsInitializer &includeAll(bool enabled = true)
149 { bIncludeAll_ = enabled; return *this; }
160 friend class AnalysisHistogramSettings;
164 * Initializes a histogram using a range and a bin width.
170 inline AnalysisHistogramSettingsInitializer
171 histogramFromRange(real min, real max)
173 return AnalysisHistogramSettingsInitializer().range(min, max);
177 * Initializes a histogram using bin width and the number of bins.
183 inline AnalysisHistogramSettingsInitializer
184 histogramFromBins(real start, int nbins, real binwidth)
186 return AnalysisHistogramSettingsInitializer()
187 .start(start).binCount(nbins).binWidth(binwidth);
192 * Contains parameters that specify histogram bin locations.
194 * Methods in this class do not throw.
197 * \ingroup module_analysisdata
199 class AnalysisHistogramSettings
202 //! Initializes undefined parameters.
203 AnalysisHistogramSettings();
205 * Initializes parameters based on a named parameter object.
207 * This constructor is not explicit to allow initialization of
208 * histograms directly from AnalysisHistogramSettingsInitializer:
210 gmx::AnalysisDataSimpleHistogramModule *hist =
211 new gmx::AnalysisDataSimpleHistogramModule(
212 histogramFromRange(0.0, 5.0).binWidth(0.5));
215 AnalysisHistogramSettings(const AnalysisHistogramSettingsInitializer &settings);
217 //! Returns the left edge of the first bin.
218 real firstEdge() const { return firstEdge_; }
219 //! Returns the right edge of the first bin.
220 real lastEdge() const { return lastEdge_; }
221 //! Returns the number of bins in the histogram.
222 int binCount() const { return binCount_; }
223 //! Returns the width of a bin in the histogram.
224 real binWidth() const { return binWidth_; }
225 //! Whether values beyond the edges are mapped to the edge bins.
226 bool includeAll() const { return bAll_; }
227 //! Returns a zero-based bin index for a value, or -1 if not in range.
228 int findBin(real y) const;
234 real inverseBinWidth_;
243 class BasicHistogramImpl;
245 } // namespace internal
247 class AbstractAverageHistogram;
249 //! Smart pointer to manage an AbstractAverageHistogram object.
250 typedef boost::shared_ptr<AbstractAverageHistogram>
251 AverageHistogramPointer;
254 * Base class for representing histograms averaged over frames.
256 * The averaging module for a per-frame histogram is always created by the
257 * histogram module class (e.g., AnalysisDataSimpleHistogramModule), and can be
258 * accessed using, e.g., AnalysisDataSimpleHistogramModule::averager().
259 * The user can alter some properties of the average histogram directly, but
260 * the main use of the object is to postprocess the histogram once the
261 * calculation is finished.
263 * This class can represent multiple histograms in one object: each column in
264 * the data is an independent histogram.
267 * \ingroup module_analysisdata
269 class AbstractAverageHistogram : public AbstractAnalysisArrayData
272 virtual ~AbstractAverageHistogram();
274 //! Returns bin properties for the histogram.
275 const AnalysisHistogramSettings &settings() const { return settings_; }
278 * Creates a copy of the histogram with double the bin width.
280 * \throws std::bad_alloc if out of memory.
282 * The caller is responsible of deleting the returned object.
284 AverageHistogramPointer resampleDoubleBinWidth(bool bIntegerBins) const;
286 * Creates a deep copy of the histogram.
288 * \throws std::bad_alloc if out of memory.
290 * The returned histogram is not necessarily of the same dynamic type
291 * as the original object, but contains the same data from the point of
292 * view of the AbstractAverageHistogram interface.
294 * The caller is responsible of deleting the returned object.
296 AverageHistogramPointer clone() const;
297 //! Normalizes the histogram such that the integral over it is one.
298 void normalizeProbability();
299 //! Scales a single histogram by a uniform scaling factor.
300 void scaleSingle(int index, real factor);
301 //! Scales all histograms by a uniform scaling factor.
302 void scaleAll(real factor);
303 //! Scales the value of each bin by a different scaling factor.
304 void scaleAllByVector(real factor[]);
306 * Notifies attached modules of the histogram data.
308 * After this function has been called, it is no longer possible to
309 * alter the histogram.
311 void done() { AbstractAnalysisArrayData::valuesReady(); }
315 * Creates a histogram module with undefined bins.
317 * Bin parameters must be defined with init() before data input is
320 AbstractAverageHistogram();
321 //! Creates a histogram module with defined bin parameters.
322 explicit AbstractAverageHistogram(const AnalysisHistogramSettings &settings);
325 * (Re)initializes the histogram from settings.
327 void init(const AnalysisHistogramSettings &settings);
330 AnalysisHistogramSettings settings_;
332 // Copy and assign disallowed by base.
337 * Data module for per-frame histograms.
339 * Output data contains the same number of frames and data sets as the input
340 * data. Each frame contains the histogram(s) for the points in that frame.
341 * Each input data set is processed independently into the corresponding output
342 * data set. Missing values are ignored.
343 * All input columns for a data set are averaged into the same histogram.
344 * The number of columns for all data sets equals the number of bins in the
348 * \ingroup module_analysisdata
350 class AnalysisDataSimpleHistogramModule : public AbstractAnalysisData,
351 public AnalysisDataModuleParallel
355 * Creates a histogram module with undefined bins.
357 * Bin parameters must be defined with init() before data input is
360 AnalysisDataSimpleHistogramModule();
361 //! Creates a histogram module with defined bin parameters.
362 explicit AnalysisDataSimpleHistogramModule(const AnalysisHistogramSettings &settings);
363 virtual ~AnalysisDataSimpleHistogramModule();
366 * (Re)initializes the histogram from settings.
368 void init(const AnalysisHistogramSettings &settings);
371 * Returns the average histogram over all frames.
373 * Can be called already before the histogram is calculated to
374 * customize the way the average histogram is calculated.
376 * \see AbstractAverageHistogram
378 AbstractAverageHistogram &averager();
380 //! Returns bin properties for the histogram.
381 const AnalysisHistogramSettings &settings() const;
383 virtual int frameCount() const;
385 virtual int flags() const;
387 virtual bool parallelDataStarted(
388 AbstractAnalysisData *data,
389 const AnalysisDataParallelOptions &options);
390 virtual void frameStarted(const AnalysisDataFrameHeader &header);
391 virtual void pointsAdded(const AnalysisDataPointSetRef &points);
392 virtual void frameFinished(const AnalysisDataFrameHeader &header);
393 virtual void dataFinished();
396 virtual AnalysisDataFrameRef tryGetDataFrameInternal(int index) const;
397 virtual bool requestStorageInternal(int nframes);
399 PrivateImplPointer<internal::BasicHistogramImpl> impl_;
401 // Copy and assign disallowed by base.
406 * Data module for per-frame weighted histograms.
408 * Output data contains the same number of frames and data sets as the input
409 * data. Each frame contains the histogram(s) for the points in that frame,
410 * interpreted such that the first column passed to pointsAdded() determines
411 * the bin and the rest give weights to be added to that bin (input data should
412 * have at least two colums, and at least two columns should be added at the
414 * Each input data set is processed independently into the corresponding output
416 * All input columns for a data set are averaged into the same histogram.
417 * The number of columns for all data sets equals the number of bins in the
421 * \ingroup module_analysisdata
423 class AnalysisDataWeightedHistogramModule : public AbstractAnalysisData,
424 public AnalysisDataModuleParallel
427 //! \copydoc AnalysisDataSimpleHistogramModule::AnalysisDataSimpleHistogramModule()
428 AnalysisDataWeightedHistogramModule();
429 //! \copydoc AnalysisDataSimpleHistogramModule::AnalysisDataSimpleHistogramModule(const AnalysisHistogramSettings &)
430 explicit AnalysisDataWeightedHistogramModule(const AnalysisHistogramSettings &settings);
431 virtual ~AnalysisDataWeightedHistogramModule();
433 //! \copydoc AnalysisDataSimpleHistogramModule::init()
434 void init(const AnalysisHistogramSettings &settings);
436 //! \copydoc AnalysisDataSimpleHistogramModule::averager()
437 AbstractAverageHistogram &averager();
439 //! \copydoc AnalysisDataSimpleHistogramModule::settings()
440 const AnalysisHistogramSettings &settings() const;
442 virtual int frameCount() const;
444 virtual int flags() const;
446 virtual bool parallelDataStarted(
447 AbstractAnalysisData *data,
448 const AnalysisDataParallelOptions &options);
449 virtual void frameStarted(const AnalysisDataFrameHeader &header);
450 virtual void pointsAdded(const AnalysisDataPointSetRef &points);
451 virtual void frameFinished(const AnalysisDataFrameHeader &header);
452 virtual void dataFinished();
455 virtual AnalysisDataFrameRef tryGetDataFrameInternal(int index) const;
456 virtual bool requestStorageInternal(int nframes);
458 PrivateImplPointer<internal::BasicHistogramImpl> impl_;
460 // Copy and assign disallowed by base.
465 * Data module for bin averages.
467 * Output data contains one row for each bin; see AbstractAverageHistogram.
468 * Output data contains one column for each input data set.
469 * The value in a column is the average over all frames of that data set for
471 * The input data is interpreted such that the first column passed to
472 * pointsAdded() determines the bin and the rest give values to be added to
473 * that bin (input data should have at least two colums, and at least two
474 * columns should be added at the same time).
475 * All input columns for a data set are averaged into the same histogram.
478 * \ingroup module_analysisdata
480 class AnalysisDataBinAverageModule : public AbstractAnalysisArrayData,
481 public AnalysisDataModuleSerial
484 //! \copydoc AnalysisDataSimpleHistogramModule::AnalysisDataSimpleHistogramModule()
485 AnalysisDataBinAverageModule();
486 //! \copydoc AnalysisDataSimpleHistogramModule::AnalysisDataSimpleHistogramModule(const AnalysisHistogramSettings &)
487 explicit AnalysisDataBinAverageModule(const AnalysisHistogramSettings &settings);
488 virtual ~AnalysisDataBinAverageModule();
490 //! \copydoc AnalysisDataSimpleHistogramModule::init()
491 void init(const AnalysisHistogramSettings &settings);
493 //! \copydoc AnalysisDataSimpleHistogramModule::settings()
494 const AnalysisHistogramSettings &settings() const;
496 virtual int flags() const;
498 virtual void dataStarted(AbstractAnalysisData *data);
499 virtual void frameStarted(const AnalysisDataFrameHeader &header);
500 virtual void pointsAdded(const AnalysisDataPointSetRef &points);
501 virtual void frameFinished(const AnalysisDataFrameHeader &header);
502 virtual void dataFinished();
507 PrivateImplPointer<Impl> impl_;
509 // Copy and assign disallowed by base.
512 //! Smart pointer to manage an AnalysisDataSimpleHistogramModule object.
513 typedef boost::shared_ptr<AnalysisDataSimpleHistogramModule>
514 AnalysisDataSimpleHistogramModulePointer;
515 //! Smart pointer to manage an AnalysisDataWeightedHistogramModule object.
516 typedef boost::shared_ptr<AnalysisDataWeightedHistogramModule>
517 AnalysisDataWeightedHistogramModulePointer;
518 //! Smart pointer to manage an AnalysisDataBinAverageModule object.
519 typedef boost::shared_ptr<AnalysisDataBinAverageModule>
520 AnalysisDataBinAverageModulePointer;