2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2010,2011,2012,2013, by the GROMACS development team, led by
5 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 * and including many others, as listed in the AUTHORS file in the
7 * top-level source directory and at http://www.gromacs.org.
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.
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.
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.
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.
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.
37 * Declares gmx::AnalysisDataAverageModule.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_analysisdata
43 #ifndef GMX_ANALYSISDATA_MODULES_AVERAGE_H
44 #define GMX_ANALYSISDATA_MODULES_AVERAGE_H
48 #include "../abstractdata.h"
49 #include "../arraydata.h"
50 #include "../datamodule.h"
51 #include "../../utility/common.h"
57 * Data module for independently averaging each column in input data.
59 * Computes the average and standard deviation independently for each column in
60 * the input data. Multipoint data, multiple data sets, and missing data
61 * points are all supported.
62 * The average is always calculated over all frames and data points for a
65 * Output data contains a column for each data set in the input data, and a
66 * frame for each column in the input data. If different data sets have
67 * different number of columns, the frame count accomodates the largest data
68 * set. Other columns are padded with zero values that are additionally marked
70 * Each value in the output data is the average of the corresponding
71 * input column in the corresponding input data set. The error value for each
72 * value provides the standard deviation of the corresponding input column.
73 * average(), standardDeviation(), and sampleCount() methods are also
74 * provided for convenient access to these properties.
76 * The output data becomes available only after the input data has been
80 * \ingroup module_analysisdata
82 class AnalysisDataAverageModule : public AbstractAnalysisArrayData,
83 public AnalysisDataModuleSerial
86 AnalysisDataAverageModule();
87 virtual ~AnalysisDataAverageModule();
89 using AbstractAnalysisArrayData::setXAxis;
92 * Sets the averaging to happen over entire data sets.
94 * If \p bDataSets is false (the default), the module averages each
95 * column separately. The output will have a column for each data set,
96 * and a row for each column.
98 * If \p bDataSets is true, the module averages all values within
99 * a single data set into a single average/standard deviation.
100 * The output will have only one column, with one row for each data
103 void setAverageDataSets(bool bDataSets);
105 virtual int flags() const;
107 virtual void dataStarted(AbstractAnalysisData *data);
108 virtual void frameStarted(const AnalysisDataFrameHeader &header);
109 virtual void pointsAdded(const AnalysisDataPointSetRef &points);
110 virtual void frameFinished(const AnalysisDataFrameHeader &header);
111 virtual void dataFinished();
114 * Convenience access to the average of a data column.
116 * Note that the interpretation of the parameters follows their naming:
117 * with \c setAverageDataSets(false), \p dataSet corresponds to a
118 * column in the output, but with \c setAverageDataSets(false) it
119 * corresponds to an output row. In both cases, it selects the data
120 * set; with \c setAverageDataSets(false), \p column should always be
121 * zero as there is only one value per data set.
123 real average(int dataSet, int column) const;
125 * Convenience access to the standard deviation of a data column.
127 * See average() for the interpretation of the parameters.
129 real standardDeviation(int dataSet, int column) const;
131 * Access the number of samples for a data column.
133 * See average() for the interpretation of the parameters.
135 int sampleCount(int dataSet, int column) const;
140 PrivateImplPointer<Impl> impl_;
143 //! Smart pointer to manage an AnalysisDataAverageModule object.
144 typedef boost::shared_ptr<AnalysisDataAverageModule>
145 AnalysisDataAverageModulePointer;
148 * Data module for averaging of columns for each frame.
150 * Output data has the same number of frames as the input data.
151 * The number of columns in the output data is the same as the number of data
152 * sets in the input data.
153 * Each frame in the output contains the average of the column values for each
154 * data set in the corresponding frame of the input data.
156 * Multipoint data and missing data points are both supported. The average
157 * is always calculated over all data points present in a column for a data
161 * \ingroup module_analysisdata
163 class AnalysisDataFrameAverageModule : public AbstractAnalysisData,
164 public AnalysisDataModuleSerial
167 AnalysisDataFrameAverageModule();
168 virtual ~AnalysisDataFrameAverageModule();
170 virtual int frameCount() const;
172 virtual int flags() const;
174 virtual void dataStarted(AbstractAnalysisData *data);
175 virtual void frameStarted(const AnalysisDataFrameHeader &header);
176 virtual void pointsAdded(const AnalysisDataPointSetRef &points);
177 virtual void frameFinished(const AnalysisDataFrameHeader &header);
178 virtual void dataFinished();
181 virtual AnalysisDataFrameRef tryGetDataFrameInternal(int index) const;
182 virtual bool requestStorageInternal(int nframes);
186 PrivateImplPointer<Impl> impl_;
189 //! Smart pointer to manage an AnalysisDataFrameAverageModule object.
190 typedef boost::shared_ptr<AnalysisDataFrameAverageModule>
191 AnalysisDataFrameAverageModulePointer;