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,2013, 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 independently averaging each column in input data.
  58  *
  59  * Computes the average and standard deviation independently for each column in
  60  * the input data.  Multipoint data and missing data points are both supported.
  61  * The average is always calculated over all frames and data points for a
  62  * column.
  63  * Multiple input data sets are currently not supported.
  64  *
  65  * Output data contains a frame for each column in the input data.
  66  * The first column of each output frame is the average of the corresponding
  67  * input column.  The second output column is the standard deviation of the
  68  * corresponding input column.
  69  * average() and stddev() methods are also provided for convenient access to
  70  * these properties.
  71  *
  72  * The output data becomes available only after the input data has been
  73  * finished.
  74  *
  75  * \inpublicapi
  76  * \ingroup module_analysisdata
  77  */
  78 class AnalysisDataAverageModule : public AbstractAnalysisArrayData,
  79                                   public AnalysisDataModuleInterface
  80 {
  81     public:
  82         AnalysisDataAverageModule();
  83         virtual ~AnalysisDataAverageModule();
  84
  85         using AbstractAnalysisArrayData::setXAxis;
  86
  87         virtual int flags() const;
  88
  89         virtual void dataStarted(AbstractAnalysisData *data);
  90         virtual void frameStarted(const AnalysisDataFrameHeader &header);
  91         virtual void pointsAdded(const AnalysisDataPointSetRef &points);
  92         virtual void frameFinished(const AnalysisDataFrameHeader &header);
  93         virtual void dataFinished();
  94
  95         //! Convenience access to the average of a data column.
  96         real average(int index) const;
  97         //! Convenience access to the standard deviation of a data column.
  98         real stddev(int index) const;
  99
 100     private:
 101         class Impl;
 102
 103         PrivateImplPointer<Impl> impl_;
 104 };
 105
 106 //! Smart pointer to manage an AnalysisDataAverageModule object.
 107 typedef boost::shared_ptr<AnalysisDataAverageModule>
 108     AnalysisDataAverageModulePointer;
 109
 110 /*! \brief
 111  * Data module for averaging of columns for each frame.
 112  *
 113  * Output data has the same number of frames as the input data.
 114  * The number of columns in the output data is the same as the number of data
 115  * sets in the input data.
 116  * Each frame in the output contains the average of the column values for each
 117  * data set in the corresponding frame of the input data.
 118  *
 119  * Multipoint data and missing data points are both supported.  The average
 120  * is always calculated over all data points present in a column for a data
 121  * set.
 122  *
 123  * \inpublicapi
 124  * \ingroup module_analysisdata
 125  */
 126 class AnalysisDataFrameAverageModule : public AbstractAnalysisData,
 127                                        public AnalysisDataModuleInterface
 128 {
 129     public:
 130         AnalysisDataFrameAverageModule();
 131         virtual ~AnalysisDataFrameAverageModule();
 132
 133         virtual int flags() const;
 134
 135         virtual void dataStarted(AbstractAnalysisData *data);
 136         virtual void frameStarted(const AnalysisDataFrameHeader &header);
 137         virtual void pointsAdded(const AnalysisDataPointSetRef &points);
 138         virtual void frameFinished(const AnalysisDataFrameHeader &header);
 139         virtual void dataFinished();
 140
 141     private:
 142         virtual AnalysisDataFrameRef tryGetDataFrameInternal(int index) const;
 143         virtual bool requestStorageInternal(int nframes);
 144
 145         class Impl;
 146
 147         PrivateImplPointer<Impl> impl_;
 148 };
 149
 150 //! Smart pointer to manage an AnalysisDataFrameAverageModule object.
 151 typedef boost::shared_ptr<AnalysisDataFrameAverageModule>
 152     AnalysisDataFrameAverageModulePointer;
 153
 154 } // namespace gmx
 155
 156 #endif