3 * This source code is part of
7 * GROningen MAchine for Chemical Simulations
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.
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.
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.
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.
29 * For more info, check our website at http://www.gromacs.org
33 * Declares gmx::AnalysisDataAverageModule.
35 * \author Teemu Murtola <teemu.murtola@cbr.su.se>
37 * \ingroup module_analysisdata
39 #ifndef GMX_ANALYSISDATA_MODULES_AVERAGE_H
40 #define GMX_ANALYSISDATA_MODULES_AVERAGE_H
42 #include "../arraydata.h"
43 #include "../datamodule.h"
49 * Data module for simple averaging of columns.
51 * Output data contains a frame for each column of input data.
52 * There are two columns: the average and standard deviation of
54 * The data becomes available only after the original data has been
57 * Multipoint data and missing data points are both supported. The average
58 * is always calculated over all data points present in a column.
61 * \ingroup module_analysisdata
63 class AnalysisDataAverageModule : public AbstractAnalysisArrayData,
64 public AnalysisDataModuleInterface
67 AnalysisDataAverageModule();
68 virtual ~AnalysisDataAverageModule();
70 using AbstractAnalysisArrayData::setXAxis;
72 virtual int flags() const;
74 virtual int dataStarted(AbstractAnalysisData *data);
75 virtual int frameStarted(real x, real dx);
76 virtual int pointsAdded(real x, real dx, int firstcol, int n,
77 const real *y, const real *dy,
79 virtual int frameFinished();
80 virtual int dataFinished();
82 //! Convenience access to the average of a data column.
83 real average(int index) const;
84 //! Convenience access to the standard deviation of a data column.
85 real stddev(int index) const;
90 // Copy and assign disallowed by base.