Merge branch 'release-4-5-patches' of git@git.gromacs.org:gromacs into release-4...
[gromacs/rigid-bodies.git] / man / man1 / g_select.1
blobed8ce52f51e23f6e794e19770b9d23f6639591b5
1 .TH g_select 1 "Thu 26 Aug 2010" "" "GROMACS suite, VERSION 4.5"
2 .SH NAME
3 g_select - selects groups of atoms based on flexible textual selections
5 .B VERSION 4.5
6 .SH SYNOPSIS
7 \f3g_select\fP
8 .BI "\-f" " traj.xtc "
9 .BI "\-s" " topol.tpr "
10 .BI "\-sf" " selection.dat "
11 .BI "\-n" " index.ndx "
12 .BI "\-os" " size.xvg "
13 .BI "\-oc" " cfrac.xvg "
14 .BI "\-oi" " index.dat "
15 .BI "\-om" " mask.dat "
16 .BI "\-on" " index.ndx "
17 .BI "\-[no]h" ""
18 .BI "\-[no]version" ""
19 .BI "\-nice" " int "
20 .BI "\-b" " time "
21 .BI "\-e" " time "
22 .BI "\-dt" " time "
23 .BI "\-xvg" " enum "
24 .BI "\-[no]rmpbc" ""
25 .BI "\-[no]pbc" ""
26 .BI "\-select" " string "
27 .BI "\-selrpos" " enum "
28 .BI "\-seltype" " enum "
29 .BI "\-[no]dump" ""
30 .BI "\-[no]norm" ""
31 .BI "\-[no]cfnorm" ""
32 .BI "\-resnr" " enum "
33 .SH DESCRIPTION
34 \&g_select writes out basic data about dynamic selections.
35 \&It can be used for some simple analyses, or the output can
36 \&be combined with output from other programs and/or external
37 \&analysis programs to calculate more complex things.
38 \&Any combination of the output options is possible, but note
39 \&that \fB \-om\fR only operates on the first selection.
42 \&With \fB \-os\fR, calculates the number of positions in each
43 \&selection for each frame. With \fB \-norm\fR, the output is
44 \&between 0 and 1 and describes the fraction from the maximum
45 \&number of positions (e.g., for selection 'resname RA and x  5'
46 \&the maximum number of positions is the number of atoms in
47 \&RA residues). With \fB \-cfnorm\fR, the output is divided
48 \&by the fraction covered by the selection.
49 \&\fB \-norm\fR and \fB \-cfnorm\fR can be specified independently
50 \&of one another.
53 \&With \fB \-oc\fR, the fraction covered by each selection is
54 \&written out as a function of time.
57 \&With \fB \-oi\fR, the selected atoms/residues/molecules are
58 \&written out as a function of time. In the output, the first
59 \&column contains the frame time, the second contains the number
60 \&of positions, followed by the atom/residue/molecule numbers.
61 \&If more than one selection is specified, the size of the second
62 \&group immediately follows the last number of the first group
63 \&and so on. With \fB \-dump\fR, the frame time and the number
64 \&of positions is omitted from the output. In this case, only one
65 \&selection can be given.
68 \&With \fB \-on\fR, the selected atoms are written as a index file
69 \&compatible with make_ndx and the analyzing tools. Each selection
70 \&is written as a selection group and for dynamic selections a
71 \&group is written for each frame.
74 \&For residue numbers, the output of \fB \-oi\fR can be controlled
75 \&with \fB \-resnr\fR: \fB number\fR (default) prints the residue
76 \&numbers as they appear in the input file, while \fB index\fR prints
77 \&unique numbers assigned to the residues in the order they appear
78 \&in the input file, starting with 1. The former is more intuitive,
79 \&but if the input contains multiple residues with the same number,
80 \&the output can be less useful.
83 \&With \fB \-om\fR, a mask is printed for the first selection
84 \&as a function of time. Each line in the output corresponds to
85 \&one frame, and contains either 0/1 for each atom/residue/molecule
86 \&possibly selected. 1 stands for the atom/residue/molecule being
87 \&selected for the current frame, 0 for not selected.
88 \&With \fB \-dump\fR, the frame time is omitted from the output.
89 .SH FILES
90 .BI "\-f" " traj.xtc" 
91 .B Input, Opt.
92  Trajectory: xtc trr trj gro g96 pdb cpt 
94 .BI "\-s" " topol.tpr" 
95 .B Input, Opt.
96  Structure+mass(db): tpr tpb tpa gro g96 pdb 
98 .BI "\-sf" " selection.dat" 
99 .B Input, Opt.
100  Generic data file 
102 .BI "\-n" " index.ndx" 
103 .B Input, Opt.
104  Index file 
106 .BI "\-os" " size.xvg" 
107 .B Output, Opt.
108  xvgr/xmgr file 
110 .BI "\-oc" " cfrac.xvg" 
111 .B Output, Opt.
112  xvgr/xmgr file 
114 .BI "\-oi" " index.dat" 
115 .B Output, Opt.
116  Generic data file 
118 .BI "\-om" " mask.dat" 
119 .B Output, Opt.
120  Generic data file 
122 .BI "\-on" " index.ndx" 
123 .B Output, Opt.
124  Index file 
126 .SH OTHER OPTIONS
127 .BI "\-[no]h"  "no    "
128  Print help info and quit
130 .BI "\-[no]version"  "no    "
131  Print version info and quit
133 .BI "\-nice"  " int" " 19" 
134  Set the nicelevel
136 .BI "\-b"  " time" " 0     " 
137  First frame (ps) to read from trajectory
139 .BI "\-e"  " time" " 0     " 
140  Last frame (ps) to read from trajectory
142 .BI "\-dt"  " time" " 0     " 
143  Only use frame when t MOD dt = first time (ps)
145 .BI "\-xvg"  " enum" " xmgrace" 
146  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
148 .BI "\-[no]rmpbc"  "yes   "
149  Make molecules whole for each frame
151 .BI "\-[no]pbc"  "yes   "
152  Use periodic boundary conditions for distance calculation
154 .BI "\-select"  " string" " " 
155  Selection string (use 'help' for help)
157 .BI "\-selrpos"  " enum" " atom" 
158  Selection reference position: \fB atom\fR, \fB res_com\fR, \fB res_cog\fR, \fB mol_com\fR, \fB mol_cog\fR, \fB whole_res_com\fR, \fB whole_res_cog\fR, \fB whole_mol_com\fR, \fB whole_mol_cog\fR, \fB part_res_com\fR, \fB part_res_cog\fR, \fB part_mol_com\fR, \fB part_mol_cog\fR, \fB dyn_res_com\fR, \fB dyn_res_cog\fR, \fB dyn_mol_com\fR or \fB dyn_mol_cog\fR
160 .BI "\-seltype"  " enum" " atom" 
161  Default analysis positions: \fB atom\fR, \fB res_com\fR, \fB res_cog\fR, \fB mol_com\fR, \fB mol_cog\fR, \fB whole_res_com\fR, \fB whole_res_cog\fR, \fB whole_mol_com\fR, \fB whole_mol_cog\fR, \fB part_res_com\fR, \fB part_res_cog\fR, \fB part_mol_com\fR, \fB part_mol_cog\fR, \fB dyn_res_com\fR, \fB dyn_res_cog\fR, \fB dyn_mol_com\fR or \fB dyn_mol_cog\fR
163 .BI "\-[no]dump"  "no    "
164  Do not print the frame time (\-om, \-oi) or the index size (\-oi)
166 .BI "\-[no]norm"  "no    "
167  Normalize by total number of positions with \-os
169 .BI "\-[no]cfnorm"  "no    "
170  Normalize by covered fraction with \-os
172 .BI "\-resnr"  " enum" " number" 
173  Residue number output type: \fB number\fR or \fB index\fR
175 .SH SEE ALSO
176 .BR gromacs(7)
178 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.