man/man1/g_spatial.1

   1 .TH g_spatial 1 "Thu 16 Oct 2008"
   2 .SH NAME
   3 g_spatial - calculates the spatial distribution function (more control than g_sdf)
   4
   5 .B VERSION 4.0
   6 .SH SYNOPSIS
   7 \f3g_spatial\fP
   8 .BI "-f" " traj.xtc "
   9 .BI "-s" " topol.tpr "
  10 .BI "-n" " index.ndx "
  11 .BI "-dm" " rmsd.xpm "
  12 .BI "-o" " rmsd-clust.xpm "
  13 .BI "-g" " cluster.log "
  14 .BI "-dist" " rmsd-dist.xvg "
  15 .BI "-ev" " rmsd-eig.xvg "
  16 .BI "-sz" " clust-size.xvg "
  17 .BI "-tr" " clust-trans.xpm "
  18 .BI "-ntr" " clust-trans.xvg "
  19 .BI "-clid" " clust-id.xvg "
  20 .BI "-cl" " clusters.pdb "
  21 .BI "-[no]h" ""
  22 .BI "-nice" " int "
  23 .BI "-b" " time "
  24 .BI "-e" " time "
  25 .BI "-dt" " time "
  26 .BI "-tu" " enum "
  27 .BI "-[no]w" ""
  28 .BI "-[no]xvgr" ""
  29 .BI "-[no]dista" ""
  30 .BI "-nlevels" " int "
  31 .BI "-cutoff" " real "
  32 .BI "-[no]fit" ""
  33 .BI "-max" " real "
  34 .BI "-skip" " int "
  35 .BI "-[no]av" ""
  36 .BI "-wcl" " int "
  37 .BI "-nst" " int "
  38 .BI "-rmsmin" " real "
  39 .BI "-method" " enum "
  40 .BI "-minstruct" " int "
  41 .BI "-[no]binary" ""
  42 .BI "-M" " int "
  43 .BI "-P" " int "
  44 .BI "-seed" " int "
  45 .BI "-niter" " int "
  46 .BI "-kT" " real "
  47 .SH DESCRIPTION
  48 g_cluster can cluster structures with several different methods.
  49 Distances between structures can be determined from a trajectory
  50 or read from an XPM matrix file with the
  51 .B -dm
  52 option.
  53 RMS deviation after fitting or RMS deviation of atom-pair distances
  54 can be used to define the distance between structures.
  55
  56
  57 single linkage: add a structure to a cluster when its distance to any
  58 element of the cluster is less than
  59 .B cutoff
  60 .
  61
  62
  63 Jarvis Patrick: add a structure to a cluster when this structure
  64 and a structure in the cluster have each other as neighbors and
  65 they have a least
  66 .B P
  67 neighbors in common. The neighbors
  68 of a structure are the M closest structures or all structures within
  69
  70 .B cutoff
  71 .
  72
  73
  74 Monte Carlo: reorder the RMSD matrix using Monte Carlo.
  75
  76
  77 diagonalization: diagonalize the RMSD matrix.
  78
  79 gromos: use algorithm as described in Daura
  80 .I et al.
  81
  82 (
  83 .I Angew. Chem. Int. Ed.
  84
  85 .B 1999
  86 ,
  87 .I 38
  88 , pp 236-240).
  89 Count number of neighbors using cut-off, take structure with
  90 largest number of neighbors with all its neighbors as cluster
  91 and eleminate it from the pool of clusters. Repeat for remaining
  92 structures in pool.
  93
  94
  95 When the clustering algorithm assigns each structure to exactly one
  96 cluster (single linkage, Jarvis Patrick and gromos) and a trajectory
  97 file is supplied, the structure with
  98 the smallest average distance to the others or the average structure
  99 or all structures for each cluster will be written to a trajectory
 100 file. When writing all structures, separate numbered files are made
 101 for each cluster.
 102
 103 Two output files are always written:
 104
 105
 106 .B -o
 107 writes the RMSD values in the upper left half of the matrix
 108 and a graphical depiction of the clusters in the lower right half
 109 When
 110 .B -minstruct
 111 = 1 the graphical depiction is black
 112 when two structures are in the same cluster.
 113 When
 114 .B -minstruct
 115  1 different colors will be used for each
 116 cluster.
 117
 118
 119 .B -g
 120 writes information on the options used and a detailed list
 121 of all clusters and their members.
 122
 123
 124 Additionally, a number of optional output files can be written:
 125
 126
 127 .B -dist
 128 writes the RMSD distribution.
 129
 130
 131 .B -ev
 132 writes the eigenvectors of the RMSD matrix
 133 diagonalization.
 134
 135
 136 .B -sz
 137 writes the cluster sizes.
 138
 139
 140 .B -tr
 141 writes a matrix of the number transitions between
 142 cluster pairs.
 143
 144
 145 .B -ntr
 146 writes the total number of transitions to or from
 147 each cluster.
 148
 149
 150 .B -clid
 151 writes the cluster number as a function of time.
 152
 153
 154 .B -cl
 155 writes average (with option
 156 .B -av
 157 ) or central
 158 structure of each cluster or writes numbered files with cluster members
 159 for a selected set of clusters (with option
 160 .B -wcl
 161 , depends on
 162
 163 .B -nst
 164 and
 165 .B -rmsmin
 166 ).
 167
 168 .SH FILES
 169 .BI "-f" " traj.xtc"
 170 .B Input, Opt.
 171  Trajectory: xtc trr trj gro g96 pdb cpt
 172
 173 .BI "-s" " topol.tpr"
 174 .B Input, Opt.
 175  Structure+mass(db): tpr tpb tpa gro g96 pdb
 176
 177 .BI "-n" " index.ndx"
 178 .B Input, Opt.
 179  Index file
 180
 181 .BI "-dm" " rmsd.xpm"
 182 .B Input, Opt.
 183  X PixMap compatible matrix file
 184
 185 .BI "-o" " rmsd-clust.xpm"
 186 .B Output
 187  X PixMap compatible matrix file
 188
 189 .BI "-g" " cluster.log"
 190 .B Output
 191  Log file
 192
 193 .BI "-dist" " rmsd-dist.xvg"
 194 .B Output, Opt.
 195  xvgr/xmgr file
 196
 197 .BI "-ev" " rmsd-eig.xvg"
 198 .B Output, Opt.
 199  xvgr/xmgr file
 200
 201 .BI "-sz" " clust-size.xvg"
 202 .B Output, Opt.
 203  xvgr/xmgr file
 204
 205 .BI "-tr" " clust-trans.xpm"
 206 .B Output, Opt.
 207  X PixMap compatible matrix file
 208
 209 .BI "-ntr" " clust-trans.xvg"
 210 .B Output, Opt.
 211  xvgr/xmgr file
 212
 213 .BI "-clid" " clust-id.xvg"
 214 .B Output, Opt.
 215  xvgr/xmgr file
 216
 217 .BI "-cl" " clusters.pdb"
 218 .B Output, Opt.
 219  Trajectory: xtc trr trj gro g96 pdb cpt
 220
 221 .SH OTHER OPTIONS
 222 .BI "-[no]h"  "no    "
 223  Print help info and quit
 224
 225 .BI "-nice"  " int" " 19"
 226  Set the nicelevel
 227
 228 .BI "-b"  " time" " 0     "
 229  First frame (ps) to read from trajectory
 230
 231 .BI "-e"  " time" " 0     "
 232  Last frame (ps) to read from trajectory
 233
 234 .BI "-dt"  " time" " 0     "
 235  Only use frame when t MOD dt = first time (ps)
 236
 237 .BI "-tu"  " enum" " ps"
 238  Time unit:
 239 .B ps
 240 ,
 241 .B fs
 242 ,
 243 .B ns
 244 ,
 245 .B us
 246 ,
 247 .B ms
 248 or
 249 .B s
 250
 251
 252 .BI "-[no]w"  "no    "
 253  View output xvg, xpm, eps and pdb files
 254
 255 .BI "-[no]xvgr"  "yes   "
 256  Add specific codes (legends etc.) in the output xvg files for the xmgrace program
 257
 258 .BI "-[no]dista"  "no    "
 259  Use RMSD of distances instead of RMS deviation
 260
 261 .BI "-nlevels"  " int" " 40"
 262  Discretize RMSD matrix in  levels
 263
 264 .BI "-cutoff"  " real" " 0.1   "
 265  RMSD cut-off (nm) for two structures to be neighbor
 266
 267 .BI "-[no]fit"  "yes   "
 268  Use least squares fitting before RMSD calculation
 269
 270 .BI "-max"  " real" " -1    "
 271  Maximum level in RMSD matrix
 272
 273 .BI "-skip"  " int" " 1"
 274  Only analyze every nr-th frame
 275
 276 .BI "-[no]av"  "no    "
 277  Write average iso middle structure for each cluster
 278
 279 .BI "-wcl"  " int" " 0"
 280  Write all structures for first  clusters to numbered files
 281
 282 .BI "-nst"  " int" " 1"
 283  Only write all structures if more than  per cluster
 284
 285 .BI "-rmsmin"  " real" " 0     "
 286  minimum rms difference with rest of cluster for writing structures
 287
 288 .BI "-method"  " enum" " linkage"
 289  Method for cluster determination:
 290 .B linkage
 291 ,
 292 .B jarvis-patrick
 293 ,
 294 .B monte-carlo
 295 ,
 296 .B diagonalization
 297 or
 298 .B gromos
 299
 300
 301 .BI "-minstruct"  " int" " 1"
 302  Minimum number of structures in cluster for coloring in the xpm file
 303
 304 .BI "-[no]binary"  "no    "
 305  Treat the RMSD matrix as consisting of 0 and 1, where the cut-off is given by -cutoff
 306
 307 .BI "-M"  " int" " 10"
 308  Number of nearest neighbors considered for Jarvis-Patrick algorithm, 0 is use cutoff
 309
 310 .BI "-P"  " int" " 3"
 311  Number of identical nearest neighbors required to form a cluster
 312
 313 .BI "-seed"  " int" " 1993"
 314  Random number seed for Monte Carlo clustering algorithm
 315
 316 .BI "-niter"  " int" " 10000"
 317  Number of iterations for MC
 318
 319 .BI "-kT"  " real" " 0.001 "
 320  Boltzmann weighting factor for Monte Carlo optimization (zero turns off uphill steps)
 321