2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2013,2014,2015,2018,2019,2021, 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::AnalysisDataLifetimeModule.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_analysisdata
43 #ifndef GMX_ANALYSISDATA_MODULES_LIFETIME_H
44 #define GMX_ANALYSISDATA_MODULES_LIFETIME_H
48 #include "gromacs/analysisdata/arraydata.h"
49 #include "gromacs/analysisdata/datamodule.h"
55 * Data module for computing lifetime histograms for columns in input data.
57 * The input data set is treated as a boolean array: each value that is present
58 * (AnalysisDataValue::isPresent() returns true) and is >0 is treated as
59 * present, other values are treated as absent.
60 * For each input data set, analyzes the columns to identify the intervals
61 * where a column is continuously present.
62 * Produces a histogram from the lengths of these intervals.
63 * Input data should have frames with evenly spaced x values.
65 * Output data contains one column for each data set in the input data.
66 * This column gives the lifetime histogram for the corresponding data set.
67 * x axis in the output is spaced the same as in the input data, and extends
68 * as long as required to cover all the histograms.
69 * Histograms are padded with zeros as required to be of the same length.
70 * setCumulative() can be used to alter the handling of subintervals in the
73 * The output data becomes available only after the input data has been
77 * \ingroup module_analysisdata
79 class AnalysisDataLifetimeModule : public AbstractAnalysisArrayData, public AnalysisDataModuleSerial
82 AnalysisDataLifetimeModule();
83 ~AnalysisDataLifetimeModule() override;
86 * Sets a cumulative histogram mode.
88 * \param[in] bCumulative If true, all subintervals of a long
89 * interval are also explicitly added into the histogram.
93 void setCumulative(bool bCumulative);
95 int flags() const override;
97 void dataStarted(AbstractAnalysisData* data) override;
98 void frameStarted(const AnalysisDataFrameHeader& header) override;
99 void pointsAdded(const AnalysisDataPointSetRef& points) override;
100 void frameFinished(const AnalysisDataFrameHeader& header) override;
101 void dataFinished() override;
106 std::unique_ptr<Impl> impl_;
109 //! Smart pointer to manage an AnalysisDataLifetimeModule object.
110 typedef std::shared_ptr<AnalysisDataLifetimeModule> AnalysisDataLifetimeModulePointer;