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 "../arraydata.h"
  43 #include "../datamodule.h"
  44
  45 namespace gmx
  46 {
  47
  48 /*! \brief
  49  * Data module for simple averaging of columns.
  50  *
  51  * Output data contains a frame for each column of input data.
  52  * There are two columns: the average and standard deviation of
  53  * that column.
  54  * The data becomes available only after the original data has been
  55  * finished.
  56  *
  57  * Multipoint data and missing data points are both supported. The average
  58  * is always calculated over all data points present in a column.
  59  *
  60  * \inpublicapi
  61  * \ingroup module_analysisdata
  62  */
  63 class AnalysisDataAverageModule : public AbstractAnalysisArrayData,
  64                                   public AnalysisDataModuleInterface
  65 {
  66     public:
  67         AnalysisDataAverageModule();
  68         virtual ~AnalysisDataAverageModule();
  69
  70         using AbstractAnalysisArrayData::setXAxis;
  71
  72         virtual int flags() const;
  73
  74         virtual void dataStarted(AbstractAnalysisData *data);
  75         virtual void frameStarted(const AnalysisDataFrameHeader &header);
  76         virtual void pointsAdded(const AnalysisDataPointSetRef &points);
  77         virtual void frameFinished(const AnalysisDataFrameHeader &header);
  78         virtual void dataFinished();
  79
  80         //! Convenience access to the average of a data column.
  81         real average(int index) const;
  82         //! Convenience access to the standard deviation of a data column.
  83         real stddev(int index) const;
  84
  85     private:
  86         int                    *_nsamples;
  87
  88         // Copy and assign disallowed by base.
  89 };
  90
  91 //! Smart pointer to manage an AnalysisDataAverageModule object.
  92 typedef boost::shared_ptr<AnalysisDataAverageModule>
  93         AnalysisDataAverageModulePointer;
  94
  95 } // namespace gmx
  96
  97 #endif