src/tools/gmx_helix.c

   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,2013, 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 #ifdef HAVE_CONFIG_H
  39 #include <config.h>
  40 #endif
  41
  42 #include <math.h>
  43
  44 #include "confio.h"
  45 #include "copyrite.h"
  46 #include "gmx_fatal.h"
  47 #include "fitahx.h"
  48 #include "futil.h"
  49 #include "gstat.h"
  50 #include "wgms.h"
  51 #include "hxprops.h"
  52 #include "macros.h"
  53 #include "maths.h"
  54 #include "pbc.h"
  55 #include "tpxio.h"
  56 #include "physics.h"
  57 #include "index.h"
  58 #include "smalloc.h"
  59 #include "statutil.h"
  60 #include <string.h>
  61 #include "sysstuff.h"
  62 #include "txtdump.h"
  63 #include "typedefs.h"
  64 #include "vec.h"
  65 #include "xvgr.h"
  66 #include "gmx_ana.h"
  67
  68 void dump_otrj(FILE *otrj,int natoms,atom_id all_index[],rvec x[],
  69                real fac,rvec xav[])
  70 {
  71   static FILE *fp=NULL;
  72   static real fac0=1.0;
  73
  74   int  i,ai,m;
  75   real xa,xm;
  76
  77   if (fp==NULL) {
  78     fp=ffopen("WEDGAMMA10.DAT","w");
  79     fac0=fac;
  80   }
  81   fac/=fac0;
  82
  83   fprintf(fp,"%10g\n",fac);
  84
  85   for(i=0; (i<natoms); i++) {
  86     ai=all_index[i];
  87     for(m=0; (m<DIM); m++) {
  88       xa = xav[ai][m];
  89       xm = x[ai][m]*fac;
  90       xav[ai][m] = xa+xm;
  91       x[ai][m]   = xm;
  92     }
  93   }
  94   write_gms_ndx(otrj,natoms,all_index,x,NULL);
  95 }
  96
  97 int gmx_helix(int argc,char *argv[])
  98 {
  99   const char *desc[] = {
 100     "[TT]g_helix[tt] computes all kinds of helix properties. First, the peptide",
 101     "is checked to find the longest helical part, as determined by",
 102     "hydrogen bonds and [GRK]phi[grk]/[GRK]psi[grk] angles.",
 103     "That bit is fitted",
 104     "to an ideal helix around the [IT]z[it]-axis and centered around the origin.",
 105     "Then the following properties are computed:[PAR]",
 106     "[BB]1.[bb] Helix radius (file [TT]radius.xvg[tt]). This is merely the",
 107     "RMS deviation in two dimensions for all C[GRK]alpha[grk] atoms.",
 108     "it is calculated as [SQRT]([SUM][sum][SUB]i[sub] (x^2(i)+y^2(i)))/N[sqrt] where N is the number",
 109     "of backbone atoms. For an ideal helix the radius is 0.23 nm[BR]",
 110     "[BB]2.[bb] Twist (file [TT]twist.xvg[tt]). The average helical angle per",
 111     "residue is calculated. For an [GRK]alpha[grk]-helix it is 100 degrees,",
 112     "for 3-10 helices it will be smaller, and ",
 113     "for 5-helices it will be larger.[BR]",
 114     "[BB]3.[bb] Rise per residue (file [TT]rise.xvg[tt]). The helical rise per",
 115     "residue is plotted as the difference in [IT]z[it]-coordinate between C[GRK]alpha[grk]",
 116     "atoms. For an ideal helix, this is 0.15 nm[BR]",
 117     "[BB]4.[bb] Total helix length (file [TT]len-ahx.xvg[tt]). The total length",
 118     "of the",
 119     "helix in nm. This is simply the average rise (see above) times the",
 120     "number of helical residues (see below).[BR]",
 121     "[BB]5.[bb] Helix dipole, backbone only (file [TT]dip-ahx.xvg[tt]).[BR]",
 122     "[BB]6.[bb] RMS deviation from ideal helix, calculated for the C[GRK]alpha[grk]",
 123     "atoms only (file [TT]rms-ahx.xvg[tt]).[BR]",
 124     "[BB]7.[bb] Average C[GRK]alpha[grk] - C[GRK]alpha[grk] dihedral angle (file [TT]phi-ahx.xvg[tt]).[BR]",
 125     "[BB]8.[bb] Average [GRK]phi[grk] and [GRK]psi[grk] angles (file [TT]phipsi.xvg[tt]).[BR]",
 126     "[BB]9.[bb] Ellipticity at 222 nm according to Hirst and Brooks.",
 127     "[PAR]"
 128   };
 129   static const char *ppp[efhNR+2] = {
 130     NULL, "RAD", "TWIST", "RISE", "LEN", "NHX", "DIP", "RMS", "CPHI",
 131     "RMSA", "PHI", "PSI", "HB3", "HB4", "HB5", "CD222", NULL
 132   };
 133   static gmx_bool bCheck=FALSE,bFit=TRUE,bDBG=FALSE,bEV=FALSE;
 134   static int  rStart=0,rEnd=0,r0=1;
 135   t_pargs pa [] = {
 136     { "-r0", FALSE, etINT, {&r0},
 137       "The first residue number in the sequence" },
 138     { "-q",  FALSE, etBOOL,{&bCheck},
 139       "Check at every step which part of the sequence is helical" },
 140     { "-F",  FALSE, etBOOL,{&bFit},
 141       "Toggle fit to a perfect helix" },
 142     { "-db", FALSE, etBOOL,{&bDBG},
 143       "Print debug info" },
 144     { "-prop", FALSE, etENUM, {ppp},
 145       "Select property to weight eigenvectors with. WARNING experimental stuff" },
 146     { "-ev", FALSE, etBOOL,{&bEV},
 147       "Write a new 'trajectory' file for ED" },
 148     { "-ahxstart", FALSE, etINT, {&rStart},
 149       "First residue in helix" },
 150     { "-ahxend", FALSE, etINT, {&rEnd},
 151       "Last residue in helix" }
 152   };
 153
 154   typedef struct {
 155     FILE *fp,*fp2;
 156     gmx_bool bfp2;
 157     const char *filenm;
 158     const char *title;
 159     const char *xaxis;
 160     const char *yaxis;
 161     real val;
 162   } t_xvgrfile;
 163
 164   t_xvgrfile xf[efhNR] = {
 165     { NULL, NULL, TRUE,  "radius",  "Helix radius",               NULL, "r (nm)" , 0.0 },
 166     { NULL, NULL, TRUE,  "twist",   "Twist per residue",          NULL, "Angle (deg)", 0.0 },
 167     { NULL, NULL, TRUE,  "rise",    "Rise per residue",           NULL, "Rise (nm)", 0.0 },
 168     { NULL, NULL, FALSE, "len-ahx", "Length of the Helix",        NULL, "Length (nm)", 0.0 },
 169     { NULL, NULL, FALSE, "dip-ahx", "Helix Backbone Dipole",      NULL, "rq (nm e)", 0.0 },
 170     { NULL, NULL, TRUE,  "rms-ahx", "RMS Deviation from Ideal Helix", NULL, "RMS (nm)", 0.0 },
 171     { NULL, NULL, FALSE, "rmsa-ahx","Average RMSD per Residue",   "Residue", "RMS (nm)", 0.0 },
 172     { NULL, NULL,FALSE,  "cd222",   "Ellipticity at 222 nm", NULL, "nm", 0.0 },
 173     { NULL, NULL, TRUE,  "pprms",   "RMS Distance from \\8a\\4-helix", NULL, "deg" , 0.0 },
 174     { NULL, NULL, TRUE,  "caphi",   "Average Ca-Ca Dihedral",     NULL, "\\8F\\4(deg)", 0.0 },
 175     { NULL, NULL, TRUE,  "phi",     "Average \\8F\\4 angles", NULL, "deg" , 0.0 },
 176     { NULL, NULL, TRUE,  "psi",     "Average \\8Y\\4 angles", NULL, "deg" , 0.0 },
 177     { NULL, NULL, TRUE,  "hb3",     "Average n-n+3 hbond length", NULL, "nm" , 0.0 },
 178     { NULL, NULL, TRUE,  "hb4",     "Average n-n+4 hbond length", NULL, "nm" , 0.0 },
 179     { NULL, NULL, TRUE,  "hb5",     "Average n-n+5 hbond length", NULL, "nm" , 0.0 },
 180     { NULL, NULL,FALSE,  "JCaHa",   "J-Coupling Values",        "Residue", "Hz" , 0.0 },
 181     { NULL, NULL,FALSE,  "helicity","Helicity per Residue",     "Residue", "% of time" , 0.0 }
 182   };
 183
 184   output_env_t oenv;
 185   FILE       *otrj;
 186   char       buf[54],prop[256];
 187   t_trxstatus *status;
 188   int        natoms,nre,nres;
 189   t_bb       *bb;
 190   int        i,j,ai,m,nall,nbb,nca,teller,nSel=0;
 191   atom_id    *bbindex,*caindex,*allindex;
 192   t_topology *top;
 193   int        ePBC;
 194   rvec       *x,*xref,*xav;
 195   real       t;
 196   real       rms,fac;
 197   matrix     box;
 198   gmx_rmpbc_t  gpbc=NULL;
 199   gmx_bool       bRange;
 200   t_filenm  fnm[] = {
 201     { efTPX, NULL,  NULL,   ffREAD  },
 202     { efNDX, NULL,  NULL,   ffREAD  },
 203     { efTRX, "-f",  NULL,   ffREAD  },
 204     { efG87, "-to", NULL,   ffOPTWR },
 205     { efSTO, "-cz", "zconf",ffWRITE },
 206     { efSTO, "-co", "waver",ffWRITE }
 207   };
 208 #define NFILE asize(fnm)
 209
 210   CopyRight(stderr,argv[0]);
 211   parse_common_args(&argc,argv,PCA_CAN_VIEW | PCA_CAN_TIME | PCA_BE_NICE,
 212                     NFILE,fnm,asize(pa),pa,asize(desc),desc,0,NULL,&oenv);
 213
 214   bRange=(opt2parg_bSet("-ahxstart",asize(pa),pa) &&
 215           opt2parg_bSet("-ahxend",asize(pa),pa));
 216
 217   top=read_top(ftp2fn(efTPX,NFILE,fnm),&ePBC);
 218
 219   natoms=read_first_x(oenv,&status,opt2fn("-f",NFILE,fnm),&t,&x,box);
 220
 221   if (opt2bSet("-to",NFILE,fnm)) {
 222     otrj=opt2FILE("-to",NFILE,fnm,"w");
 223     strcpy(prop,ppp[0]);
 224     fprintf(otrj,"%s Weighted Trajectory: %d atoms, NO box\n",prop,natoms);
 225   }
 226   else
 227     otrj=NULL;
 228
 229   if (natoms != top->atoms.nr)
 230     gmx_fatal(FARGS,"Sorry can only run when the number of atoms in the run input file (%d) is equal to the number in the trajectory (%d)",
 231             top->atoms.nr,natoms);
 232
 233   bb=mkbbind(ftp2fn(efNDX,NFILE,fnm),&nres,&nbb,r0,&nall,&allindex,
 234              top->atoms.atomname,top->atoms.atom,top->atoms.resinfo);
 235   snew(bbindex,natoms);
 236   snew(caindex,nres);
 237
 238   fprintf(stderr,"nall=%d\n",nall);
 239
 240   /* Open output files, default x-axis is time */
 241   for(i=0; (i<efhNR); i++) {
 242     sprintf(buf,"%s.xvg",xf[i].filenm);
 243     remove(buf);
 244     xf[i].fp=xvgropen(buf,xf[i].title,
 245                       xf[i].xaxis ? xf[i].xaxis : "Time (ps)",
 246                       xf[i].yaxis,oenv);
 247     if (xf[i].bfp2) {
 248       sprintf(buf,"%s.out",xf[i].filenm);
 249       remove(buf);
 250       xf[i].fp2=ffopen(buf,"w");
 251     }
 252   }
 253
 254   /* Read reference frame from tpx file to compute helix length */
 255   snew(xref,top->atoms.nr);
 256   read_tpx(ftp2fn(efTPX,NFILE,fnm),
 257            NULL,NULL,&natoms,xref,NULL,NULL,NULL);
 258   calc_hxprops(nres,bb,xref,box);
 259   do_start_end(nres,bb,xref,&nbb,bbindex,&nca,caindex,bRange,rStart,rEnd);
 260   sfree(xref);
 261   if (bDBG) {
 262     fprintf(stderr,"nca=%d, nbb=%d\n",nca,nbb);
 263     pr_bb(stdout,nres,bb);
 264   }
 265
 266   gpbc = gmx_rmpbc_init(&top->idef,ePBC,natoms,box);
 267
 268   snew(xav,natoms);
 269   teller=0;
 270   do {
 271     if ((teller++ % 10) == 0)
 272       fprintf(stderr,"\rt=%.2f",t);
 273     gmx_rmpbc(gpbc,natoms,box,x);
 274
 275
 276     calc_hxprops(nres,bb,x,box);
 277     if (bCheck)
 278       do_start_end(nres,bb,x,&nbb,bbindex,&nca,caindex,FALSE,0,0);
 279
 280     if (nca >= 5) {
 281       rms=fit_ahx(nres,bb,natoms,nall,allindex,x,nca,caindex,box,bFit);
 282
 283       if (teller == 1) {
 284         write_sto_conf(opt2fn("-cz",NFILE,fnm),"Helix fitted to Z-Axis",
 285                        &(top->atoms),x,NULL,ePBC,box);
 286       }
 287
 288       xf[efhRAD].val   = radius(xf[efhRAD].fp2,nca,caindex,x);
 289       xf[efhTWIST].val = twist(xf[efhTWIST].fp2,nca,caindex,x);
 290       xf[efhRISE].val  = rise(nca,caindex,x);
 291       xf[efhLEN].val   = ahx_len(nca,caindex,x,box);
 292       xf[efhCD222].val = ellipticity(nres,bb);
 293       xf[efhDIP].val   = dip(nbb,bbindex,x,top->atoms.atom);
 294       xf[efhRMS].val   = rms;
 295       xf[efhCPHI].val  = ca_phi(nca,caindex,x,box);
 296       xf[efhPPRMS].val = pprms(xf[efhPPRMS].fp2,nres,bb);
 297
 298       for(j=0; (j<=efhCPHI); j++)
 299         fprintf(xf[j].fp,   "%10g  %10g\n",t,xf[j].val);
 300
 301       av_phipsi(xf[efhPHI].fp,xf[efhPSI].fp,xf[efhPHI].fp2,xf[efhPSI].fp2,
 302                 t,nres,bb);
 303       av_hblen(xf[efhHB3].fp,xf[efhHB3].fp2,
 304                xf[efhHB4].fp,xf[efhHB4].fp2,
 305                xf[efhHB5].fp,xf[efhHB5].fp2,
 306                t,nres,bb);
 307
 308       if (otrj)
 309         dump_otrj(otrj,nall,allindex,x,xf[nSel].val,xav);
 310     }
 311   } while (read_next_x(oenv,status,&t,natoms,x,box));
 312   fprintf(stderr,"\n");
 313
 314   gmx_rmpbc_done(gpbc);
 315
 316   close_trj(status);
 317
 318   if (otrj) {
 319     ffclose(otrj);
 320     fac=1.0/teller;
 321     for(i=0; (i<nall); i++) {
 322       ai=allindex[i];
 323       for(m=0; (m<DIM); m++)
 324         xav[ai][m]*=fac;
 325     }
 326     write_sto_conf_indexed(opt2fn("-co",NFILE,fnm),
 327                            "Weighted and Averaged conformation",
 328                            &(top->atoms),xav,NULL,ePBC,box,nall,allindex);
 329   }
 330
 331   for(i=0; (i<nres); i++) {
 332     if (bb[i].nrms > 0) {
 333       fprintf(xf[efhRMSA].fp,"%10d  %10g\n",r0+i,bb[i].rmsa/bb[i].nrms);
 334     }
 335     fprintf(xf[efhAHX].fp,"%10d  %10g\n",r0+i,(bb[i].nhx*100.0)/(real )teller);
 336     fprintf(xf[efhJCA].fp,"%10d  %10g\n",
 337             r0+i,140.3+(bb[i].jcaha/(double)teller));
 338   }
 339
 340   for(i=0; (i<efhNR); i++) {
 341     ffclose(xf[i].fp);
 342     if (xf[i].bfp2)
 343       ffclose(xf[i].fp2);
 344     do_view(oenv,xf[i].filenm,"-nxy");
 345   }
 346
 347   thanx(stderr);
 348
 349   return 0;
 350 }
 351