src/gromacs/math/densityfit.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,2020,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.
   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 /*! \libinternal \file
  36  * \brief
  37  * Declares density similarity measures and their derivatives.
  38  *
  39  * \author Christian Blau <blau@kth.se>
  40  * \inlibraryapi
  41  * \ingroup module_math
  42  */
  43 #ifndef GMX_MATH_DENSITYFIT_H
  44 #define GMX_MATH_DENSITYFIT_H
  45
  46 #include <memory>
  47
  48 #include "gromacs/mdspan/extensions.h"
  49 #include "gromacs/utility/real.h"
  50
  51 namespace gmx
  52 {
  53 /*! \brief
  54  * The methods that determine how two densities are compared to one another.
  55  */
  56 enum class DensitySimilarityMeasureMethod : int
  57 {
  58     /*! \brief Measure similarity between densities as normalized inner product of their
  59      * voxel values.
  60      *
  61      * \f[
  62      *      \mathrm{Similarity}(\rho_{\mathrm{r}},\rho_{\mathrm{c}}) =
  63      *           \frac{1}{N_\mathrm{voxel}}/\sum_{v=1}^{N_\mathrm{voxel}} \rho^v_{\mathrm{r}}
  64      * \rho^v_{\mathrm{c}}
  65      * \f]
  66      */
  67     innerProduct,
  68
  69     /*! \brief Measure similarity between densities by negative relative entropy.
  70      * \note Voxels with negative values are ignored.
  71      *
  72      * \f[
  73      *      \mathrm{Similarity}(\rho_{\mathrm{r}},\rho_{\mathrm{c}}) =
  74      *           \sum_{v=1}^{N_\mathrm{voxel}}
  75      *              \rho^v_{\mathrm{r}} (\log(\rho^v_{\mathrm{c}}) - \log(\rho^v_{\mathrm{r}}))
  76      * \f]
  77      */
  78     relativeEntropy,
  79
  80     /*! \brief Measure similarity between densities by cross correlation.
  81      *
  82      * \f[
  83      *      \mathrm{Similarity}(\rho_{\mathrm{r}},\rho_{\mathrm{c}}) =
  84      *           \frac{\sum_{v}\left((\rho_{\mathrm{r}} - \bar{\rho}_{\mathrm{r}})(\rho_{\mathrm{c}} - \bar{\rho}_{\mathrm{c}})\right)}
  85      *           {\sqrt{\sum_v(\rho_{\mathrm{r}} - \bar{\rho}_{\mathrm{r}})^2 \sum_v (\rho_{\mathrm{c}} - \bar{\rho}_{\mathrm{c}})^2}}
  86      * \f]
  87      */
  88     crossCorrelation,
  89     Count,
  90 };
  91
  92 /* Forward declaration of implementation class outside class to allow
  93  * choose implementation class during construction of the DensitySimilarityMeasure*/
  94 class DensitySimilarityMeasureImpl;
  95
  96 /*! \libinternal \brief
  97  *  Measure similarity and gradient between densities.
  98  */
  99 class DensitySimilarityMeasure
 100 {
 101 public:
 102     //! a three-dimensional const view into density data
 103     using density = basic_mdspan<const float, dynamicExtents3D>;
 104     /*! \brief Chose comparison method and set reference density.
 105      * \param[in] method defines how densities are compared to one another
 106      * \param[in] referenceDensity
 107      * \throws NotImplementedError if method is not known
 108      */
 109     DensitySimilarityMeasure(DensitySimilarityMeasureMethod method, density referenceDensity);
 110     ~DensitySimilarityMeasure();
 111     //! Copy constructor
 112     DensitySimilarityMeasure(const DensitySimilarityMeasure& other);
 113     //! Copy assignment
 114     DensitySimilarityMeasure& operator=(const DensitySimilarityMeasure& other);
 115     //! Move constructor
 116     DensitySimilarityMeasure(DensitySimilarityMeasure&& other) noexcept;
 117     //! Move assignment
 118     DensitySimilarityMeasure& operator=(DensitySimilarityMeasure&& other) noexcept;
 119
 120     /*! \brief Derivative of the density similarity measure at all voxels.
 121      * \param[in] comparedDensity the variable density
 122      * \returns density similarity measure derivative
 123      */
 124     density gradient(density comparedDensity);
 125     /*! \brief Similarity between reference and compared density.
 126      * \param[in] comparedDensity the variable density
 127      * \returns density similarity
 128      */
 129     real similarity(density comparedDensity);
 130
 131 private:
 132     std::unique_ptr<DensitySimilarityMeasureImpl> impl_;
 133 };
 134
 135 } // namespace gmx
 136
 137 #endif