src/gromacs/analysisdata/modules/average.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \file
  32  * \brief
  33  * Declares gmx::AnalysisDataAverageModule.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \inpublicapi
  37  * \ingroup module_analysisdata
  38  */
  39 #ifndef GMX_ANALYSISDATA_MODULES_AVERAGE_H
  40 #define GMX_ANALYSISDATA_MODULES_AVERAGE_H
  41
  42 #include <vector>
  43
  44 #include "../abstractdata.h"
  45 #include "../arraydata.h"
  46 #include "../datamodule.h"
  47 #include "../../utility/common.h"
  48
  49 namespace gmx
  50 {
  51
  52 /*! \brief
  53  * Data module for simple averaging of columns.
  54  *
  55  * Output data contains a frame for each column of input data.
  56  * There are two columns: the average and standard deviation of
  57  * that column.
  58  * The data becomes available only after the original data has been
  59  * finished.
  60  *
  61  * Multipoint data and missing data points are both supported. The average
  62  * is always calculated over all data points present in a column.
  63  *
  64  * \inpublicapi
  65  * \ingroup module_analysisdata
  66  */
  67 class AnalysisDataAverageModule : public AbstractAnalysisArrayData,
  68                                   public AnalysisDataModuleInterface
  69 {
  70     public:
  71         AnalysisDataAverageModule();
  72         virtual ~AnalysisDataAverageModule();
  73
  74         using AbstractAnalysisArrayData::setXAxis;
  75
  76         virtual int flags() const;
  77
  78         virtual void dataStarted(AbstractAnalysisData *data);
  79         virtual void frameStarted(const AnalysisDataFrameHeader &header);
  80         virtual void pointsAdded(const AnalysisDataPointSetRef &points);
  81         virtual void frameFinished(const AnalysisDataFrameHeader &header);
  82         virtual void dataFinished();
  83
  84         //! Convenience access to the average of a data column.
  85         real average(int index) const;
  86         //! Convenience access to the standard deviation of a data column.
  87         real stddev(int index) const;
  88
  89     private:
  90         std::vector<int>        nsamples_;
  91
  92         // Copy and assign disallowed by base.
  93 };
  94
  95 //! Smart pointer to manage an AnalysisDataAverageModule object.
  96 typedef boost::shared_ptr<AnalysisDataAverageModule>
  97     AnalysisDataAverageModulePointer;
  98
  99 /*! \brief
 100  * Data module for averaging of columns for each frame.
 101  *
 102  * Output data has the same number of frames as the input data, but only one
 103  * column.
 104  * Each frame in the output contains the average of the column values in the
 105  * corresponding frame of the input data.
 106  *
 107  * Multipoint data and missing data points are both supported. The average
 108  * is always calculated over all data points present in a column.
 109  *
 110  * \inpublicapi
 111  * \ingroup module_analysisdata
 112  */
 113 class AnalysisDataFrameAverageModule : public AbstractAnalysisData,
 114                                        public AnalysisDataModuleInterface
 115 {
 116     public:
 117         AnalysisDataFrameAverageModule();
 118         virtual ~AnalysisDataFrameAverageModule();
 119
 120         virtual int flags() const;
 121
 122         virtual void dataStarted(AbstractAnalysisData *data);
 123         virtual void frameStarted(const AnalysisDataFrameHeader &header);
 124         virtual void pointsAdded(const AnalysisDataPointSetRef &points);
 125         virtual void frameFinished(const AnalysisDataFrameHeader &header);
 126         virtual void dataFinished();
 127
 128     private:
 129         virtual AnalysisDataFrameRef tryGetDataFrameInternal(int index) const;
 130         virtual bool requestStorageInternal(int nframes);
 131
 132         class Impl;
 133
 134         PrivateImplPointer<Impl> impl_;
 135 };
 136
 137 //! Smart pointer to manage an AnalysisDataFrameAverageModule object.
 138 typedef boost::shared_ptr<AnalysisDataFrameAverageModule>
 139     AnalysisDataFrameAverageModulePointer;
 140
 141 } // namespace gmx
 142
 143 #endif