minor fixes in ditribution files
[gromacs/qmmm-gamess-us.git] / man / man1 / g_densmap.1
blob08a2e2ee2ef0a2e57164655d16b2d91d5b65dc91
1 .TH g_densmap 1 "Thu 16 Oct 2008"
2 .SH NAME
3 g_densmap - calculates 2D planar or axial-radial density maps
5 .B VERSION 4.0
6 .SH SYNOPSIS
7 \f3g_densmap\fP
8 .BI "-f" " traj.xtc "
9 .BI "-s" " topol.tpr "
10 .BI "-n" " index.ndx "
11 .BI "-o" " densmap.xpm "
12 .BI "-[no]h" ""
13 .BI "-nice" " int "
14 .BI "-b" " time "
15 .BI "-e" " time "
16 .BI "-dt" " time "
17 .BI "-[no]w" ""
18 .BI "-bin" " real "
19 .BI "-aver" " enum "
20 .BI "-xmin" " real "
21 .BI "-xmax" " real "
22 .BI "-n1" " int "
23 .BI "-n2" " int "
24 .BI "-amax" " real "
25 .BI "-rmax" " real "
26 .BI "-[no]mirror" ""
27 .BI "-unit" " enum "
28 .BI "-dmin" " real "
29 .BI "-dmax" " real "
30 .SH DESCRIPTION
31 g_densmap computes 2D number-density maps.
32 It can make planar and axial-radial density maps.
33 The output 
34 .B .xpm
35 file can be visualized with for instance xv
36 and can be converted to postscript with xpm2ps.
40 The default analysis is a 2-D number-density map for a selected
41 group of atoms in the x-y plane.
42 The averaging direction can be changed with the option 
43 .B -aver
45 When 
46 .B -xmin
47 and/or 
48 .B -xmax
49 are set only atoms that are
50 within the limit(s) in the averaging direction are taken into account.
51 The grid spacing is set with the option 
52 .B -bin
54 When 
55 .B -n1
56 or 
57 .B -n2
58 is non-zero, the grid
59 size is set by this option.
60 Box size fluctuations are properly taken into account.
64 When options 
65 .B -amax
66 and 
67 .B -rmax
68 are set, an axial-radial
69 number-density map is made. Three groups should be supplied, the centers
70 of mass of the first two groups define the axis, the third defines the
71 analysis group. The axial direction goes from -amax to +amax, where
72 the center is defined as the midpoint between the centers of mass and
73 the positive direction goes from the first to the second center of mass.
74 The radial direction goes from 0 to rmax or from -rmax to +rmax
75 when the 
76 .B -mirror
77 option has been set.
81 The normalization of the output is set with the 
82 .B -unit
83 option.
84 The default produces a true number density. Unit 
85 .B nm-2
86 leaves out
87 the normalization for the averaging or the angular direction.
88 Option 
89 .B count
90 produces the count for each grid cell.
91 When you do not want the scale in the output to go
92 from zero to the maximum density, you can set the maximum
93 with the option 
94 .B -dmax
96 .SH FILES
97 .BI "-f" " traj.xtc" 
98 .B Input
99  Trajectory: xtc trr trj gro g96 pdb cpt 
101 .BI "-s" " topol.tpr" 
102 .B Input, Opt.
103  Structure+mass(db): tpr tpb tpa gro g96 pdb 
105 .BI "-n" " index.ndx" 
106 .B Input, Opt.
107  Index file 
109 .BI "-o" " densmap.xpm" 
110 .B Output
111  X PixMap compatible matrix file 
113 .SH OTHER OPTIONS
114 .BI "-[no]h"  "no    "
115  Print help info and quit
117 .BI "-nice"  " int" " 19" 
118  Set the nicelevel
120 .BI "-b"  " time" " 0     " 
121  First frame (ps) to read from trajectory
123 .BI "-e"  " time" " 0     " 
124  Last frame (ps) to read from trajectory
126 .BI "-dt"  " time" " 0     " 
127  Only use frame when t MOD dt = first time (ps)
129 .BI "-[no]w"  "no    "
130  View output xvg, xpm, eps and pdb files
132 .BI "-bin"  " real" " 0.02  " 
133  Grid size (nm)
135 .BI "-aver"  " enum" " z" 
136  The direction to average over: 
137 .B z
139 .B y
140 or 
141 .B x
144 .BI "-xmin"  " real" " -1    " 
145  Minimum coordinate for averaging
147 .BI "-xmax"  " real" " -1    " 
148  Maximum coordinate for averaging
150 .BI "-n1"  " int" " 0" 
151  Number of grid cells in the first direction
153 .BI "-n2"  " int" " 0" 
154  Number of grid cells in the second direction
156 .BI "-amax"  " real" " 0     " 
157  Maximum axial distance from the center
159 .BI "-rmax"  " real" " 0     " 
160  Maximum radial distance
162 .BI "-[no]mirror"  "no    "
163  Add the mirror image below the axial axis
165 .BI "-unit"  " enum" " nm-3" 
166  Unit for the output: 
167 .B nm-3
169 .B nm-2
170 or 
171 .B count
174 .BI "-dmin"  " real" " 0     " 
175  Minimum density in output
177 .BI "-dmax"  " real" " 0     " 
178  Maximum density in output (0 means calculate it)