src/gromacs/analysisdata/modules/average.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * directory and at http://www.gromacs.org.
   8  *
   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.
  13  *
  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.
  18  *
  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.
  23  *
  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.
  31  *
  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.
  34  */
  35 /*! \file
  36  * \brief
  37  * Declares gmx::AnalysisDataAverageModule.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_analysisdata
  42  */
  43 #ifndef GMX_ANALYSISDATA_MODULES_AVERAGE_H
  44 #define GMX_ANALYSISDATA_MODULES_AVERAGE_H
  45
  46 #include <vector>
  47
  48 #include "../abstractdata.h"
  49 #include "../arraydata.h"
  50 #include "../datamodule.h"
  51 #include "../../utility/common.h"
  52
  53 namespace gmx
  54 {
  55
  56 /*! \brief
  57  * Data module for simple averaging of columns.
  58  *
  59  * Output data contains a frame for each column of input data.
  60  * There are two columns: the average and standard deviation of
  61  * that column.
  62  * The data becomes available only after the original data has been
  63  * finished.
  64  *
  65  * Multipoint data and missing data points are both supported. The average
  66  * is always calculated over all data points present in a column.
  67  *
  68  * \inpublicapi
  69  * \ingroup module_analysisdata
  70  */
  71 class AnalysisDataAverageModule : public AbstractAnalysisArrayData,
  72                                   public AnalysisDataModuleInterface
  73 {
  74     public:
  75         AnalysisDataAverageModule();
  76         virtual ~AnalysisDataAverageModule();
  77
  78         using AbstractAnalysisArrayData::setXAxis;
  79
  80         virtual int flags() const;
  81
  82         virtual void dataStarted(AbstractAnalysisData *data);
  83         virtual void frameStarted(const AnalysisDataFrameHeader &header);
  84         virtual void pointsAdded(const AnalysisDataPointSetRef &points);
  85         virtual void frameFinished(const AnalysisDataFrameHeader &header);
  86         virtual void dataFinished();
  87
  88         //! Convenience access to the average of a data column.
  89         real average(int index) const;
  90         //! Convenience access to the standard deviation of a data column.
  91         real stddev(int index) const;
  92
  93     private:
  94         std::vector<int>        nsamples_;
  95
  96         // Copy and assign disallowed by base.
  97 };
  98
  99 //! Smart pointer to manage an AnalysisDataAverageModule object.
 100 typedef boost::shared_ptr<AnalysisDataAverageModule>
 101     AnalysisDataAverageModulePointer;
 102
 103 /*! \brief
 104  * Data module for averaging of columns for each frame.
 105  *
 106  * Output data has the same number of frames as the input data, but only one
 107  * column.
 108  * Each frame in the output contains the average of the column values in the
 109  * corresponding frame of the input data.
 110  *
 111  * Multipoint data and missing data points are both supported. The average
 112  * is always calculated over all data points present in a column.
 113  *
 114  * \inpublicapi
 115  * \ingroup module_analysisdata
 116  */
 117 class AnalysisDataFrameAverageModule : public AbstractAnalysisData,
 118                                        public AnalysisDataModuleInterface
 119 {
 120     public:
 121         AnalysisDataFrameAverageModule();
 122         virtual ~AnalysisDataFrameAverageModule();
 123
 124         virtual int flags() const;
 125
 126         virtual void dataStarted(AbstractAnalysisData *data);
 127         virtual void frameStarted(const AnalysisDataFrameHeader &header);
 128         virtual void pointsAdded(const AnalysisDataPointSetRef &points);
 129         virtual void frameFinished(const AnalysisDataFrameHeader &header);
 130         virtual void dataFinished();
 131
 132     private:
 133         virtual AnalysisDataFrameRef tryGetDataFrameInternal(int index) const;
 134         virtual bool requestStorageInternal(int nframes);
 135
 136         class Impl;
 137
 138         PrivateImplPointer<Impl> impl_;
 139 };
 140
 141 //! Smart pointer to manage an AnalysisDataFrameAverageModule object.
 142 typedef boost::shared_ptr<AnalysisDataFrameAverageModule>
 143     AnalysisDataFrameAverageModulePointer;
 144
 145 } // namespace gmx
 146
 147 #endif