include/do_fit.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #ifndef _do_fit_h
  40 #define _do_fit_h
  41 #include "visibility.h"
  42 #include "typedefs.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 GMX_LIBGMX_EXPORT
  49 real calc_similar_ind(gmx_bool bRho,int nind,atom_id *index,real mass[],
  50                              rvec x[],rvec xp[]);
  51 /* Returns RMSD or Rho (depending on bRho) over all atoms in index */
  52
  53 GMX_LIBGMX_EXPORT
  54 real rmsdev_ind(int nind,atom_id index[],real mass[],
  55                        rvec x[],rvec xp[]);
  56 /* Returns the RMS Deviation betweem x and xp over all atoms in index */
  57
  58 GMX_LIBGMX_EXPORT
  59 real rmsdev(int natoms,real mass[],rvec x[],rvec xp[]);
  60 /* Returns the RMS Deviation betweem x and xp over all atoms */
  61
  62 real rhodev_ind(int nind,atom_id index[],real mass[],rvec x[],rvec xp[]);
  63 /* Returns size-independent Rho similarity parameter over all atoms in index
  64  * Maiorov & Crippen, PROTEINS 22, 273 (1995).
  65  */
  66
  67 real rhodev(int natoms,real mass[],rvec x[],rvec xp[]);
  68 /* Returns size-independent Rho similarity parameter over all atoms
  69  * Maiorov & Crippen, PROTEINS 22, 273 (1995).
  70  */
  71
  72 GMX_LIBGMX_EXPORT
  73 void calc_fit_R(int ndim,int natoms,real *w_rls,rvec *xp,rvec *x,
  74                        matrix R);
  75 /* Calculates the rotation matrix R for which
  76  * sum_i w_rls_i (xp_i - R x_i).(xp_i - R x_i)
  77  * is minimal. ndim=3 gives full fit, ndim=2 gives xy fit.
  78  * This matrix is also used do_fit.
  79  * x_rotated[i] = sum R[i][j]*x[j]
  80  */
  81
  82 GMX_LIBGMX_EXPORT
  83 void do_fit_ndim(int ndim,int natoms,real *w_rls,rvec *xp,rvec *x);
  84 /* Do a least squares fit of x to xp. Atoms which have zero mass
  85  * (w_rls[i]) are not taken into account in fitting.
  86  * This makes is possible to fit eg. on Calpha atoms and orient
  87  * all atoms. The routine only fits the rotational part,
  88  * therefore both xp and x should be centered round the origin.
  89  */
  90
  91 GMX_LIBGMX_EXPORT
  92 void do_fit(int natoms,real *w_rls,rvec *xp,rvec *x);
  93 /* Calls do_fit with ndim=3, thus fitting in 3D */
  94
  95 GMX_LIBGMX_EXPORT
  96 void reset_x_ndim(int ndim,int ncm,const atom_id *ind_cm,
  97                          int nreset,const atom_id *ind_reset,
  98                          rvec x[],const real mass[]);
  99 /* Put the center of mass of atoms in the origin for dimensions 0 to ndim.
 100  * The center of mass is computed from the index ind_cm.
 101  * When ind_cm!=NULL the COM is determined using ind_cm.
 102  * When ind_cm==NULL the COM is determined for atoms 0 to ncm.
 103  * When ind_reset!=NULL the coordinates indexed by ind_reset are reset.
 104  * When ind_reset==NULL the coordinates up to nreset are reset.
 105  */
 106
 107 GMX_LIBGMX_EXPORT
 108 void reset_x(int ncm,const atom_id *ind_cm,
 109                     int nreset,const atom_id *ind_reset,
 110                     rvec x[],const real mass[]);
 111 /* Calls reset_x with ndim=3, thus resetting all dimesions */
 112
 113 #ifdef __cplusplus
 114 }
 115 #endif
 116
 117 #endif  /* _do_fit_h */