Merge "added support for graphs not starting at 0" into release-4-6
[gromacs/AngularHB.git] / man / man1 / g_covar.1
blob4d90b2bd82c4bbcfe66519e224f2fbb870d90bb6
1 .TH g_covar 1 "Mon 4 Apr 2011" "" "GROMACS suite, VERSION 4.5.4-dev-20110404-bc5695c"
2 .SH NAME
3 g_covar - calculates and diagonalizes the covariance matrix
5 .B VERSION 4.5.4-dev-20110404-bc5695c
6 .SH SYNOPSIS
7 \f3g_covar\fP
8 .BI "\-f" " traj.xtc "
9 .BI "\-s" " topol.tpr "
10 .BI "\-n" " index.ndx "
11 .BI "\-o" " eigenval.xvg "
12 .BI "\-v" " eigenvec.trr "
13 .BI "\-av" " average.pdb "
14 .BI "\-l" " covar.log "
15 .BI "\-ascii" " covar.dat "
16 .BI "\-xpm" " covar.xpm "
17 .BI "\-xpma" " covara.xpm "
18 .BI "\-[no]h" ""
19 .BI "\-[no]version" ""
20 .BI "\-nice" " int "
21 .BI "\-b" " time "
22 .BI "\-e" " time "
23 .BI "\-dt" " time "
24 .BI "\-tu" " enum "
25 .BI "\-xvg" " enum "
26 .BI "\-[no]fit" ""
27 .BI "\-[no]ref" ""
28 .BI "\-[no]mwa" ""
29 .BI "\-last" " int "
30 .BI "\-[no]pbc" ""
31 .SH DESCRIPTION
32 \&\fB g_covar\fR calculates and diagonalizes the (mass\-weighted)
33 \&covariance matrix.
34 \&All structures are fitted to the structure in the structure file.
35 \&When this is not a run input file periodicity will not be taken into
36 \&account. When the fit and analysis groups are identical and the analysis
37 \&is non mass\-weighted, the fit will also be non mass\-weighted.
41 \&The eigenvectors are written to a trajectory file (\fB \-v\fR).
42 \&When the same atoms are used for the fit and the covariance analysis,
43 \&the reference structure for the fit is written first with t=\-1.
44 \&The average (or reference when \fB \-ref\fR is used) structure is
45 \&written with t=0, the eigenvectors
46 \&are written as frames with the eigenvector number as timestamp.
50 \&The eigenvectors can be analyzed with \fB g_anaeig\fR.
54 \&Option \fB \-ascii\fR writes the whole covariance matrix to
55 \&an ASCII file. The order of the elements is: x1x1, x1y1, x1z1, x1x2, ...
59 \&Option \fB \-xpm\fR writes the whole covariance matrix to an \fB .xpm\fR file.
63 \&Option \fB \-xpma\fR writes the atomic covariance matrix to an \fB .xpm\fR file,
64 \&i.e. for each atom pair the sum of the xx, yy and zz covariances is
65 \&written.
69 \&Note that the diagonalization of a matrix requires memory and time
70 \&that will increase at least as fast as than the square of the number
71 \&of atoms involved. It is easy to run out of memory, in which
72 \&case this tool will probably exit with a 'Segmentation fault'. You
73 \&should consider carefully whether a reduced set of atoms will meet
74 \&your needs for lower costs.
75 .SH FILES
76 .BI "\-f" " traj.xtc" 
77 .B Input
78  Trajectory: xtc trr trj gro g96 pdb cpt 
80 .BI "\-s" " topol.tpr" 
81 .B Input
82  Structure+mass(db): tpr tpb tpa gro g96 pdb 
84 .BI "\-n" " index.ndx" 
85 .B Input, Opt.
86  Index file 
88 .BI "\-o" " eigenval.xvg" 
89 .B Output
90  xvgr/xmgr file 
92 .BI "\-v" " eigenvec.trr" 
93 .B Output
94  Full precision trajectory: trr trj cpt 
96 .BI "\-av" " average.pdb" 
97 .B Output
98  Structure file: gro g96 pdb etc. 
100 .BI "\-l" " covar.log" 
101 .B Output
102  Log file 
104 .BI "\-ascii" " covar.dat" 
105 .B Output, Opt.
106  Generic data file 
108 .BI "\-xpm" " covar.xpm" 
109 .B Output, Opt.
110  X PixMap compatible matrix file 
112 .BI "\-xpma" " covara.xpm" 
113 .B Output, Opt.
114  X PixMap compatible matrix file 
116 .SH OTHER OPTIONS
117 .BI "\-[no]h"  "no    "
118  Print help info and quit
120 .BI "\-[no]version"  "no    "
121  Print version info and quit
123 .BI "\-nice"  " int" " 19" 
124  Set the nicelevel
126 .BI "\-b"  " time" " 0     " 
127  First frame (ps) to read from trajectory
129 .BI "\-e"  " time" " 0     " 
130  Last frame (ps) to read from trajectory
132 .BI "\-dt"  " time" " 0     " 
133  Only use frame when t MOD dt = first time (ps)
135 .BI "\-tu"  " enum" " ps" 
136  Time unit: \fB fs\fR, \fB ps\fR, \fB ns\fR, \fB us\fR, \fB ms\fR or \fB s\fR
138 .BI "\-xvg"  " enum" " xmgrace" 
139  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
141 .BI "\-[no]fit"  "yes   "
142  Fit to a reference structure
144 .BI "\-[no]ref"  "no    "
145  Use the deviation from the conformation in the structure file instead of from the average
147 .BI "\-[no]mwa"  "no    "
148  Mass\-weighted covariance analysis
150 .BI "\-last"  " int" " \-1" 
151  Last eigenvector to write away (\-1 is till the last)
153 .BI "\-[no]pbc"  "yes   "
154  Apply corrections for periodic boundary conditions
156 .SH SEE ALSO
157 .BR gromacs(7)
159 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.