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