1 | <refmeta> |
---|
2 | <refentrytitle>cavern</refentrytitle> |
---|
3 | <manvolnum>1</manvolnum> |
---|
4 | </refmeta> |
---|
5 | |
---|
6 | <refnamediv> |
---|
7 | <refname>cavern</refname> |
---|
8 | <refpurpose>process raw survey data |
---|
9 | </refpurpose> |
---|
10 | </refnamediv> |
---|
11 | |
---|
12 | <refsynopsisdiv> |
---|
13 | <cmdsynopsis> |
---|
14 | <command>cavern</command> |
---|
15 | <arg choice="opt">options</arg> |
---|
16 | <arg choice="req" rep="repeat">survex data file</arg> <!--FIXME--> |
---|
17 | </cmdsynopsis> |
---|
18 | </refsynopsisdiv> |
---|
19 | |
---|
20 | <refsect1><title>Description</title> |
---|
21 | |
---|
22 | <Para>Cavern is the &survexsuite; data processing engine.</Para> |
---|
23 | |
---|
24 | <Para>If multiple survey data files are listed on the command line, |
---|
25 | they are processed in order from left to right. Settings are reset to |
---|
26 | their defaults before processing each file. |
---|
27 | </Para> |
---|
28 | |
---|
29 | </refsect1> |
---|
30 | |
---|
31 | <refsect1><Title>Options</Title> |
---|
32 | |
---|
33 | <VariableList> |
---|
34 | <VarListEntry> |
---|
35 | <Term>-p, --percentage</Term> |
---|
36 | <ListItem> |
---|
37 | <Para>You can get cavern to display the percentage progress through the |
---|
38 | current file. As of &survexsuite; 0.90 this is disabled by default, but you |
---|
39 | can enable it if you want. Because the value given is for the |
---|
40 | <emphasis/current/ file, the values jump around for a multi-file survey |
---|
41 | project. Also note that displaying this information slows down processing |
---|
42 | a little. |
---|
43 | <!-- FIXME: on a slow machine you'd probably rather it ran faster, and on a |
---|
44 | fast machine you can't follow the change percentages.--> |
---|
45 | </Para> |
---|
46 | </ListItem> |
---|
47 | </VarListEntry> |
---|
48 | |
---|
49 | <VarListEntry> |
---|
50 | <Term>-o, --output=OUTPUT</Term> |
---|
51 | <ListItem> |
---|
52 | <Para>Sets location for output files. |
---|
53 | <!--FIXME elaborate this and other option descriptions.--> |
---|
54 | </Para> |
---|
55 | </ListItem> |
---|
56 | </VarListEntry> |
---|
57 | |
---|
58 | <VarListEntry> |
---|
59 | <Term>-q, --quiet</Term> |
---|
60 | <ListItem> |
---|
61 | <Para>Only show a brief summary (--quiet --quiet or -qq will display |
---|
62 | warnings and errors only). |
---|
63 | </Para> |
---|
64 | </ListItem> |
---|
65 | </VarListEntry> |
---|
66 | |
---|
67 | <VarListEntry> |
---|
68 | <Term>-s, --no-auxiliary-files</Term> |
---|
69 | <ListItem> |
---|
70 | <Para>do not create .err file. |
---|
71 | </Para> |
---|
72 | </ListItem> |
---|
73 | </VarListEntry> |
---|
74 | |
---|
75 | <VarListEntry> |
---|
76 | <Term>-w, --warnings-are-errors</Term> |
---|
77 | <ListItem> |
---|
78 | <Para>turn warnings into errors. |
---|
79 | </Para> |
---|
80 | </ListItem> |
---|
81 | </VarListEntry> |
---|
82 | |
---|
83 | <VarListEntry> |
---|
84 | <Term>--log</Term> |
---|
85 | <ListItem> |
---|
86 | <Para>Send screen output to a .log file. |
---|
87 | </Para> |
---|
88 | </ListItem> |
---|
89 | </VarListEntry> |
---|
90 | |
---|
91 | <VarListEntry> |
---|
92 | <Term>-v, --3d-version</Term> |
---|
93 | <ListItem> |
---|
94 | <Para>Specify the 3d file format version to output. By default the latest |
---|
95 | version is written, but you can override this to produce a 3d file which can |
---|
96 | be read by software which doesn't understand the latest 3d file format version. |
---|
97 | Note that any information which the specified format version didn't support |
---|
98 | will be omitted. |
---|
99 | </Para> |
---|
100 | </ListItem> |
---|
101 | </VarListEntry> |
---|
102 | |
---|
103 | </VariableList> |
---|
104 | |
---|
105 | </refsect1> |
---|
106 | |
---|
107 | <refsect1><Title>Output</Title> |
---|
108 | |
---|
109 | <Para>Cavern reads in text files containing the survey data |
---|
110 | &svx;) and outputs two files, with the extensions |
---|
111 | &x3d; and &err;. |
---|
112 | By default these files are put in the current directory, |
---|
113 | with the same base filename as the first &svx; file read, |
---|
114 | but a different extension. |
---|
115 | You can change the directory and/or base filename using the --output |
---|
116 | command line option. |
---|
117 | <!-- FIXME: link --> |
---|
118 | </Para> |
---|
119 | |
---|
120 | <Para>E.g. if you process the data file <filename>entrance.svx</filename> |
---|
121 | with the command <userinput>cavern entrance</userinput> then the files |
---|
122 | <filename>entrance.3d</filename> and <filename>entrance.err</filename> |
---|
123 | will be created. |
---|
124 | </Para> |
---|
125 | |
---|
126 | <!-- mention .log FIXME --> |
---|
127 | |
---|
128 | <Para> |
---|
129 | Cavern also gives a range of statistics at the end of a successful run: |
---|
130 | </Para> |
---|
131 | |
---|
132 | <itemizedlist> |
---|
133 | <listitem><para>The highest and lowest stations and the height difference |
---|
134 | between them |
---|
135 | </para></listitem> |
---|
136 | |
---|
137 | <listitem><para>The total length of the survey (before and after |
---|
138 | adjustment). This total excludes survey legs flagged as SURFACE, |
---|
139 | DUPLICATE, or SPLAY. |
---|
140 | </para></listitem> |
---|
141 | |
---|
142 | <listitem><para>The number of stations and legs. Note that a *EQUATE |
---|
143 | is counted as a leg in this statistic. |
---|
144 | </para></listitem> |
---|
145 | |
---|
146 | <!-- FIXME loops, components, anything else --> |
---|
147 | |
---|
148 | <listitem><para>The East-West and North-South ranges, and the North-most, |
---|
149 | South-most, East-most, and West-most stations. |
---|
150 | </para></listitem> |
---|
151 | |
---|
152 | <listitem><para>The number of each size of node in the network (where size |
---|
153 | is number of connections to a station) i.e. a one node is the end of a |
---|
154 | dead-end traverse, a two-node is a typical station in the middle of a |
---|
155 | traverse, a three-node is a T-junction etc. |
---|
156 | </para></listitem> |
---|
157 | |
---|
158 | <listitem><para>How long the processing took and how much CPU time was |
---|
159 | used. |
---|
160 | </para></listitem> |
---|
161 | </itemizedlist> |
---|
162 | |
---|
163 | <refsect2><Title>&x3d; - data describing the loop-closed centre line</Title> |
---|
164 | |
---|
165 | <Para>This file contains details of the stations and legs, and any |
---|
166 | flags associated with them. |
---|
167 | </Para> |
---|
168 | |
---|
169 | </refsect2> |
---|
170 | |
---|
171 | <refsect2><Title>&err; - loop closure statistics (%age errors, etc)</Title> |
---|
172 | |
---|
173 | <Para>This file contains statistics about each traverse in the survey |
---|
174 | which is part of a loop. It includes various statistics for each |
---|
175 | traverse, such as the percentage error per leg. |
---|
176 | You should study this information to determine if any parts of the survey |
---|
177 | are of lower quality or contain gross errors. |
---|
178 | |
---|
179 | <!-- FIXME explain the various statistics --> |
---|
180 | </Para> |
---|
181 | |
---|
182 | </refsect2> |
---|
183 | |
---|
184 | </refsect1> |
---|
185 | |
---|
186 | <refsect1><Title>Error Messages</Title> |
---|
187 | |
---|
188 | <Para> |
---|
189 | There are a number of error messages that you may get when processing |
---|
190 | data. Most of these are self explanatory, and will be caused by such |
---|
191 | problems as typing mistakes, or by your survey data not being attached |
---|
192 | to fixed points (in this situation, &survexsuite; will |
---|
193 | list some of the stations that are not connected). |
---|
194 | </Para> |
---|
195 | |
---|
196 | <Para> |
---|
197 | Along with the error message, the filename and line number of the offending |
---|
198 | line will be printed (or the filename for errors such as `file not |
---|
199 | found'). The format of the filename and line number is that used by |
---|
200 | gcc, so if your editor can parse errors from gcc, you should be able to |
---|
201 | set it to allow you to jump to the file and line of each error. |
---|
202 | </Para> |
---|
203 | |
---|
204 | <Para> |
---|
205 | Cavern will stop after more than 50 errors. This usually indicates |
---|
206 | something like the incorrect data order being specified. Deluging |
---|
207 | the user with error messages makes the actual problem less clear. |
---|
208 | </Para> |
---|
209 | |
---|
210 | </refsect1> |
---|