1 | <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ |
---|
2 | <!ENTITY man.aven SYSTEM "aven.sgml"> |
---|
3 | <!ENTITY man.3dtopos SYSTEM "3dtopos.sgml"> |
---|
4 | <!ENTITY man.cad3d SYSTEM "cad3d.sgml"> |
---|
5 | <!ENTITY man.cavern SYSTEM "cavern.sgml"> |
---|
6 | <!ENTITY man.diffpos SYSTEM "diffpos.sgml"> |
---|
7 | <!ENTITY man.dump3d SYSTEM "dump3d.sgml"> |
---|
8 | <!ENTITY man.extend SYSTEM "extend.sgml"> |
---|
9 | <!ENTITY man.sorterr SYSTEM "sorterr.sgml"> |
---|
10 | ]> |
---|
11 | |
---|
12 | <!-- |
---|
13 | FIXME: |
---|
14 | |
---|
15 | 3dfile title: |
---|
16 | defaults to a list of the leafnames of the <filename>.svx</filename> files specified on the |
---|
17 | command line (with any paths and extensions removed). |
---|
18 | . |
---|
19 | e.g.: cavern entrance.svx \data\2ndpart.svx |
---|
20 | . |
---|
21 | would give a surveytitle of 'entrance 2ndpart'. |
---|
22 | . |
---|
23 | but this may change... |
---|
24 | |
---|
25 | FIXME todo: |
---|
26 | mark-up of Windows Windows NT etc? |
---|
27 | section on "design philosophy" |
---|
28 | |
---|
29 | level sump fudge: |
---|
30 | |
---|
31 | *begin |
---|
32 | *data cartesian from to dx dy dz |
---|
33 | *sd dx dy 100 metres |
---|
34 | *sd dz 0.001 metres |
---|
35 | ; upstream - downstream |
---|
36 | nuiping.gowiththeflow.129 dachao.upstream.105 0 0 0 ; last number is drop in height across the sump |
---|
37 | *end |
---|
38 | |
---|
39 | ``Quick start'' section |
---|
40 | |
---|
41 | - install (by OS): unpacking, configuration (language, where support files live) |
---|
42 | |
---|
43 | - lead people through entering and processing |
---|
44 | a sample survey. Take examples from surveying books and real surveys. |
---|
45 | |
---|
46 | |
---|
47 | <Para>The other really important commands apart from *BEGIN, *END, and |
---|
48 | *INCLUDE are *EQUATE and *FIX. |
---|
49 | </Para> |
---|
50 | |
---|
51 | <Para>*EQUATE is used to join surveys together, e.g. |
---|
52 | </Para> |
---|
53 | |
---|
54 | <programlisting>*equate entrance.6 adrian.1</programlisting> |
---|
55 | |
---|
56 | <Para> |
---|
57 | indicates that station 6 of the entrance survey was used as |
---|
58 | the station 1 of the Adrian's Route survey. |
---|
59 | </Para> |
---|
60 | |
---|
61 | <Para>*FIX is for fixing control points - for example: |
---|
62 | </Para> |
---|
63 | |
---|
64 | <programlisting> |
---|
65 | *fix 161.entrance.1 0 0 1780</programlisting> |
---|
66 | |
---|
67 | <Para>fixes the 1st point of the 'entrance' survey at the coordinates |
---|
68 | 0 (east-west), 0 (north-south), 1780 (altitude). |
---|
69 | </Para> |
---|
70 | |
---|
71 | |
---|
72 | <term>node</term> |
---|
73 | <listitem><para>when talking about the survey network, we talk about an |
---|
74 | <emphasis>n</emphasis>-node to describe the number of connections to |
---|
75 | a station. So a 1-node is a station with only 1 leg to or from it |
---|
76 | - i.e. The end of a passage or survey. A |
---|
77 | 2-node is a typical station along a passage with a survey leg coming |
---|
78 | into it, and one going out. A 3-node is a station with three legs |
---|
79 | joining it, e.g. at a T-junction. And so on. |
---|
80 | </para> |
---|
81 | |
---|
82 | --> |
---|
83 | |
---|
84 | <article Status="draft" id="index"> |
---|
85 | <articleinfo> |
---|
86 | <Title><Application>Survex</Application> <!--VERSION-->1.2.31 Manual</Title> |
---|
87 | <AuthorGroup> |
---|
88 | <Author> |
---|
89 | <FirstName>Olly</FirstName> |
---|
90 | <SurName>Betts</SurName> |
---|
91 | <AuthorBlurb><Para> |
---|
92 | Olly Betts wrote most of <Application>Survex</Application>. |
---|
93 | </Para></AuthorBlurb> |
---|
94 | <Affiliation> |
---|
95 | <Address><Email>olly@survex.com</Email></Address> |
---|
96 | </Affiliation> |
---|
97 | </Author> |
---|
98 | <Author> |
---|
99 | <SurName>Wookey</SurName> |
---|
100 | <AuthorBlurb><Para> |
---|
101 | Wookey is a small furry creature. |
---|
102 | </Para></AuthorBlurb> |
---|
103 | <Affiliation> |
---|
104 | <Address><Email>wookey@survex.com</Email></Address> |
---|
105 | </Affiliation> |
---|
106 | </Author> |
---|
107 | </AuthorGroup> |
---|
108 | <copyright> |
---|
109 | <year>1998-2016</year> |
---|
110 | <holder role="mailto:olly@survex.com">Olly Betts</holder> |
---|
111 | </copyright> |
---|
112 | <Abstract> |
---|
113 | <Para> |
---|
114 | This is the manual for <Application>Survex</Application> - an open-source software package for |
---|
115 | cave surveyors. |
---|
116 | </Para> |
---|
117 | </Abstract> |
---|
118 | </articleinfo> |
---|
119 | |
---|
120 | <Sect1><Title>Introduction</Title> |
---|
121 | <?dbhtml filename="intro.htm"> |
---|
122 | |
---|
123 | <Para> |
---|
124 | This section describes what <Application>Survex</Application> is, and outlines the scope of this |
---|
125 | manual. |
---|
126 | </Para> |
---|
127 | |
---|
128 | <Sect2><Title>About <Application>Survex</Application></Title> |
---|
129 | |
---|
130 | <Para><Application>Survex</Application> is a multi-platform open-source cave surveying |
---|
131 | package. |
---|
132 | Version 1.2 runs on UNIX, Microsoft Windows, and Mac OS X. |
---|
133 | We're investigating support for phones and tablets. |
---|
134 | </Para> |
---|
135 | |
---|
136 | <Para>We are well aware that not everyone has access to super hardware |
---|
137 | - often surveying projects are run on little or no budget and any |
---|
138 | computers used are donated. We aim to ensure that <Application>Survex</Application> is |
---|
139 | feasible to use on low-spec machines. Obviously it won't be as |
---|
140 | responsive, but we intend it to be usable. |
---|
141 | Please help us to achieve this by giving us some feedback |
---|
142 | if you use <Application>Survex</Application> on a slow machine.</Para> |
---|
143 | |
---|
144 | <Para><Application>Survex</Application> is capable of processing extremely complex caves very |
---|
145 | quickly and has a very effective, real-time cave viewer which allows |
---|
146 | you to rotate, zoom, and pan the cave using mouse or keyboard. We have |
---|
147 | tested it extensively using <Acronym>CUCC</Acronym> and <Acronym>ARGE</Acronym>'s surveys of the caves |
---|
148 | under the Loser Plateau in Austria (over 25,000 survey legs, and over |
---|
149 | 140km of underground survey data). This can all be processed in around |
---|
150 | 10 seconds on a low-end netbook. |
---|
151 | Survex is also used by many other survey projects around the world, |
---|
152 | including the |
---|
153 | <ulink url="http://www.oucc.org.uk/draenen/draenenmain.htm" |
---|
154 | >Ogof Draenen</ulink> survey, the |
---|
155 | <ulink url="http://www.easegill.org.uk/">Easegill</ulink> resurvey project, |
---|
156 | the <Acronym>OFD</Acronym> survey, the |
---|
157 | <!-- url="http://milos2.zoo.ox.ac.uk/~oucc/reports/surveys/surveys.htm" --> |
---|
158 | <ulink url="http://www.oucc.org.uk/reports/surveys/surveys.htm" |
---|
159 | ><Acronym>OUCC</Acronym> Picos expeditions</ulink>, and the |
---|
160 | <ulink url="http://www.hongmeigui.net/">Hong Meigui China |
---|
161 | expeditions</ulink>. <!-- FIXME more? --></Para> |
---|
162 | |
---|
163 | <Para><Application>Survex</Application> is still actively being worked on. Version 1.0 was |
---|
164 | complete in some sense, but development continues - initially in reshaping |
---|
165 | Survex into a more integrated GUI package.</Para> |
---|
166 | |
---|
167 | <Para>We encourage feedback from users on important features or problems, |
---|
168 | which will help to direct future development. See the "Mailing List" section |
---|
169 | of this manual for the best way to contact us.</Para> |
---|
170 | |
---|
171 | </Sect2> |
---|
172 | |
---|
173 | <!-- |
---|
174 | <Para>Because <Application>Survex</Application> is still being actively developed, this document |
---|
175 | has an unfortunate tendency to lag slightly behind the capabilities of the |
---|
176 | software. The latest version is now available on the web at <ulink |
---|
177 | url="https://survex.com/">https://survex.com/</ulink> - check there for latest info. |
---|
178 | </Para> |
---|
179 | --> |
---|
180 | |
---|
181 | <!-- |
---|
182 | <Sect2><Title>Other Documentation</Title> |
---|
183 | |
---|
184 | <variablelist> |
---|
185 | <varlistentry> |
---|
186 | <term>NEWS or NEWS.txt</term> |
---|
187 | <listitem><Para>a list of changes of interest to |
---|
188 | <Application>Survex</Application> users, broken down by version number. Consult this file |
---|
189 | when upgrading to find out what has changed since the version you were |
---|
190 | using previously. |
---|
191 | </Para></listitem> |
---|
192 | </varlistentry> |
---|
193 | |
---|
194 | <varlistentry> |
---|
195 | <term>ChangeLog or CHANGES.txt</term> |
---|
196 | <listitem><Para>a much more detailed list of changes, aimed at developers |
---|
197 | rather than end users. |
---|
198 | </Para></listitem> |
---|
199 | </varlistentry> |
---|
200 | |
---|
201 | <varlistentry> |
---|
202 | <term>BUGS or BUGS.txt</term> |
---|
203 | <listitem><Para>a list of known bugs. |
---|
204 | </Para></listitem> |
---|
205 | </varlistentry> |
---|
206 | |
---|
207 | <varlistentry> |
---|
208 | <term>TODO or TODO.txt</term> |
---|
209 | <listitem><Para>planned changes and enhancements. |
---|
210 | </Para></listitem> |
---|
211 | </varlistentry> |
---|
212 | |
---|
213 | FIXME: merge INSTALL* into here, then process separately and textify |
---|
214 | to produce INSTALL* |
---|
215 | |
---|
216 | <varlistentry> |
---|
217 | <term>INSTALL or INSTALL.txt</term> |
---|
218 | <listitem><Para>instructions for installing <Application>Survex</Application>. The |
---|
219 | Microsoft Windows version comes packaged up with an installation wizard, |
---|
220 | so this file doesn't exist there (you just run the package and follow |
---|
221 | the on-screen instructions). |
---|
222 | </Para></listitem> |
---|
223 | </varlistentry> |
---|
224 | </variablelist> |
---|
225 | |
---|
226 | </Sect2> |
---|
227 | --> |
---|
228 | |
---|
229 | <Sect2><Title>About this Manual</Title> |
---|
230 | |
---|
231 | <Para> |
---|
232 | If there's a part of this manual you find hard to understand, please do |
---|
233 | let us know. We already know Survex well, so it can be hard for us |
---|
234 | to spot areas where the manual doesn't given enough information, or |
---|
235 | doesn't explain things clearly enough to follow when you don't know what's |
---|
236 | going on. It's helpful is you can suggest a better wording, but don't worry |
---|
237 | if you can't, just explain the problem as precisely as you can. |
---|
238 | </Para> |
---|
239 | |
---|
240 | <Para> |
---|
241 | The master version of this manual is an <acronym>SGML</acronym> |
---|
242 | document written using the <ulink url="http://www.docbook.org/">docbook |
---|
243 | <acronym>DTD</acronym></ulink>, |
---|
244 | and automatically converted to a number of other formats. If |
---|
245 | you are going to send us <emphasis>major</emphasis> changes, it's much easier |
---|
246 | to include them if you work from this master. You can get it |
---|
247 | from the source archive (docs/manual.sgml) or from <ulink |
---|
248 | url="https://survex.com/docs.html">the Survex website</ulink>. |
---|
249 | </Para> |
---|
250 | |
---|
251 | <Sect3><Title>Terminology</Title> |
---|
252 | |
---|
253 | <Para>Throughout this document we use British terminology for |
---|
254 | surveying.</Para> |
---|
255 | |
---|
256 | <variablelist> |
---|
257 | <varlistentry> |
---|
258 | <term>station</term> |
---|
259 | <listitem><para>a point in the cave that you survey from and/or to |
---|
260 | </para></listitem></varlistentry> |
---|
261 | |
---|
262 | <varlistentry> |
---|
263 | <term>leg</term> |
---|
264 | <listitem><para>a line joining two stations |
---|
265 | </para></listitem></varlistentry> |
---|
266 | |
---|
267 | <varlistentry> |
---|
268 | <term>survey</term> |
---|
269 | <listitem><para>a group of legs surveyed on the same trip |
---|
270 | </para></listitem></varlistentry> |
---|
271 | |
---|
272 | </variablelist> |
---|
273 | |
---|
274 | </Sect3> |
---|
275 | |
---|
276 | </Sect2> |
---|
277 | |
---|
278 | <!-- FIXME: Further sources of info: website, mailing lists, other docs --> |
---|
279 | |
---|
280 | </Sect1> |
---|
281 | |
---|
282 | <Sect1><Title>Getting Started</Title> |
---|
283 | <?dbhtml filename="getstart.htm"> |
---|
284 | |
---|
285 | <Para>This section covers how to obtain the software, and how to unpack and |
---|
286 | install it, and how to configure it.</Para> |
---|
287 | |
---|
288 | <Sect2><Title>Obtaining <Application>Survex</Application></Title> |
---|
289 | |
---|
290 | <Para>The latest version is available from the <Application>Survex</Application> website: |
---|
291 | <ulink url="https://survex.com/">https://survex.com/</ulink>. It is also |
---|
292 | freely redistributable, so you welcome to get a copy from someone else |
---|
293 | who has already downloaded it.</Para> |
---|
294 | |
---|
295 | <Para>If you want some sample data to experiment with, you can download some |
---|
296 | from the Survex website too: |
---|
297 | <ulink url="https://survex.com/software/sample.tar.gz">https://survex.com/software/sample.tar.gz</ulink></Para> |
---|
298 | |
---|
299 | </Sect2> |
---|
300 | |
---|
301 | <Sect2><Title>Installing <Application>Survex</Application></Title> |
---|
302 | |
---|
303 | <Para>The details of installation depend greatly on what platform you |
---|
304 | are using, so there is a separate section below for each platform.</Para> |
---|
305 | |
---|
306 | <Sect3><Title>Linux</Title> |
---|
307 | |
---|
308 | <Para> |
---|
309 | We supply pre-compiled versions for x86 Linux machines in RPM format |
---|
310 | (suitable for Redhat, Mandrake, and some other distributions). |
---|
311 | Survex Debian packages are available from Debian mirror sites in |
---|
312 | the usual way. |
---|
313 | </Para> |
---|
314 | |
---|
315 | <Para> |
---|
316 | You'll need root access to install these prebuilt packages. |
---|
317 | If you don't have root access you will need to build from source |
---|
318 | (see the next section). |
---|
319 | </Para> |
---|
320 | |
---|
321 | <!-- FIXME Add Gnome file association note for Linux/Unix |
---|
322 | <Para>On Microsoft Windows, <Application>Survex</Application> installs with |
---|
323 | suitable file associations so that you can drive it from the GUI. |
---|
324 | On UNIX you need to drive <Application>Survex</Application> from a command-line |
---|
325 | prompt (or set some a filemanager or graphics shell). |
---|
326 | </Para> |
---|
327 | --> |
---|
328 | |
---|
329 | </Sect3> |
---|
330 | |
---|
331 | <Sect3><Title>Other versions of UNIX</Title> |
---|
332 | |
---|
333 | <Para>For other UNIX versions you'll need to get the source code |
---|
334 | and compile it on your system. Unpack the sources and read |
---|
335 | the file called INSTALL in the top level for details about building |
---|
336 | from source. |
---|
337 | </Para> |
---|
338 | |
---|
339 | </Sect3> |
---|
340 | |
---|
341 | <Sect3><Title>Microsoft Windows</Title> |
---|
342 | |
---|
343 | <Para> |
---|
344 | This version comes packaged with an installation wizard. Just |
---|
345 | run the downloaded package and it will lead you through the |
---|
346 | installation process. If you want the file associations to be |
---|
347 | set up for all user, run the installer as administrator, or as a |
---|
348 | user with administrator rights. |
---|
349 | </Para> |
---|
350 | |
---|
351 | <Para> |
---|
352 | The survey viewer that's part of <Application>Survex</Application> is called |
---|
353 | aven, and uses OpenGL for 3d rendering. |
---|
354 | </Para> |
---|
355 | |
---|
356 | <Para> |
---|
357 | If you find that 3D rendering is sometimes very slow (e.g. one user reported |
---|
358 | very slow performance when running full screen, while running in a window |
---|
359 | was fine) then try installing the OpenGL driver supplied by the manufacturer |
---|
360 | of your graphics card rather than the driver Microsoft supply. |
---|
361 | </Para> |
---|
362 | |
---|
363 | <Para> |
---|
364 | The installer creates a Survex group in the Programs sub-menu of the |
---|
365 | Start menu containing the following items: |
---|
366 | </Para> |
---|
367 | |
---|
368 | <ItemizedList> |
---|
369 | |
---|
370 | <ListItem><Para>Aven</Para></ListItem> |
---|
371 | |
---|
372 | <ListItem><Para>Documentation</Para></ListItem> |
---|
373 | |
---|
374 | <ListItem><Para>Uninstall Survex</Para></ListItem> |
---|
375 | |
---|
376 | </ItemizedList> |
---|
377 | |
---|
378 | <Para> |
---|
379 | Icons are installed for <filename>.svx</filename>, <filename>.3d</filename>, <filename>.err</filename>, and <filename>.pos</filename> files, and also for |
---|
380 | Compass Plot files (<filename>.plt</filename> and <filename>.plf</filename>) |
---|
381 | (which Survex can read). <!-- FIXME XYZ --> |
---|
382 | Double-clicking on a <filename>.svx</filename> file loads it for editing. To process it to |
---|
383 | produce a <filename>.3d</filename> file, right click and choose "Process" from the menu. |
---|
384 | Double-clicking the resultant <filename>.3d</filename> file views it in aven. |
---|
385 | All the <Application>Survex</Application> file types can be right clicked on to give a menu of |
---|
386 | possible actions. |
---|
387 | </Para> |
---|
388 | |
---|
389 | <VariableList> |
---|
390 | <VarListEntry><Term><filename>.svx</filename></Term> |
---|
391 | <ListItem> |
---|
392 | <VariableList> |
---|
393 | <VarListEntry><Term>Process</Term> |
---|
394 | <ListItem><Para> |
---|
395 | Process file with aven to produce <filename>.3d</filename> file (and <filename>.err</filename> file) |
---|
396 | </Para></ListItem> |
---|
397 | </VarListEntry> |
---|
398 | </VariableList> |
---|
399 | </ListItem> |
---|
400 | </VarListEntry> |
---|
401 | |
---|
402 | <VarListEntry><Term><filename>.3d</filename></Term> |
---|
403 | <ListItem> |
---|
404 | <VariableList> |
---|
405 | <VarListEntry><Term>Open</Term> |
---|
406 | <ListItem><Para> |
---|
407 | Load file into Aven |
---|
408 | </Para></ListItem> |
---|
409 | </VarListEntry> |
---|
410 | <VarListEntry><Term>Print</Term> |
---|
411 | <ListItem><Para> |
---|
412 | Send to the printer |
---|
413 | </Para></ListItem> |
---|
414 | </VarListEntry> |
---|
415 | <VarListEntry><Term>Extend</Term> |
---|
416 | <ListItem><Para> |
---|
417 | Produce extended elevation |
---|
418 | </Para></ListItem> |
---|
419 | </VarListEntry> |
---|
420 | <VarListEntry><Term>Convert to DXF</Term> |
---|
421 | <ListItem><Para> |
---|
422 | Convert to a DXF file (suitable for importing into many CAD packages) |
---|
423 | </Para></ListItem> |
---|
424 | </VarListEntry> |
---|
425 | <VarListEntry><Term>Convert for hand plotting</Term> |
---|
426 | <ListItem><Para> |
---|
427 | Produce a <filename>.pos</filename> file listing all the stations and their coordinates |
---|
428 | </Para></ListItem> |
---|
429 | </VarListEntry> |
---|
430 | </VariableList> |
---|
431 | </ListItem> |
---|
432 | </VarListEntry> |
---|
433 | |
---|
434 | <VarListEntry><Term><filename>.err</filename></Term> |
---|
435 | <ListItem> |
---|
436 | <VariableList> |
---|
437 | <VarListEntry><Term>Open</Term> |
---|
438 | <ListItem><Para> |
---|
439 | Load file into Notepad |
---|
440 | </Para></ListItem> |
---|
441 | </VarListEntry> |
---|
442 | <VarListEntry><Term>Sort by Error</Term> |
---|
443 | <ListItem><Para> |
---|
444 | Sort <filename>.err</filename> file by the error in each traverse |
---|
445 | </Para></ListItem> |
---|
446 | </VarListEntry> |
---|
447 | <VarListEntry><Term>Sort by Horizontal Error</Term> |
---|
448 | <ListItem><Para> |
---|
449 | Sort <filename>.err</filename> file by the horizontal error in each traverse |
---|
450 | </Para></ListItem> |
---|
451 | </VarListEntry> |
---|
452 | <VarListEntry><Term>Sort by Vertical Error</Term> |
---|
453 | <ListItem><Para> |
---|
454 | Sort <filename>.err</filename> file by the vertical error in each traverse |
---|
455 | </Para></ListItem> |
---|
456 | </VarListEntry> |
---|
457 | <VarListEntry><Term>Sort by Percentage Error</Term> |
---|
458 | <ListItem><Para> |
---|
459 | Sort <filename>.err</filename> file by the percentage error in each traverse |
---|
460 | </Para></ListItem> |
---|
461 | </VarListEntry> |
---|
462 | <VarListEntry><Term>Sort by Error per Leg</Term> |
---|
463 | <ListItem><Para> |
---|
464 | Sort <filename>.err</filename> file by the error per leg in each traverse |
---|
465 | </Para></ListItem> |
---|
466 | </VarListEntry> |
---|
467 | </VariableList> |
---|
468 | </ListItem> |
---|
469 | </VarListEntry> |
---|
470 | </VariableList> |
---|
471 | |
---|
472 | </Sect3> |
---|
473 | |
---|
474 | </Sect2> |
---|
475 | |
---|
476 | <Sect2><Title>Configuration</Title> |
---|
477 | |
---|
478 | <Sect3><Title>Selecting Your Preferred Language</Title> |
---|
479 | |
---|
480 | <Para>Survex has extensive internationalisation capabilities. The |
---|
481 | language used for messages from Survex and most of the library calls |
---|
482 | it uses can be changed. By default this is picked up from the |
---|
483 | language the operating system is set to use (from "Regional Settings" |
---|
484 | in Control Panel on Microsoft Windows, from the |
---|
485 | <systemitem>LANG</systemitem> environment variable on UNIX |
---|
486 | If no setting |
---|
487 | is found, or <Application>Survex</Application> hasn't been translated into the |
---|
488 | requested language, UK English is used.</Para> |
---|
489 | |
---|
490 | <Para> |
---|
491 | However you may want to override the language manually - |
---|
492 | for example if Survex isn't available in your native language |
---|
493 | you'll want to choose the supported language you understand best. |
---|
494 | </Para> |
---|
495 | |
---|
496 | <Para> |
---|
497 | To do this, you set the |
---|
498 | <systemitem>SURVEXLANG</systemitem> environment variable. Here's a list |
---|
499 | of the codes currently supported:</Para> |
---|
500 | |
---|
501 | <informaltable frame="all"> |
---|
502 | <tgroup cols="2"> |
---|
503 | <thead> |
---|
504 | <row><entry>Code</entry><entry>Language</entry></row> |
---|
505 | </thead> |
---|
506 | <tbody> |
---|
507 | <row><entry>en</entry><entry>International English</entry></row> |
---|
508 | <row><entry>en_US</entry><entry>US English</entry></row> |
---|
509 | <row><entry>bg</entry><entry>Bulgarian</entry></row> |
---|
510 | <row><entry>ca</entry><entry>Catalan</entry></row> |
---|
511 | <row><entry>de</entry><entry>German</entry></row> |
---|
512 | <row><entry>de_CH</entry><entry>Swiss German</entry></row> |
---|
513 | <row><entry>el</entry><entry>Greek</entry></row> |
---|
514 | <row><entry>es</entry><entry>Spanish</entry></row> |
---|
515 | <row><entry>fr</entry><entry>French</entry></row> |
---|
516 | <row><entry>hu</entry><entry>Hungarian</entry></row> |
---|
517 | <row><entry>id</entry><entry>Indonesian</entry></row> |
---|
518 | <row><entry>it</entry><entry>Italian</entry></row> |
---|
519 | <row><entry>pl</entry><entry>Polish</entry></row> |
---|
520 | <row><entry>pt</entry><entry>Portuguese</entry></row> |
---|
521 | <row><entry>pt_BR</entry><entry>Brazillian Portuguese</entry></row> |
---|
522 | <row><entry>ro</entry><entry>Romanian</entry></row> |
---|
523 | <row><entry>ru</entry><entry>Russian</entry></row> |
---|
524 | <row><entry>sk</entry><entry>Slovak</entry></row> |
---|
525 | <row><entry>zh_CN</entry><entry>Chinese (Simplified)</entry></row> |
---|
526 | </tbody> |
---|
527 | </tgroup> |
---|
528 | </informaltable> |
---|
529 | |
---|
530 | <Para>Here are examples of how to set this environment variable to give |
---|
531 | messages in French (language code fr):</Para> |
---|
532 | |
---|
533 | <VariableList> |
---|
534 | <VarListEntry><Term>Microsoft Windows</Term> |
---|
535 | <ListItem><Para> |
---|
536 | For MS Windows proceed as follows (this description was written from |
---|
537 | MS Windows 2000, but it should be fairly similar in other versions): Open the |
---|
538 | Start Menu, navigate to the Settings sub-menu, and |
---|
539 | open Control Panel. Open System (picture of a computer) and click on the |
---|
540 | Advanced tab. Choose `Environmental Variables', and create a new one: name |
---|
541 | <systemitem>SURVEXLANG</systemitem>, value <systemitem>fr</systemitem>. |
---|
542 | Click OK and the new value should be effective immediately. |
---|
543 | </Para></ListItem> |
---|
544 | </VarListEntry> |
---|
545 | <VarListEntry><Term>UNIX - csh/tcsh</Term> |
---|
546 | <ListItem><Para><userinput>setenv SURVEXLANG fr</userinput></Para></ListItem> |
---|
547 | </VarListEntry> |
---|
548 | <VarListEntry><Term>UNIX - sh/bash</Term> |
---|
549 | <ListItem><Para><userinput>SURVEXLANG=fr ; export SURVEXLANG</userinput></Para></ListItem> |
---|
550 | </VarListEntry> |
---|
551 | </VariableList> |
---|
552 | |
---|
553 | <Para>If <Application>Survex</Application> isn't available in your language, you could |
---|
554 | help out by providing a translation. The initial translation is |
---|
555 | likely to be about a day's work; after that translations for |
---|
556 | new or changed messages are occasionally required. Contact us for details |
---|
557 | if you're interested.</Para> |
---|
558 | |
---|
559 | </Sect3> |
---|
560 | |
---|
561 | </Sect2> |
---|
562 | |
---|
563 | </Sect1> |
---|
564 | |
---|
565 | <!-- FIXME |
---|
566 | |
---|
567 | type in .svx file |
---|
568 | |
---|
569 | run cavern (through aven) |
---|
570 | |
---|
571 | run aven |
---|
572 | |
---|
573 | how to print/export etc |
---|
574 | |
---|
575 | --> |
---|
576 | |
---|
577 | <!-- FIXME perhaps move this after data files section? --> |
---|
578 | <Sect1><Title>Survex Programs</Title> |
---|
579 | <?dbhtml filename="cmdline.htm"> |
---|
580 | |
---|
581 | <Sect2><Title>Standard Options</Title> |
---|
582 | |
---|
583 | <Para>All <Application>Survex</Application> programs respond to the following command line options: |
---|
584 | </Para> |
---|
585 | |
---|
586 | <VariableList> |
---|
587 | |
---|
588 | <VarListEntry><Term>--help</Term><listitem><Para> |
---|
589 | display option summary and exit |
---|
590 | </Para></listitem></VarListEntry> |
---|
591 | |
---|
592 | <VarListEntry><Term>--version</Term><listitem><Para> |
---|
593 | output version information and exit |
---|
594 | </Para></listitem></VarListEntry> |
---|
595 | |
---|
596 | </VariableList> |
---|
597 | |
---|
598 | </Sect2> |
---|
599 | |
---|
600 | <Sect2><Title>Short and Long Options</Title> |
---|
601 | |
---|
602 | <Para> |
---|
603 | Options have two forms: short (a dash followed by a single letter e.g. |
---|
604 | <command>cavern -q</command>) and long (two dashes followed by one or more words e.g. |
---|
605 | <command>cavern --quiet</command>). The long form is generally easier to |
---|
606 | remember, while the short form is quicker to type. Options are often |
---|
607 | available in both forms. |
---|
608 | </Para> |
---|
609 | |
---|
610 | <Note><Para>Command line options are case sensitive, so "-B" and "-b" |
---|
611 | are different (this didn't used to be the case before Survex 0.90). Case |
---|
612 | sensitivity doubles the number of available short options (and is also the |
---|
613 | norm on UNIX). |
---|
614 | </Para></Note> |
---|
615 | </Sect2> |
---|
616 | |
---|
617 | <Sect2><Title>Filenames on the Command Line</Title> |
---|
618 | |
---|
619 | <Para>Filenames with spaces can be processed (provided your operating system |
---|
620 | supports them - UNIX does, and so do recent versions of Microsoft |
---|
621 | Windows). You need to enclose the filename in quotes like so: |
---|
622 | <userinput>cavern "Spider Cave"</userinput> |
---|
623 | </Para> |
---|
624 | |
---|
625 | <Para>A file specified on the command line of any of the <Application>Survex</Application> suite |
---|
626 | of programs will be looked for as specified. If it is not found, then the |
---|
627 | file is looked for with the appropriate extension appended. So |
---|
628 | <userinput>cavern survey</userinput> will look first for |
---|
629 | <filename>survey</filename>, then for <filename>survey.svx</filename>. |
---|
630 | </Para> |
---|
631 | |
---|
632 | </Sect2> |
---|
633 | |
---|
634 | <Sect2><title>Command Reference</title> |
---|
635 | |
---|
636 | <refentry id="cavern"> |
---|
637 | <?dbhtml filename="cavern.htm"> |
---|
638 | &man.cavern; |
---|
639 | </refentry> |
---|
640 | <refentry id="aven"> |
---|
641 | <?dbhtml filename="aven.htm"> |
---|
642 | &man.aven; |
---|
643 | </refentry> |
---|
644 | <refentry id="x3dtopos"> |
---|
645 | <?dbhtml filename="3dtopos.htm"> |
---|
646 | &man.3dtopos; |
---|
647 | </refentry> |
---|
648 | <refentry id="cad3d"> |
---|
649 | <?dbhtml filename="cad3d.htm"> |
---|
650 | &man.cad3d; |
---|
651 | </refentry> |
---|
652 | <refentry id="diffpos"> |
---|
653 | <?dbhtml filename="diffpos.htm"> |
---|
654 | &man.diffpos; |
---|
655 | </refentry> |
---|
656 | <refentry id="extend"> |
---|
657 | <?dbhtml filename="extend.htm"> |
---|
658 | &man.extend; |
---|
659 | </refentry> |
---|
660 | <refentry id="sorterr"> |
---|
661 | <?dbhtml filename="sorterr.htm"> |
---|
662 | &man.sorterr; |
---|
663 | </refentry> |
---|
664 | |
---|
665 | </Sect2> |
---|
666 | |
---|
667 | </Sect1> |
---|
668 | |
---|
669 | <Sect1><Title><Application>Survex</Application> data files</Title> |
---|
670 | <?dbhtml filename="datafile.htm"> |
---|
671 | |
---|
672 | <Para>Survey data is entered in the form of text files. You can use any |
---|
673 | text editor you like for this, so long as it has the capability of |
---|
674 | writing a plain ASCII text file. The data format is very flexible; |
---|
675 | unlike some other cave surveying software, Survex does not require |
---|
676 | survey legs to be rearranged to suit the computer, and the ordering |
---|
677 | of instrument readings on each line is fully specifiable. So you can enter |
---|
678 | your data much as it appears on the survey notes, which is important |
---|
679 | in reducing the opportunities for transcription errors. |
---|
680 | </Para> |
---|
681 | |
---|
682 | <Para> |
---|
683 | Also all the special characters are user-definable - for example, |
---|
684 | the separators can be spaces and tabs, or commas (e.g. when exporting from a |
---|
685 | spreadsheet), etc; the decimal point can be a slash (for clarity), a comma |
---|
686 | (as used in continental Europe), or anything else you care to choose. |
---|
687 | This flexibility |
---|
688 | means that it should be possible to read in data from almost any sort of |
---|
689 | survey data file without much work. |
---|
690 | </Para> |
---|
691 | |
---|
692 | <Para><Application>Survex</Application> places no restrictions on you in terms of the ordering |
---|
693 | of survey legs. You can enter or process data in any order and <Application>Survex</Application> will |
---|
694 | read it all in before determining how it is connected. You can also use the |
---|
695 | hierarchical naming so that you do not need to worry about using the same |
---|
696 | station name twice. |
---|
697 | </Para> |
---|
698 | |
---|
699 | <!-- FIXME don't encourage separate processing --> |
---|
700 | <Para>The usual arrangement is to have one file which lists all the others |
---|
701 | that are included (e.g., <filename>161.svx</filename>). Then |
---|
702 | <command>cavern 161</command> will process all your data. To just process a |
---|
703 | section use the filename for that section, e.g. <command>cavern dtime</command> |
---|
704 | will process the dreamtime file/section of Kaninchenhöhle. To |
---|
705 | help you out, if all legs in a survey are connected to one another |
---|
706 | but the survey has no fixed points, cavern |
---|
707 | will 'invent' a fixed point and print a warning message to this |
---|
708 | effect. |
---|
709 | </Para> |
---|
710 | |
---|
711 | <Para> |
---|
712 | It is up to you what data you put in which files. You |
---|
713 | can have one file per trip, or per area of the cave, or just one |
---|
714 | file for the whole cave if you like. |
---|
715 | On a large survey project it makes sense to group related surveys in the |
---|
716 | same file or directory. |
---|
717 | </Para> |
---|
718 | <!-- FIXME: wook sez: |
---|
719 | |
---|
720 | Point out in documentation that file structure and survey structure don't |
---|
721 | have to be the same. And in particular that folder/directory names can be |
---|
722 | different. |
---|
723 | |
---|
724 | Which is partly covered above, though the last bit isn't... |
---|
725 | --> |
---|
726 | |
---|
727 | <!-- FIXME "Anatomy of a Survey" section --> |
---|
728 | <Sect2><Title>Readings</Title> |
---|
729 | |
---|
730 | <Para>Blank lines (i.e. lines consisting solely of BLANK characters) |
---|
731 | are ignored. The last line in the file need not be terminated by |
---|
732 | an end of line character. All fields on a line must be separated |
---|
733 | by at least one BLANK character. An OMIT character |
---|
734 | (default '-') indicates that a field is unused. If the field is |
---|
735 | not optional, then an error is given. |
---|
736 | </Para> |
---|
737 | |
---|
738 | </Sect2> |
---|
739 | |
---|
740 | <Sect2><Title>Survey Station Names</Title> |
---|
741 | |
---|
742 | <Para><Application>Survex</Application> has a powerful system for naming stations. It |
---|
743 | uses a hierarchy of survey names, similar to the nested folders |
---|
744 | your computer stores files in. |
---|
745 | So point 6 in the entrance survey of Kaninchenhöhle |
---|
746 | (cave number 161) is referred to as: 161.entrance.6 |
---|
747 | </Para> |
---|
748 | |
---|
749 | <Para>This seems a natural way to refer to station names. It also |
---|
750 | means that it is very easy to include more levels, for example if you |
---|
751 | want to plot all the caves in the area you just list them all in |
---|
752 | another file, specifying a new prefix. So to group 3 nearby caves |
---|
753 | on the Loser Plateau you would use a file like |
---|
754 | this: |
---|
755 | </Para> |
---|
756 | |
---|
757 | <programlisting> |
---|
758 | *begin Loser |
---|
759 | *include 161 |
---|
760 | *include 2YrGest |
---|
761 | *include 145 |
---|
762 | *end Loser</programlisting> |
---|
763 | |
---|
764 | <Para> |
---|
765 | The entrance series point mentioned above would now be referred |
---|
766 | to as: Loser.161.entrance.6 |
---|
767 | </Para> |
---|
768 | |
---|
769 | <!-- |
---|
770 | <Para>This may seem a tad complex but is really very natural once you |
---|
771 | get the hang of it. |
---|
772 | </Para> |
---|
773 | --> |
---|
774 | <Para>You do not have to use this system at all, and can just give all |
---|
775 | stations unique identifiers if you like: |
---|
776 | </Para> |
---|
777 | |
---|
778 | <Para>1, 2, 3, 4, 5, ... 1381, 1382 |
---|
779 | </Para> |
---|
780 | |
---|
781 | <Para>or |
---|
782 | </Para> |
---|
783 | |
---|
784 | <Para>AA06, AA07, P34, ZZ6, etc. |
---|
785 | </Para> |
---|
786 | |
---|
787 | <!-- FIXME: |
---|
788 | <Para>However you'll loose the ability to handle subsurveys if you do. |
---|
789 | </Para> |
---|
790 | --> |
---|
791 | |
---|
792 | <Para>Station and survey names may contain any alphanumeric characters and |
---|
793 | additionally any characters in NAMES (default `_' and `-'). Alphabetic |
---|
794 | characters may be forced to upper or lower case by using the *case |
---|
795 | command. Station names may be any length - if you want to only treat |
---|
796 | the first few characters as significant you can get cavern to truncate |
---|
797 | the names using the *truncate command. |
---|
798 | </Para> |
---|
799 | |
---|
800 | <Sect3><Title>Anonymous Stations</Title> |
---|
801 | |
---|
802 | <Para> |
---|
803 | Survex supports the concept of anonymous survey stations. That is |
---|
804 | survey stations without a name. Each time an anonymous station name is |
---|
805 | used it represents a different point. Currently three types of anonymous |
---|
806 | station are supported, referred to by one, two or three separator characters |
---|
807 | - with the default separator of '.', that means '.', '..', and '...' are |
---|
808 | anonymous stations. Their meanings are:</Para> |
---|
809 | |
---|
810 | <VariableList> |
---|
811 | <VarListEntry><Term>Single separator ('.' by default)</Term> |
---|
812 | <ListItem><Para> |
---|
813 | An anonymous non-wall point at the end of an implicit splay. |
---|
814 | </Para></ListItem></VarListEntry> |
---|
815 | |
---|
816 | <VarListEntry><Term>Double separator ('..' by default)</Term> |
---|
817 | <ListItem><Para> |
---|
818 | An anoymous wall point at the end of an implicit splay. |
---|
819 | </Para></ListItem></VarListEntry> |
---|
820 | |
---|
821 | <VarListEntry><Term>Triple separator ('...' by default)</Term> |
---|
822 | <ListItem><Para> |
---|
823 | an anoymous point with no implicit flags on the leg (intended for cases like |
---|
824 | a disto leg along a continuing passage). |
---|
825 | </Para></ListItem></VarListEntry> |
---|
826 | </VariableList> |
---|
827 | |
---|
828 | <Para> |
---|
829 | You can map '-' to '..' (for compatibility with data from pocket topo) using |
---|
830 | the command: |
---|
831 | </Para> |
---|
832 | |
---|
833 | <programlisting> |
---|
834 | *alias station - .. |
---|
835 | </programlisting> |
---|
836 | |
---|
837 | <Para>Support for anonymous stations and for '*alias station - ..' was added in |
---|
838 | Survex 1.2.7.</Para> |
---|
839 | |
---|
840 | </Sect3> |
---|
841 | |
---|
842 | </Sect2> |
---|
843 | |
---|
844 | <Sect2><Title>Numeric fields</Title> |
---|
845 | |
---|
846 | <Para>[<MINUS>|<PLUS>] <integer part> [ <DECIMAL> |
---|
847 | [ <decimal fraction> ] ] |
---|
848 | </Para> |
---|
849 | |
---|
850 | <Para> |
---|
851 | or [<MINUS>|<PLUS>] <DECIMAL> <dec fraction> |
---|
852 | </Para> |
---|
853 | |
---|
854 | <Para><!-- FIXME: put informal description first --> |
---|
855 | i.e. optional PLUS or MINUS sign in front, with |
---|
856 | optional DECIMAL character (default '.'), which may be |
---|
857 | embedded, leading or trailing. No spaces are allowed between the |
---|
858 | various elements. |
---|
859 | </Para> |
---|
860 | |
---|
861 | <Para> |
---|
862 | All of these are valid examples: +47, 23, -22, +4.5, 1.3, -0.7, +.15, .4, |
---|
863 | -.05 |
---|
864 | </Para> |
---|
865 | |
---|
866 | </Sect2> |
---|
867 | |
---|
868 | <Sect2><Title>Accuracy</Title> |
---|
869 | |
---|
870 | <Para>Accuracy assessments may be provided or defaulted for any survey |
---|
871 | leg. These determine the distribution of loop closure errors over the |
---|
872 | legs in the loop. See *SD for more information. |
---|
873 | </Para> |
---|
874 | |
---|
875 | </Sect2> |
---|
876 | |
---|
877 | <!-- |
---|
878 | <Sect2><Title>Survey Coordinate Range</Title> |
---|
879 | |
---|
880 | <Para> |
---|
881 | If we store distances to nearest 10um (0.01mm) in 4 bytes, this |
---|
882 | gives a range of ~20 km. This method is currently not used, but |
---|
883 | has several advantages (data storage space [double uses 8 bytes |
---|
884 | - with my C compiler], speed (unless your FP chip works in parallel |
---|
885 | with your CPU [e.g. the new Acorn FPU for the ARM], and numerical |
---|
886 | accuracy [compared to using floats at least]) and so may be adopted |
---|
887 | in future). Nearest 0.1mm gives -200 km, which is enough for most |
---|
888 | people, but may mean rounding errors become significant. |
---|
889 | </Para> |
---|
890 | |
---|
891 | <Para> |
---|
892 | I will have to do some sums... |
---|
893 | </Para> |
---|
894 | |
---|
895 | </Sect2> |
---|
896 | |
---|
897 | --> |
---|
898 | |
---|
899 | <Sect2><Title>Cavern Commands</Title> |
---|
900 | |
---|
901 | <Para>Commands in <filename>.svx</filename> files are introduced by an asterisk |
---|
902 | (by default - this can be changed using the <command>set</command> command). |
---|
903 | </Para> |
---|
904 | |
---|
905 | <Para>The commands are documented in a common format: |
---|
906 | </Para> |
---|
907 | |
---|
908 | <!-- FIXME: make this a RefGroup (or whatever that's called) of RefEntry-s? --> |
---|
909 | <itemizedlist> |
---|
910 | <listitem><para>Command Name</para></listitem> |
---|
911 | <listitem><para>Syntax</para></listitem> |
---|
912 | <listitem><para>Example</para></listitem> |
---|
913 | <listitem><para>Validity</para></listitem> |
---|
914 | <!-- FIXME |
---|
915 | anywhere, in a block, at start of a block, after a begin (for *end) |
---|
916 | --> |
---|
917 | <listitem><para>Description</para></listitem> |
---|
918 | <listitem><para>Caveats</para></listitem> |
---|
919 | <listitem><para>See Also</para></listitem> |
---|
920 | <!-- FIXME |
---|
921 | "Usefulness" - or status maybe? |
---|
922 | deprecated, esoteric (*set), useful, vital |
---|
923 | --> |
---|
924 | </itemizedlist> |
---|
925 | |
---|
926 | <Sect3><Title>ALIAS</Title> |
---|
927 | |
---|
928 | <VariableList> |
---|
929 | |
---|
930 | <VarListEntry><Term>Syntax</Term> |
---|
931 | |
---|
932 | <listitem><Para>*alias station <alias> [<target>]</Para></listitem> |
---|
933 | |
---|
934 | </VarListEntry> |
---|
935 | |
---|
936 | <VarListEntry><Term>Example</Term> |
---|
937 | |
---|
938 | <listitem> |
---|
939 | <Para> |
---|
940 | <programlisting> |
---|
941 | *begin parsons_nose |
---|
942 | *alias station - .. |
---|
943 | 1 2 12.21 073 -12 |
---|
944 | 2 - 4.33 011 +02 |
---|
945 | 2 - 1.64 180 +03 |
---|
946 | 2 3 6.77 098 -04 |
---|
947 | *end parsons_nose</programlisting> |
---|
948 | </Para> |
---|
949 | </listitem> |
---|
950 | |
---|
951 | </VarListEntry> |
---|
952 | |
---|
953 | <VarListEntry><Term>Description</Term> |
---|
954 | |
---|
955 | <listitem><Para>*alias allows you to map a station name which appears in |
---|
956 | the survey data to a different name internally. At present, you can only |
---|
957 | create an alias of '-' to '..', which is intended to support the pocket topo |
---|
958 | style notation of '-' being a splay to an anonymous point on the cave wall. |
---|
959 | And you can unalias '-' with '*alias station -'. |
---|
960 | </Para> |
---|
961 | |
---|
962 | <Para> |
---|
963 | Aliases are scoped by *begin/*end blocks - when a *end is reached, the aliases |
---|
964 | in force at the corresponding begin are restored. |
---|
965 | </Para> |
---|
966 | |
---|
967 | <Para> |
---|
968 | *alias was added in Survex 1.2.7. |
---|
969 | </Para></listitem> |
---|
970 | |
---|
971 | </VarListEntry> |
---|
972 | |
---|
973 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
974 | |
---|
975 | <VarListEntry><Term>See Also</Term> |
---|
976 | |
---|
977 | <listitem><Para>*begin, *end</Para></listitem> |
---|
978 | |
---|
979 | </VarListEntry> |
---|
980 | |
---|
981 | </VariableList> |
---|
982 | |
---|
983 | </Sect3> |
---|
984 | |
---|
985 | <Sect3><Title>BEGIN</Title> |
---|
986 | |
---|
987 | <VariableList> |
---|
988 | |
---|
989 | <VarListEntry><Term>Syntax</Term> |
---|
990 | |
---|
991 | <listitem><Para>*begin [<survey>]</Para></listitem> |
---|
992 | |
---|
993 | </VarListEntry> |
---|
994 | |
---|
995 | <VarListEntry><Term>Example</Term> |
---|
996 | |
---|
997 | <listitem> |
---|
998 | <Para> |
---|
999 | <programlisting> |
---|
1000 | *begin littlebit |
---|
1001 | 1 2 10.23 106 -02 |
---|
1002 | 2 3 1.56 092 +10 |
---|
1003 | *end littlebit</programlisting> |
---|
1004 | |
---|
1005 | <programlisting> |
---|
1006 | ; length of leg across shaft estimated |
---|
1007 | *begin |
---|
1008 | *sd tape 2 metres |
---|
1009 | 9 10 6. 031 -07 |
---|
1010 | *end</programlisting> |
---|
1011 | </Para> |
---|
1012 | </listitem> |
---|
1013 | |
---|
1014 | </VarListEntry> |
---|
1015 | |
---|
1016 | <VarListEntry><Term>Description</Term> |
---|
1017 | |
---|
1018 | <listitem><Para>*begin stores the current values of the current settings |
---|
1019 | such as instrument calibration, data format, and so on. |
---|
1020 | These stored values are restored after the corresponding *end. |
---|
1021 | If a survey name is given, this is used inside the *begin/*end block, |
---|
1022 | and the corresponding *end should have the same survey name. |
---|
1023 | *begin/*end blocks may be nested to indefinite depth. |
---|
1024 | </Para></listitem> |
---|
1025 | |
---|
1026 | </VarListEntry> |
---|
1027 | |
---|
1028 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
1029 | |
---|
1030 | <VarListEntry><Term>See Also</Term> |
---|
1031 | |
---|
1032 | <listitem><Para>*end, *prefix</Para></listitem> |
---|
1033 | |
---|
1034 | </VarListEntry> |
---|
1035 | |
---|
1036 | </VariableList> |
---|
1037 | |
---|
1038 | </Sect3> |
---|
1039 | |
---|
1040 | <Sect3><Title>CALIBRATE</Title> |
---|
1041 | |
---|
1042 | <VariableList> |
---|
1043 | |
---|
1044 | <VarListEntry><Term>Syntax</Term> |
---|
1045 | |
---|
1046 | <listitem> |
---|
1047 | <Para>*calibrate <quantity list> <zero error> [<scale>] |
---|
1048 | </Para> |
---|
1049 | <Para>*calibrate <quantity list> <zero error> <units> [<scale>] |
---|
1050 | </Para> |
---|
1051 | <Para>*calibrate default |
---|
1052 | </Para> |
---|
1053 | </listitem> |
---|
1054 | |
---|
1055 | </VarListEntry> |
---|
1056 | |
---|
1057 | <VarListEntry><Term>Example</Term> |
---|
1058 | |
---|
1059 | <listitem> |
---|
1060 | <Para> |
---|
1061 | <programlisting> |
---|
1062 | *calibrate tape +0.3 |
---|
1063 | </programlisting> |
---|
1064 | </Para> |
---|
1065 | </listitem> |
---|
1066 | |
---|
1067 | </VarListEntry> |
---|
1068 | |
---|
1069 | <VarListEntry><Term>Description</Term> |
---|
1070 | |
---|
1071 | <listitem> |
---|
1072 | |
---|
1073 | <Para> |
---|
1074 | *calibrate is used to specify instrument calibrations, via a zero error |
---|
1075 | and a scale factor. By default, the zero error is 0.0 and the scale |
---|
1076 | factor 1.0 for all quantities. |
---|
1077 | </Para> |
---|
1078 | |
---|
1079 | <Para> |
---|
1080 | <quantity> is one of TAPE|COMPASS|CLINO|COUNTER|DEPTH|DECLINATION|X|Y|Z |
---|
1081 | </Para> |
---|
1082 | |
---|
1083 | <Para> |
---|
1084 | Several quantities can be given in <quantity list> - the specified |
---|
1085 | calibration will be applied to each of them. |
---|
1086 | </Para> |
---|
1087 | |
---|
1088 | <Para> |
---|
1089 | You need to be careful about the sign of the ZeroError. Survex follows |
---|
1090 | the convention used with scientific instruments - the ZeroError is what |
---|
1091 | the instrument reads when measuring a reading which should be zero. So |
---|
1092 | for example, if your tape measure has the end missing, and you are using the |
---|
1093 | 30cm mark to take all measurements from, then a zero distance would be measured |
---|
1094 | as 30cm and you would correct this with: |
---|
1095 | </Para> |
---|
1096 | |
---|
1097 | <programlisting>*CALIBRATE tape +0.3</programlisting> |
---|
1098 | |
---|
1099 | <Para>If you tape was too long, starting at -20cm (it does happen!) |
---|
1100 | then you can correct it with: |
---|
1101 | </Para> |
---|
1102 | |
---|
1103 | <programlisting>*CALIBRATE tape -0.2</programlisting> |
---|
1104 | |
---|
1105 | <Para>Note: ZeroError is irrelevant for Topofil counters and depth |
---|
1106 | gauges since pairs of readings are subtracted. |
---|
1107 | </Para> |
---|
1108 | |
---|
1109 | <Para> |
---|
1110 | In the first form in the synopsis above, the zero error is measured by the |
---|
1111 | instrument itself (e.g. reading off the number where a truncated tape now ends) |
---|
1112 | and any scale factor specified applies to it, like so: |
---|
1113 | </Para> |
---|
1114 | |
---|
1115 | <Para> |
---|
1116 | Value = ( Reading - ZeroError ) * Scale (Scale defaults to 1.0) |
---|
1117 | </Para> |
---|
1118 | |
---|
1119 | <Para> |
---|
1120 | In the second form above (supported since Survex 1.2.21), the zero error has |
---|
1121 | been measured externally (e.g. measuring how much too long your tape is with |
---|
1122 | a ruler) - the units of the zero error are explicitly specified and any scale |
---|
1123 | factor isn't applied to it: |
---|
1124 | </Para> |
---|
1125 | |
---|
1126 | <Para> |
---|
1127 | Value = ( Reading * Scale ) - ZeroError (Scale defaults to 1.0) |
---|
1128 | </Para> |
---|
1129 | |
---|
1130 | <Para> |
---|
1131 | If the scale factor is 1.0, then the two forms are equivalent, though they |
---|
1132 | still allow you to differentiate between how the zero error has been determined. |
---|
1133 | </Para> |
---|
1134 | |
---|
1135 | <Para> |
---|
1136 | With older Survex versions, you would specify the magnetic declination |
---|
1137 | (difference between True North and Magnetic North) by using *calibrate |
---|
1138 | declination to set an explicit value (with no scale factor allowed). Since |
---|
1139 | Survex 1.2.22, it's recommended to instead use the new *declination command |
---|
1140 | instead - see the documentation of that command for more details. |
---|
1141 | </Para> |
---|
1142 | |
---|
1143 | </listitem> |
---|
1144 | |
---|
1145 | </VarListEntry> |
---|
1146 | |
---|
1147 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
1148 | |
---|
1149 | <VarListEntry><Term>See Also</Term> |
---|
1150 | |
---|
1151 | <listitem><Para>*declination, *units</Para></listitem> |
---|
1152 | |
---|
1153 | </VarListEntry> |
---|
1154 | |
---|
1155 | </VariableList> |
---|
1156 | |
---|
1157 | </Sect3> |
---|
1158 | |
---|
1159 | <Sect3><Title>CASE</Title> |
---|
1160 | |
---|
1161 | <VariableList> |
---|
1162 | |
---|
1163 | <VarListEntry><Term>Syntax</Term> |
---|
1164 | |
---|
1165 | <listitem><para>*case preserve|toupper|tolower</para></listitem> |
---|
1166 | |
---|
1167 | </VarListEntry> |
---|
1168 | |
---|
1169 | <VarListEntry><Term>Example</Term> |
---|
1170 | |
---|
1171 | <listitem> |
---|
1172 | <Para> |
---|
1173 | <programlisting> |
---|
1174 | *begin bobsbit |
---|
1175 | ; Bob insists on using case sensitive station names |
---|
1176 | *case preserve |
---|
1177 | 1 2 10.23 106 -02 |
---|
1178 | 2 2a 1.56 092 +10 |
---|
1179 | 2 2A 3.12 034 +02 |
---|
1180 | 2 3 8.64 239 -01 |
---|
1181 | *end bobsbit</programlisting> |
---|
1182 | </Para> |
---|
1183 | </listitem> |
---|
1184 | |
---|
1185 | </VarListEntry> |
---|
1186 | |
---|
1187 | <VarListEntry><Term>Description</Term> |
---|
1188 | |
---|
1189 | <listitem><Para>*case determines how the case of letters in survey names is |
---|
1190 | handled. By default all names are forced to lower case (which gives a case |
---|
1191 | insensitive match, but you can tell cavern to force to upper case, or leave |
---|
1192 | the case as is (in which case '2a' and '2A' will be regarded as different). |
---|
1193 | </Para></listitem> |
---|
1194 | |
---|
1195 | </VarListEntry> |
---|
1196 | |
---|
1197 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
1198 | |
---|
1199 | <VarListEntry><Term>See Also</Term> |
---|
1200 | |
---|
1201 | <listitem><Para>*truncate</Para></listitem> |
---|
1202 | |
---|
1203 | </VarListEntry> |
---|
1204 | |
---|
1205 | </VariableList> |
---|
1206 | |
---|
1207 | <!-- FIXME - work this text in here or elsewhere |
---|
1208 | |
---|
1209 | What I mean (though failed to express very well) is that a dataset without |
---|
1210 | this information isn't the same dataset (in general anyway). For example: |
---|
1211 | |
---|
1212 | A1 a2 10.32 140 -05 |
---|
1213 | a2 a3 4.91 041 -01 |
---|
1214 | a1 a3 7.01 206 02 |
---|
1215 | |
---|
1216 | is either a traverse of 3 legs or a (probably badly misclosed) loop. If |
---|
1217 | these names are on the original survey notes, the surveyors ought to say |
---|
1218 | whether "A1" is the same as "a1" (although the usual case for using this |
---|
1219 | feature is probably for importing data from elsewhere). Similarly for |
---|
1220 | truncation. Whether a clino of +/-90 degrees (or +/-100 grad, etc) is |
---|
1221 | interpreted as a plumb is something that should have been noted in the cave |
---|
1222 | (unless it's implicit because it's standard practice for a survey project). |
---|
1223 | |
---|
1224 | It's a similar issue to calibration data in many ways. You can argue it's |
---|
1225 | not part of "the survey", but without it the survey won't be the same shape, |
---|
1226 | and it's not useful to process the same survey with different settings for |
---|
1227 | compass calibration or name case sensitivity. |
---|
1228 | |
---|
1229 | >Clearly that is unhelpfully strict, but it is |
---|
1230 | >important to be semantically clear about what is 'data' and what is 'commands |
---|
1231 | >or meta-data' which describe what to do with/how to interpret that data. |
---|
1232 | |
---|
1233 | Think of the lines starting with a "*" as "command or meta-data". |
---|
1234 | |
---|
1235 | >The most-correct solution to this is (I believe) Martin Heller's idea about |
---|
1236 | >including 'rules' in the datastream, but that's too big a subject for right |
---|
1237 | >now. |
---|
1238 | > |
---|
1239 | >The reason '-C' was made into a command-line option, was that it made very |
---|
1240 | >little sense to change it part way though a dataset. What exactly happens if |
---|
1241 | >you suddenly tell cavern to become case-sensitive halfway through a run? |
---|
1242 | |
---|
1243 | -C has always had 3 settings - "leave case alone", "force to lower", and |
---|
1244 | "force to upper". It doesn't really mean "case sensitivity" but rather |
---|
1245 | something like "case processing". So you can usefully change it during a |
---|
1246 | run. So if my dataset treats "NoTableChamber" (so named because it was |
---|
1247 | lacking in furniture) as different from "NotableChamber" (which was notable |
---|
1248 | for other reasons) I can process it with a dataset from someone else which |
---|
1249 | needs to be treated as case insensitive like so: |
---|
1250 | |
---|
1251 | *begin my_cave |
---|
1252 | *include my_dataset |
---|
1253 | *end my_cave |
---|
1254 | |
---|
1255 | *equate my_cave.NoTableChamber.14 your_cave.linkpassage.13 |
---|
1256 | |
---|
1257 | *begin your_cave |
---|
1258 | *case tolower |
---|
1259 | *include your_dataset |
---|
1260 | *end your_cave |
---|
1261 | |
---|
1262 | You may be thinking of -U<n>, which used to mean "only compare the first n |
---|
1263 | characters of station names", but that doesn't allow arbitrary datasets to |
---|
1264 | be processed together. |
---|
1265 | |
---|
1266 | So we changed it to mean "truncate station names to n characters", and |
---|
1267 | allowed it to be changed at any point, rather than being set once for the |
---|
1268 | whole run. |
---|
1269 | |
---|
1270 | --> |
---|
1271 | |
---|
1272 | </Sect3> |
---|
1273 | |
---|
1274 | <Sect3><Title>COPYRIGHT</Title> |
---|
1275 | |
---|
1276 | <VariableList> |
---|
1277 | |
---|
1278 | <VarListEntry><Term>Syntax</Term> |
---|
1279 | |
---|
1280 | <listitem><Para>*copyright <date> <text></Para></listitem> |
---|
1281 | |
---|
1282 | </VarListEntry> |
---|
1283 | |
---|
1284 | <VarListEntry><Term>Example</Term> |
---|
1285 | |
---|
1286 | <listitem> |
---|
1287 | <Para> |
---|
1288 | <programlisting> |
---|
1289 | *begin littlebit |
---|
1290 | *copyright 1983 CUCC |
---|
1291 | 1 2 10.23 106 -02 |
---|
1292 | 2 3 1.56 092 +10 |
---|
1293 | *end littlebit</programlisting> |
---|
1294 | </Para> |
---|
1295 | </listitem> |
---|
1296 | |
---|
1297 | </VarListEntry> |
---|
1298 | |
---|
1299 | <VarListEntry><Term>Validity</Term> |
---|
1300 | |
---|
1301 | <listitem><Para>valid at the start of a *begin/*end block. |
---|
1302 | </Para></listitem> |
---|
1303 | |
---|
1304 | </VarListEntry> |
---|
1305 | |
---|
1306 | <VarListEntry><Term>Description</Term> |
---|
1307 | |
---|
1308 | <listitem><Para>*copyright allows the copyright information to be |
---|
1309 | stored in a way that can be automatically collated. |
---|
1310 | </Para></listitem> |
---|
1311 | |
---|
1312 | </VarListEntry> |
---|
1313 | |
---|
1314 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
1315 | |
---|
1316 | <VarListEntry><Term>See Also</Term> |
---|
1317 | |
---|
1318 | <listitem><Para>*begin</Para></listitem> |
---|
1319 | |
---|
1320 | </VarListEntry> |
---|
1321 | |
---|
1322 | </VariableList> |
---|
1323 | |
---|
1324 | </Sect3> |
---|
1325 | |
---|
1326 | <Sect3><Title>CS</Title> |
---|
1327 | |
---|
1328 | <VariableList> |
---|
1329 | |
---|
1330 | <VarListEntry><Term>Syntax</Term> |
---|
1331 | |
---|
1332 | <listitem><Para>*cs [out] <coordinate system></Para></listitem> |
---|
1333 | |
---|
1334 | </VarListEntry> |
---|
1335 | |
---|
1336 | <VarListEntry><Term>Example</Term> |
---|
1337 | |
---|
1338 | <listitem> |
---|
1339 | <Para> |
---|
1340 | <programlisting> |
---|
1341 | *cs UTM60S |
---|
1342 | *fix beehive 313800 5427953 20</programlisting> |
---|
1343 | </Para> |
---|
1344 | |
---|
1345 | <Para> |
---|
1346 | <programlisting> |
---|
1347 | ; Output in the coordinate system used in the Totes Gebirge in Austria |
---|
1348 | *cs out custom "+proj=tmerc +lat_0=0 +lon_0=13d20 +k=1 +x_0=0 +y_0=-5200000 +ellps=bessel +towgs84=577.326,90.129,463.919,5.137,1.474,5.297,2.4232"</programlisting> |
---|
1349 | </Para> |
---|
1350 | </listitem> |
---|
1351 | |
---|
1352 | </VarListEntry> |
---|
1353 | |
---|
1354 | <VarListEntry><Term>Description</Term> |
---|
1355 | |
---|
1356 | <listitem><Para>*cs allows the coordinate systems used for fixed points and for |
---|
1357 | processed survey data to be specified. |
---|
1358 | </Para> |
---|
1359 | |
---|
1360 | <Para> |
---|
1361 | *cs was added in Survex 1.2.14, but handling of fixed points specified with |
---|
1362 | latitude and longitude didn't work until 1.2.21. And *fix with standard |
---|
1363 | deviations specified also didn't work until 1.2.21. |
---|
1364 | </Para> |
---|
1365 | |
---|
1366 | <Para> |
---|
1367 | The currently supported coordinate systems are: |
---|
1368 | </Para> |
---|
1369 | |
---|
1370 | <Para>CUSTOM followed by a PROJ4 string (like in the example above).</Para> |
---|
1371 | |
---|
1372 | <Para>EPSG: followed by a positive integer code. EPSG codes cover most |
---|
1373 | coordinate systems in use, and PROJ supports many of these. The website |
---|
1374 | <ulink url="https://epsg.io/">https://epsg.io/</ulink> is a useful resource for |
---|
1375 | finding the EPSG code you want. Supported since Survex 1.2.15.</Para> |
---|
1376 | |
---|
1377 | <Para>ESRI: followed by a positive integer code. ESRI codes are used by |
---|
1378 | ArcGIS to specify coordinate systems (in a similar way to EPSG codes), and PROJ |
---|
1379 | supports many of them. Supported since Survex 1.2.15.</Para> |
---|
1380 | |
---|
1381 | <Para>EUR79Z30 for UTM zone 30, EUR79 datum. Supported since Survex 1.2.15. |
---|
1382 | </Para> |
---|
1383 | |
---|
1384 | <Para>IJTSK for the modified version of the Czechoslovak S-JTSK system where |
---|
1385 | the axes point East and North. Supported since Survex 1.2.15.</Para> |
---|
1386 | |
---|
1387 | <Para>IJTSK03 for a variant of IJTSK. Supported since Survex 1.2.15.</Para> |
---|
1388 | |
---|
1389 | <Para>JTSK for the Czechoslovak S-JTSK system. The axes on this point West |
---|
1390 | and South, so it's not supported as an output coordinate system. |
---|
1391 | Supported since Survex 1.2.16.</Para> |
---|
1392 | |
---|
1393 | <Para>JTSK03 for a variant of JTSK. Supported since Survex 1.2.16.</Para> |
---|
1394 | |
---|
1395 | <Para>LONG-LAT for longitude/latitude. The WGS84 datum is assumed. |
---|
1396 | NB <command>*fix</command> expects the coordinates in the order x,y,z which |
---|
1397 | means longitude (i.e. E/W), then latitude (i.e. N/S), then altitude. |
---|
1398 | Supported since Survex 1.2.15.</Para> |
---|
1399 | |
---|
1400 | <Para>OSGB: followed by a two letter code for the UK Ordnance Survey National |
---|
1401 | Grid. The first letter should be 'H', 'N', 'O', 'S' or 'T'; the second any |
---|
1402 | letter except 'I'. Supported since Survex 1.2.15.</Para> |
---|
1403 | |
---|
1404 | <Para>S-MERC for the "Web Mercator" spherical mercator projection, used by |
---|
1405 | online map sites like OpenStreetMap, Google maps, Bing maps, etc. Supported |
---|
1406 | since Survex 1.2.15. |
---|
1407 | </Para> |
---|
1408 | |
---|
1409 | <Para>UTM followed by a zone number (1-60), optionally followed by "N" or "S" |
---|
1410 | (default is North). The WGS84 datum is assumed.</Para> |
---|
1411 | |
---|
1412 | <Para> |
---|
1413 | By default, Survex works in an unspecified coordinate system (and this was the |
---|
1414 | only option before *cs was added). However, it's useful for coordinate system |
---|
1415 | which the processed survey data is in to be specified if you want to use the |
---|
1416 | processed data in ways which required knowing the coordinate system (such as |
---|
1417 | exporting a list of entrances for use in a GPS). You can now do this by using |
---|
1418 | "*cs out". |
---|
1419 | </Para> |
---|
1420 | |
---|
1421 | <Para> |
---|
1422 | It is also useful to be able to take coordinates for fixed points in whatever |
---|
1423 | coordinate system you receive them in and put them directly into Survex, rather |
---|
1424 | than having to convert with an external tool. For example, you may have your |
---|
1425 | GPS set to show coordinates in UTM with the WGS84 datum, even though you want |
---|
1426 | the processed data to be in some local coordinate system. And someone else |
---|
1427 | may provide GPS coordinates in yet another coordinate system. You just need |
---|
1428 | to set the appropriate coordinate system with "*cs" before each group of "*fix" |
---|
1429 | commands in a particular coordinate system. |
---|
1430 | </Para> |
---|
1431 | |
---|
1432 | <Para> |
---|
1433 | If you're going to make use of "*cs", then the coordinate system must be |
---|
1434 | specified for everything, so a coordinate system must be in effect for all |
---|
1435 | "*fix" commands, and you must set the output coordinate system before any |
---|
1436 | points are fixed. |
---|
1437 | </Para> |
---|
1438 | |
---|
1439 | <Para> |
---|
1440 | Also, if "*cs" is in use, then you can't omit the coordinates in a "*fix" |
---|
1441 | command, and a fixed point won't be invented if none exists. |
---|
1442 | </Para> |
---|
1443 | |
---|
1444 | <Para> |
---|
1445 | If you use "*cs out" more than once, the second and subsequent commands are |
---|
1446 | silently ignored - this makes it possible to combine two datasets with |
---|
1447 | different "*cs out" settings without having to modify either of them. |
---|
1448 | </Para> |
---|
1449 | |
---|
1450 | <Para> |
---|
1451 | Something to be aware of with "*cs" is that altitudes are currently assumed to |
---|
1452 | be "height above the ellipsoid", whereas GPS units typically give you "height |
---|
1453 | above sea level", or more accurately "height above a particular geoid". This |
---|
1454 | is something we're looking at how best to address, but you shouldn't need to |
---|
1455 | worry about it if your fixed points are in the same coordinate system as your |
---|
1456 | output, or if they all use the same ellipsoid. For a more detailed discussion |
---|
1457 | of this, please see: http://expo.survex.com/handbook/survey/coord.htm |
---|
1458 | </Para> |
---|
1459 | </listitem> |
---|
1460 | |
---|
1461 | </VarListEntry> |
---|
1462 | |
---|
1463 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
1464 | |
---|
1465 | <VarListEntry><Term>See Also</Term> |
---|
1466 | |
---|
1467 | <listitem><Para>*fix</Para></listitem> |
---|
1468 | |
---|
1469 | </VarListEntry> |
---|
1470 | |
---|
1471 | </VariableList> |
---|
1472 | |
---|
1473 | </Sect3> |
---|
1474 | <Sect3><Title>DATA</Title> |
---|
1475 | |
---|
1476 | <VariableList> |
---|
1477 | |
---|
1478 | <VarListEntry><Term>Syntax</Term> |
---|
1479 | |
---|
1480 | <listitem> |
---|
1481 | <Para>*data <style> <ordering></Para> |
---|
1482 | <Para>*data</Para> |
---|
1483 | </listitem> |
---|
1484 | |
---|
1485 | <!-- BACKCOMPASS BACKCLINO --> |
---|
1486 | </VarListEntry> |
---|
1487 | |
---|
1488 | <VarListEntry><Term>Example</Term> |
---|
1489 | |
---|
1490 | <listitem> |
---|
1491 | <Para> |
---|
1492 | <programlisting> |
---|
1493 | *data normal from to compass tape clino</programlisting> |
---|
1494 | </Para> |
---|
1495 | |
---|
1496 | <Para> |
---|
1497 | <programlisting> |
---|
1498 | *data normal station ignoreall newline compass tape clino</programlisting> |
---|
1499 | </Para> |
---|
1500 | </listitem> |
---|
1501 | |
---|
1502 | </VarListEntry> |
---|
1503 | |
---|
1504 | <VarListEntry><Term>Description</Term> |
---|
1505 | |
---|
1506 | <listitem><Para> |
---|
1507 | <style> = DEFAULT|NORMAL|DIVING|CARTESIAN|TOPOFIL|CYLPOLAR|NOSURVEY|PASSAGE |
---|
1508 | </Para> |
---|
1509 | |
---|
1510 | <Para> |
---|
1511 | <ordering> = ordered list of instruments - which are valid depends on the |
---|
1512 | style. |
---|
1513 | </Para> |
---|
1514 | |
---|
1515 | <Para> |
---|
1516 | In Survex 1.0.2 and later, TOPOFIL is simply a synonym for NORMAL, left in to |
---|
1517 | allow older data to be processed without modification. Use the name NORMAL |
---|
1518 | by preference. |
---|
1519 | </Para> |
---|
1520 | |
---|
1521 | <Para> |
---|
1522 | There are two variants of each style - interleaved and non-interleaved. |
---|
1523 | Non-interleaved is "one line per leg", interleaved has a line for the data |
---|
1524 | shared between two legs (e.g. STATION=FROM/TO, DEPTH=FROMDEPTH/TODEPTH, |
---|
1525 | COUNT=FROMCOUNT/TOCOUNT). Note that not all interleavable readings have to |
---|
1526 | be interleaved - for example: |
---|
1527 | |
---|
1528 | <programlisting> |
---|
1529 | *data diving station newline fromdepth compass tape todepth</programlisting> |
---|
1530 | |
---|
1531 | In addition, interleaved data can have a DIRECTION reading, which can be "F" |
---|
1532 | for a foresight or "B" for a backsight. |
---|
1533 | </Para> |
---|
1534 | |
---|
1535 | <Para> |
---|
1536 | In NORMAL, DIVING, and CYLPOLAR data styles, TAPE may be replaced by |
---|
1537 | FROMCOUNT/TOCOUNT (or COUNT in interleaved data) to allow processing of surveys |
---|
1538 | performed with a Topofil instead of a tape. |
---|
1539 | </Para> |
---|
1540 | |
---|
1541 | <Para> |
---|
1542 | In Survex 1.2.31 and later, you can use <command>*data</command> without any |
---|
1543 | arguments to keep the currently set data style, but resetting any state. This |
---|
1544 | is useful when you're entering passage tubes with branches - see the description |
---|
1545 | of the "PASSAGE" style below. |
---|
1546 | </Para> |
---|
1547 | |
---|
1548 | <VariableList> |
---|
1549 | |
---|
1550 | <VarListEntry><Term>DEFAULT</Term> |
---|
1551 | <listitem><Para>Select the default data style and ordering (NORMAL style, ordering: from to tape compass clino).</Para></listitem> |
---|
1552 | </VarListEntry> |
---|
1553 | |
---|
1554 | <VarListEntry><Term>NORMAL</Term> |
---|
1555 | <listitem><Para>The usual tape/compass/clino centreline survey. |
---|
1556 | For non-interleaved data the allowed readings are: |
---|
1557 | FROM TO TAPE COMPASS CLINO BACKCOMPASS BACKCLINO; |
---|
1558 | for interleaved data the allowed readings are: |
---|
1559 | STATION DIRECTION TAPE COMPASS CLINO BACKCOMPASS BACKCLINO. |
---|
1560 | The CLINO/BACKCLINO reading is not required - if it's not given, the vertical |
---|
1561 | standard deviation is taken to be proportional to the tape measurement. |
---|
1562 | Alternatively, individual clino readings can be given as OMIT (default "-") |
---|
1563 | which allows for data where only some clino readings are missing. |
---|
1564 | E.g.: |
---|
1565 | |
---|
1566 | <programlisting> |
---|
1567 | *data normal from to compass clino tape |
---|
1568 | 1 2 172 -03 12.61</programlisting> |
---|
1569 | |
---|
1570 | <programlisting> |
---|
1571 | *data normal station newline direction tape compass clino |
---|
1572 | 1 |
---|
1573 | F 12.61 172 -03 |
---|
1574 | 2</programlisting> |
---|
1575 | |
---|
1576 | <programlisting> |
---|
1577 | *data normal from to compass clino fromcount tocount |
---|
1578 | 1 2 172 -03 11532 11873</programlisting> |
---|
1579 | |
---|
1580 | <programlisting> |
---|
1581 | *data normal station count newline direction compass clino |
---|
1582 | 1 11532 |
---|
1583 | F 172 -03 |
---|
1584 | 2 11873</programlisting> |
---|
1585 | |
---|
1586 | </Para></listitem> |
---|
1587 | </VarListEntry> |
---|
1588 | |
---|
1589 | <VarListEntry><Term>DIVING</Term> |
---|
1590 | <listitem><Para> |
---|
1591 | An underwater survey where the vertical information is from a diver's depth |
---|
1592 | gauge. This style can also be also used for an above-water survey where the |
---|
1593 | altitude is measured with an altimeter. DEPTH is defined as the altitude (Z) |
---|
1594 | so increases upwards by default. So for a diver's depth gauge, you'll need to |
---|
1595 | use *CALIBRATE with a negative scale factor (e.g. *calibrate depth 0 -1). |
---|
1596 | </Para> |
---|
1597 | |
---|
1598 | <Para>For non-interleaved data the allowed readings are: |
---|
1599 | FROM TO TAPE COMPASS CLINO BACKCOMPASS BACKCLINO FROMDEPTH TODEPTH DEPTHCHANGE (the vertical |
---|
1600 | can be given as readings at each station, (FROMDEPTH/TODEPTH) or as a change |
---|
1601 | along the leg (DEPTHCHANGE)).</Para> |
---|
1602 | |
---|
1603 | <Para>Survex 1.2.20 and later allow an optional CLINO and/or BACKCLINO reading |
---|
1604 | in DIVING style. At present these extra readings are checked for syntactic |
---|
1605 | validity, but are otherwise ignored. The intention is that a future version |
---|
1606 | will check them against the other readings to flag up likely blunders, and |
---|
1607 | average with the slope data from the depth gauge and tape reading.</Para> |
---|
1608 | |
---|
1609 | <Para>For interleaved data the allowed readings are: |
---|
1610 | STATION DIRECTION TAPE COMPASS BACKCOMPASS DEPTH DEPTHCHANGE. |
---|
1611 | (the vertical change can be given as a reading at the station (DEPTH) or as a change along the leg (DEPTHCHANGE)). |
---|
1612 | |
---|
1613 | <programlisting> |
---|
1614 | *data diving from to tape compass fromdepth todepth |
---|
1615 | 1 2 14.7 250 -20.7 -22.4</programlisting> |
---|
1616 | |
---|
1617 | <programlisting> |
---|
1618 | *data diving station depth newline tape compass |
---|
1619 | 1 -20.7 |
---|
1620 | 14.7 250 |
---|
1621 | 2 -22.4</programlisting> |
---|
1622 | |
---|
1623 | <programlisting> |
---|
1624 | *data diving from to tape compass depthchange |
---|
1625 | 1 2 14.7 250 -1.7</programlisting> |
---|
1626 | </Para> |
---|
1627 | </listitem> |
---|
1628 | </VarListEntry> |
---|
1629 | |
---|
1630 | <VarListEntry><Term>CARTESIAN</Term> |
---|
1631 | <listitem><Para> |
---|
1632 | Cartesian data style allows you to specify the (x,y,z) changes between |
---|
1633 | stations. It's useful for digitising surveys where the original survey |
---|
1634 | data has been lost and all that's available is a drawn up version. |
---|
1635 | |
---|
1636 | <programlisting> |
---|
1637 | *data cartesian from to northing easting altitude |
---|
1638 | 1 2 16.1 20.4 8.7</programlisting> |
---|
1639 | |
---|
1640 | <programlisting> |
---|
1641 | *data cartesian station newline northing easting altitude |
---|
1642 | 1 |
---|
1643 | 16.1 20.4 8.7 |
---|
1644 | 2</programlisting> |
---|
1645 | |
---|
1646 | <!--FIXME: dx dy dz--> |
---|
1647 | </Para> |
---|
1648 | |
---|
1649 | <Note><Para> |
---|
1650 | Cartesian data are relative to <emphasis>true</emphasis> North not |
---|
1651 | <emphasis>magnetic</emphasis> North (i.e. they are unaffected by |
---|
1652 | <command>*calibrate declination</command>). |
---|
1653 | </Para></Note> |
---|
1654 | </listitem> |
---|
1655 | </VarListEntry> |
---|
1656 | |
---|
1657 | <VarListEntry><Term>CYLPOLAR</Term> |
---|
1658 | <listitem><Para> |
---|
1659 | A CYLPOLAR style survey is very similar to a diving survey, except that the tape |
---|
1660 | is always measured horizontally rather than along the slope of the leg. |
---|
1661 | |
---|
1662 | <programlisting> |
---|
1663 | *data cypolar from to tape compass fromdepth todepth |
---|
1664 | 1 2 9.45 311 -13.3 -19.0</programlisting> |
---|
1665 | |
---|
1666 | <programlisting> |
---|
1667 | *data cylpolar station depth newline tape compass |
---|
1668 | 1 -13.3 |
---|
1669 | 9.45 311 |
---|
1670 | 2 -19.0</programlisting> |
---|
1671 | |
---|
1672 | <programlisting> |
---|
1673 | *data cylpolar from to tape compass depthchange |
---|
1674 | 1 2 9.45 311 -5.7</programlisting> |
---|
1675 | </Para></listitem> |
---|
1676 | </VarListEntry> |
---|
1677 | |
---|
1678 | <VarListEntry><Term>NOSURVEY</Term> |
---|
1679 | <listitem><Para> |
---|
1680 | A NOSURVEY survey doesn't have any measurements - it merely indicates that |
---|
1681 | there is line of sight between the pairs of stations. |
---|
1682 | |
---|
1683 | <programlisting> |
---|
1684 | *data nosurvey from to |
---|
1685 | 1 7 |
---|
1686 | 5 7 |
---|
1687 | 9 11</programlisting> |
---|
1688 | |
---|
1689 | <programlisting> |
---|
1690 | *data nosurvey station |
---|
1691 | 1 |
---|
1692 | 7 |
---|
1693 | 5 |
---|
1694 | |
---|
1695 | *data nosurvey station |
---|
1696 | 9 |
---|
1697 | 11</programlisting> |
---|
1698 | </Para></listitem> |
---|
1699 | </VarListEntry> |
---|
1700 | |
---|
1701 | <VarListEntry><Term>PASSAGE</Term> |
---|
1702 | <listitem><Para> |
---|
1703 | This survey style defines a 3D "tube" modelling a passage in the cave. |
---|
1704 | The tube uses the survey stations listed in the order listed. It's |
---|
1705 | permitted to use survey stations which aren't directly linked by |
---|
1706 | the centre-line survey. This can be useful - sometimes the centreline |
---|
1707 | will step sideways or up/down to allow a better sight for the next |
---|
1708 | leg and you can ignore the extra station. You can also define tubes |
---|
1709 | along unsurveyed passages, akin to "nosurvey" legs in the centreline |
---|
1710 | data.</Para> |
---|
1711 | |
---|
1712 | <Para>This means that you need to split off side passages into seperate |
---|
1713 | tubes, and hence separate sections of passage data, starting with |
---|
1714 | a new *data command.</Para> |
---|
1715 | |
---|
1716 | <Para> |
---|
1717 | Simple example of how to use this data style (note the use of ignoreall |
---|
1718 | to allow a free-form text description to be given): |
---|
1719 | |
---|
1720 | <programlisting> |
---|
1721 | *data passage station left right up down ignoreall |
---|
1722 | 1 0.1 2.3 8.0 1.4 Sticking out point on left wall |
---|
1723 | 2 0.0 1.9 9.0 0.5 Point on left wall |
---|
1724 | 3 1.0 0.7 9.0 0.8 Highest point of boulder |
---|
1725 | </programlisting> |
---|
1726 | |
---|
1727 | Each <command>*data passage</command> data block describes a single continuous |
---|
1728 | tube - to break a tube or to enter a side passage you need to have a second |
---|
1729 | block. With Survex 1.2.30 and older, you had to repeat the entire |
---|
1730 | <command>*data passage</command> line to start a new tube, but in Survex 1.2.31 |
---|
1731 | and later, you can just use <command>*data</command> without any arguments. |
---|
1732 | </Para> |
---|
1733 | |
---|
1734 | <Para> |
---|
1735 | For example here the main passage is 1-2-3 and a side passage is 2-4: |
---|
1736 | |
---|
1737 | <programlisting> |
---|
1738 | *data passage station left right up down ignoreall |
---|
1739 | 1 0.1 2.3 8.0 1.4 Sticking out point on left wall |
---|
1740 | 2 0.0 1.9 9.0 0.5 Point on left wall opposite side passage |
---|
1741 | 3 1.0 0.7 9.0 0.8 Highest point of boulder |
---|
1742 | ; If you're happy to require Survex 1.2.31 or later, you can just use |
---|
1743 | ; "*data" here instead. |
---|
1744 | *data passage station left right up down ignoreall |
---|
1745 | 2 0.3 0.2 9.0 0.5 |
---|
1746 | 4 0.0 0.5 6.5 1.5 Fossil on left wall |
---|
1747 | </programlisting> |
---|
1748 | </Para> |
---|
1749 | </listitem> |
---|
1750 | </VarListEntry> |
---|
1751 | </VariableList> |
---|
1752 | |
---|
1753 | <Para> |
---|
1754 | IGNORE skips a field (it may be used any number of times), |
---|
1755 | and IGNOREALL may be used last to ignore the rest of the data line. |
---|
1756 | </Para> |
---|
1757 | |
---|
1758 | <Para> |
---|
1759 | LENGTH is a synonym for TAPE; BEARING for COMPASS; GRADIENT for CLINO; COUNT for COUNTER.<!--FIXME : others?--> |
---|
1760 | </Para> |
---|
1761 | |
---|
1762 | <Para> |
---|
1763 | The units of each quantity may be set with the UNITS command. |
---|
1764 | </Para> |
---|
1765 | |
---|
1766 | <!-- FIXME: plumbed diving legs --> |
---|
1767 | |
---|
1768 | <!--FIXME: |
---|
1769 | <Para> |
---|
1770 | Uses for CYLPOLAR: |
---|
1771 | Perhaps a Grade 3 survey, or when surveying with a level and stick (?) |
---|
1772 | [note - UBSS use it for the old County Clare data] |
---|
1773 | </Para> |
---|
1774 | --> |
---|
1775 | |
---|
1776 | </listitem> |
---|
1777 | |
---|
1778 | </VarListEntry> |
---|
1779 | |
---|
1780 | </VariableList> |
---|
1781 | |
---|
1782 | </Sect3> |
---|
1783 | |
---|
1784 | <Sect3><Title>DATE</Title> |
---|
1785 | <VariableList> |
---|
1786 | |
---|
1787 | <VarListEntry><Term>Syntax</Term> |
---|
1788 | |
---|
1789 | <listitem><Para>*date <year>[.<month>[.<day>]][-<year>[.<month>[.<day>]]]</Para></listitem> |
---|
1790 | |
---|
1791 | </VarListEntry> |
---|
1792 | |
---|
1793 | <VarListEntry><Term>Example</Term> |
---|
1794 | |
---|
1795 | <listitem> |
---|
1796 | <Para> |
---|
1797 | <programlisting> |
---|
1798 | *date 2001</programlisting> |
---|
1799 | |
---|
1800 | <programlisting> |
---|
1801 | *date 2000.10</programlisting> |
---|
1802 | |
---|
1803 | <programlisting> |
---|
1804 | *date 1987.07.27</programlisting> |
---|
1805 | |
---|
1806 | <programlisting> |
---|
1807 | *date 1985.08.12-1985.08.13</programlisting> |
---|
1808 | </Para> |
---|
1809 | </listitem> |
---|
1810 | |
---|
1811 | </VarListEntry> |
---|
1812 | |
---|
1813 | <VarListEntry><Term>Validity</Term> |
---|
1814 | |
---|
1815 | <listitem><Para>valid at the start of a *begin/*end block. |
---|
1816 | </Para></listitem> |
---|
1817 | |
---|
1818 | </VarListEntry> |
---|
1819 | |
---|
1820 | <VarListEntry><Term>Description</Term> |
---|
1821 | |
---|
1822 | <listitem><Para> |
---|
1823 | *date specifies the date that the survey was done. A range of dates |
---|
1824 | can be specified (useful for overnight or multi-day surveying trips). |
---|
1825 | </Para></listitem> |
---|
1826 | |
---|
1827 | </VarListEntry> |
---|
1828 | |
---|
1829 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
1830 | |
---|
1831 | <VarListEntry><Term>See Also</Term> |
---|
1832 | |
---|
1833 | <listitem><Para>*begin, *instrument, *team</Para></listitem> |
---|
1834 | |
---|
1835 | </VarListEntry> |
---|
1836 | |
---|
1837 | </VariableList> |
---|
1838 | |
---|
1839 | </Sect3> |
---|
1840 | |
---|
1841 | <Sect3><Title>DECLINATION</Title> |
---|
1842 | |
---|
1843 | <VariableList> |
---|
1844 | |
---|
1845 | <VarListEntry><Term>Syntax</Term> |
---|
1846 | |
---|
1847 | <listitem> |
---|
1848 | <Para>*declination <auto> <x> <y> <z></Para> |
---|
1849 | <Para>*declination <declination> <units></Para> |
---|
1850 | </listitem> |
---|
1851 | |
---|
1852 | </VarListEntry> |
---|
1853 | |
---|
1854 | <VarListEntry><Term>Description</Term> |
---|
1855 | |
---|
1856 | <listitem> |
---|
1857 | |
---|
1858 | <Para> |
---|
1859 | The *declination command is the modern way to specify magnetic declinations in |
---|
1860 | Survex. Prior to 1.2.22, *calibrate declination was used instead. If you |
---|
1861 | use a mixture of *calibrate declination and *declination, they interact in |
---|
1862 | the natural way - whichever was set most recently is used for each compass |
---|
1863 | reading (taking into account survey scope). We don't generally recommend |
---|
1864 | mixing the two, but it's useful to understand how they interact if you want to |
---|
1865 | combine datasets using the old and new commands, and perhaps if you have a |
---|
1866 | large existing dataset and want to migrate it without having to change |
---|
1867 | everything at once. |
---|
1868 | </Para> |
---|
1869 | |
---|
1870 | <Para> |
---|
1871 | Magnetic declination is the difference between Magnetic North and True North. |
---|
1872 | It varies both with location and over time. Compass bearings are measured |
---|
1873 | relative to Magnetic North - adding the magnetic declination gives bearings |
---|
1874 | relative to True North. |
---|
1875 | </Para> |
---|
1876 | |
---|
1877 | <Para> |
---|
1878 | If you have specified the output coordinate system (using *cs out) then you can |
---|
1879 | use *declination auto (and we recommend that you do). This is supported since |
---|
1880 | Survex 1.2.21 and automatically calculates magnetic declinations based on the |
---|
1881 | IGRF (International Geomagnetic Reference Field) model for the specified date |
---|
1882 | of each survey and at the specified representative location (given in the |
---|
1883 | current input coordinate system, as set with *cs). Survex 1.2.27 and |
---|
1884 | later also automatically correct for grid convergence (the difference between |
---|
1885 | Grid North and True North) when *declination auto is in use, based on the same |
---|
1886 | specified representative location. |
---|
1887 | </Para> |
---|
1888 | |
---|
1889 | <Para> |
---|
1890 | You might wonder why Survex needs a representative location instead of |
---|
1891 | calculating the magnetic declination and grid convergence for the actual |
---|
1892 | position of each survey station. The reason is that we need to adjust the |
---|
1893 | compass bearings before we can solve the network to find survey station |
---|
1894 | locations. Both magnetic declination and grid convergence don't generally vary |
---|
1895 | significantly over the area of a typical cave system - if you are mapping a |
---|
1896 | very large cave system, or caves over a wide area, or are working close to a |
---|
1897 | magnetic pole or where the output coordinate system is rather distorted, then |
---|
1898 | you can specify *declination auto several times with different locations - the |
---|
1899 | one currently in effect is used for each survey leg. |
---|
1900 | </Para> |
---|
1901 | |
---|
1902 | <Para> |
---|
1903 | Generally it's best to specify a suitable output coordinate system, and use |
---|
1904 | *declination auto so Survex corrects for magnetic declination and grid |
---|
1905 | convergence for you. Then Aven knows how to translate coordinates to allow |
---|
1906 | export to formats such as GPX and KML, and to overlay terrain data. |
---|
1907 | </Para> |
---|
1908 | |
---|
1909 | <Para> |
---|
1910 | If you don't specify an output coordinate system, but fix one or more points |
---|
1911 | then Survex works implicitly in the coordinate system your fixed points were |
---|
1912 | specified in. This mode of operation is provided for compatibility with |
---|
1913 | datasets from before support for explicit coordinate systems was added to |
---|
1914 | Survex - it's much better to specify the output coordinate system as above. |
---|
1915 | But if you have a survey of a cave which isn't connected to any known fixed |
---|
1916 | points then you'll need to handle it this way, either fixing an entrance |
---|
1917 | to some arbitrary coordinates (probably (0,0,0)) or letting Survex pick a |
---|
1918 | station as the origin. If the survey was all done in a short enough period |
---|
1919 | of time that the magnetic declination won't have changed significantly, you |
---|
1920 | can just ignore it and Grid North in the implicit coordinate system will be |
---|
1921 | Magnetic North at the time of the survey. If you want to correct for magnetic |
---|
1922 | declination, you can't use *declination auto because the IGRF model needs the |
---|
1923 | real world coordinates, but you can specify literal declination values for each |
---|
1924 | survey using *declination <declination> <units>. Then Grid North |
---|
1925 | in the implicit coordinate system is True North. |
---|
1926 | </Para> |
---|
1927 | |
---|
1928 | <Para> |
---|
1929 | Note that the value specified uses the conventional sign for magnetic |
---|
1930 | declination, unlike the old *calibrate declination which needed a value with |
---|
1931 | the opposite sign (because *calibrate specifies a zero error), so take care |
---|
1932 | when updating old data, or if you're used to the semantics of *calibrate |
---|
1933 | declination. |
---|
1934 | </Para> |
---|
1935 | |
---|
1936 | </listitem> |
---|
1937 | |
---|
1938 | </VarListEntry> |
---|
1939 | |
---|
1940 | <VarListEntry><Term>See Also</Term> |
---|
1941 | |
---|
1942 | <listitem><Para>*calibrate</Para></listitem> |
---|
1943 | |
---|
1944 | </VarListEntry> |
---|
1945 | |
---|
1946 | </VariableList> |
---|
1947 | |
---|
1948 | </Sect3> |
---|
1949 | |
---|
1950 | <Sect3><Title>DEFAULT</Title> |
---|
1951 | |
---|
1952 | <VariableList> |
---|
1953 | |
---|
1954 | <VarListEntry><Term>Syntax</Term> |
---|
1955 | |
---|
1956 | <listitem><Para>*default <settings list>|all</Para></listitem> |
---|
1957 | |
---|
1958 | </VarListEntry> |
---|
1959 | |
---|
1960 | <VarListEntry><Term>Description</Term> |
---|
1961 | |
---|
1962 | <listitem><Para> |
---|
1963 | The valid settings are CALIBRATE, DATA, and UNITS. |
---|
1964 | </Para> |
---|
1965 | |
---|
1966 | <Para> |
---|
1967 | *default restores defaults for given settings. This command is deprecated - |
---|
1968 | you should instead use: *calibrate default, *data default, *units default. |
---|
1969 | </Para></listitem> |
---|
1970 | |
---|
1971 | </VarListEntry> |
---|
1972 | |
---|
1973 | <VarListEntry><Term>See Also</Term> |
---|
1974 | |
---|
1975 | <listitem><Para>*calibrate, *data, *units</Para></listitem> |
---|
1976 | |
---|
1977 | </VarListEntry> |
---|
1978 | |
---|
1979 | </VariableList> |
---|
1980 | |
---|
1981 | </Sect3> |
---|
1982 | |
---|
1983 | <Sect3><Title>END</Title> |
---|
1984 | |
---|
1985 | <VariableList> |
---|
1986 | |
---|
1987 | <VarListEntry><Term>Syntax</Term> |
---|
1988 | |
---|
1989 | <listitem><Para>*end [<survey>]</Para></listitem> |
---|
1990 | |
---|
1991 | </VarListEntry> |
---|
1992 | |
---|
1993 | <VarListEntry><Term>Validity</Term> |
---|
1994 | |
---|
1995 | <listitem><Para>valid for closing a block started by *begin in the same file. |
---|
1996 | </Para></listitem> |
---|
1997 | |
---|
1998 | </VarListEntry> |
---|
1999 | |
---|
2000 | <VarListEntry><Term>Description</Term> |
---|
2001 | |
---|
2002 | <listitem><Para> |
---|
2003 | Closes a block started by *begin. |
---|
2004 | </Para></listitem> |
---|
2005 | |
---|
2006 | </VarListEntry> |
---|
2007 | |
---|
2008 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
2009 | |
---|
2010 | <VarListEntry><Term>See Also</Term> |
---|
2011 | |
---|
2012 | <listitem><Para>*begin</Para></listitem> |
---|
2013 | |
---|
2014 | </VarListEntry> |
---|
2015 | |
---|
2016 | </VariableList> |
---|
2017 | |
---|
2018 | </Sect3> |
---|
2019 | |
---|
2020 | <Sect3><Title>ENTRANCE</Title> |
---|
2021 | |
---|
2022 | <VariableList> |
---|
2023 | |
---|
2024 | <VarListEntry><Term>Syntax</Term> |
---|
2025 | |
---|
2026 | <listitem><Para>*entrance <station></Para></listitem> |
---|
2027 | |
---|
2028 | </VarListEntry> |
---|
2029 | |
---|
2030 | <VarListEntry><Term>Example</Term> |
---|
2031 | |
---|
2032 | <listitem> |
---|
2033 | <Para> |
---|
2034 | <programlisting> |
---|
2035 | *entrance P163</programlisting> |
---|
2036 | </Para> |
---|
2037 | </listitem> |
---|
2038 | |
---|
2039 | </VarListEntry> |
---|
2040 | |
---|
2041 | <VarListEntry><Term>Description</Term> |
---|
2042 | |
---|
2043 | <listitem><Para> |
---|
2044 | *entrance sets the <emphasis>entrance</emphasis> flag for a station. |
---|
2045 | This information is used by aven to allow entrances to be highlighted. |
---|
2046 | </Para> |
---|
2047 | |
---|
2048 | <!-- FIXME: |
---|
2049 | (could be inferred from surface/ug join, but better to specify because |
---|
2050 | of caves with no surf svy (or no underground survey) |
---|
2051 | and also situations in which multiple surveys leave through an entrance) |
---|
2052 | --> |
---|
2053 | </listitem> |
---|
2054 | |
---|
2055 | </VarListEntry> |
---|
2056 | |
---|
2057 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
2058 | |
---|
2059 | <!-- <VarListEntry><Term>See Also</Term> |
---|
2060 | |
---|
2061 | <listitem><Para></Para></listitem> |
---|
2062 | |
---|
2063 | </VarListEntry> |
---|
2064 | --> |
---|
2065 | |
---|
2066 | </VariableList> |
---|
2067 | |
---|
2068 | </Sect3> |
---|
2069 | |
---|
2070 | <Sect3><Title>EQUATE</Title> |
---|
2071 | |
---|
2072 | <VariableList> |
---|
2073 | |
---|
2074 | <VarListEntry><Term>Syntax</Term> |
---|
2075 | |
---|
2076 | <listitem><Para>*equate <station> <station>...</Para></listitem> |
---|
2077 | |
---|
2078 | </VarListEntry> |
---|
2079 | |
---|
2080 | <VarListEntry><Term>Example</Term> |
---|
2081 | |
---|
2082 | <listitem> |
---|
2083 | <Para> |
---|
2084 | <programlisting> |
---|
2085 | *equate chosspot.1 triassic.27</programlisting> |
---|
2086 | </Para> |
---|
2087 | </listitem> |
---|
2088 | |
---|
2089 | </VarListEntry> |
---|
2090 | |
---|
2091 | <VarListEntry><Term>Description</Term> |
---|
2092 | |
---|
2093 | <listitem><Para> |
---|
2094 | *equate specifies that the station names in the list refer to the |
---|
2095 | same physical survey station. An error is given if there is only one station |
---|
2096 | listed. |
---|
2097 | </Para> |
---|
2098 | |
---|
2099 | <!-- FIXME: |
---|
2100 | <Para> |
---|
2101 | I think this is preferable to using: |
---|
2102 | </Para> |
---|
2103 | |
---|
2104 | <programlisting> a b 0.00 0 0</programlisting> |
---|
2105 | |
---|
2106 | <Para> |
---|
2107 | as EQUATE does not add in an extra position error. It is also clearer than |
---|
2108 | substituting in the original name wherever passages are linked. If you |
---|
2109 | disagree, you can always use one of the other methods! |
---|
2110 | </Para> |
---|
2111 | --> |
---|
2112 | </listitem> |
---|
2113 | |
---|
2114 | </VarListEntry> |
---|
2115 | |
---|
2116 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
2117 | |
---|
2118 | <VarListEntry><Term>See Also</Term> |
---|
2119 | |
---|
2120 | <listitem><Para>*infer equates</Para></listitem> |
---|
2121 | |
---|
2122 | </VarListEntry> |
---|
2123 | |
---|
2124 | </VariableList> |
---|
2125 | |
---|
2126 | </Sect3> |
---|
2127 | |
---|
2128 | <Sect3><Title>EXPORT</Title> |
---|
2129 | |
---|
2130 | <VariableList> |
---|
2131 | |
---|
2132 | <VarListEntry><Term>Syntax</Term> |
---|
2133 | |
---|
2134 | <listitem><Para>*export <station>...</Para></listitem> |
---|
2135 | |
---|
2136 | </VarListEntry> |
---|
2137 | |
---|
2138 | <VarListEntry><Term>Example</Term> |
---|
2139 | |
---|
2140 | <!-- FIXME better example --> |
---|
2141 | <listitem> |
---|
2142 | <Para> |
---|
2143 | <programlisting> |
---|
2144 | *export 1 6 17</programlisting> |
---|
2145 | </Para> |
---|
2146 | </listitem> |
---|
2147 | |
---|
2148 | </VarListEntry> |
---|
2149 | |
---|
2150 | <VarListEntry><Term>Validity</Term> |
---|
2151 | |
---|
2152 | <listitem><Para>valid at the start of a *begin/*end block. |
---|
2153 | </Para></listitem> |
---|
2154 | |
---|
2155 | </VarListEntry> |
---|
2156 | |
---|
2157 | <VarListEntry><Term>Description</Term> |
---|
2158 | |
---|
2159 | <listitem><Para> |
---|
2160 | *export marks the stations named as referable to from the enclosing |
---|
2161 | survey. To be able to refer to a station from a survey several levels |
---|
2162 | above, it must be exported from each enclosing survey. |
---|
2163 | </Para> |
---|
2164 | |
---|
2165 | <!-- FIXME: |
---|
2166 | <Para> |
---|
2167 | I think this is preferable to using: |
---|
2168 | </Para> |
---|
2169 | |
---|
2170 | <programlisting> a b 0.00 0 0</programlisting> |
---|
2171 | |
---|
2172 | <Para> |
---|
2173 | as EQUATE does not add in an extra position error. It is also clearer than |
---|
2174 | substituting in the original name wherever passages are linked. If you |
---|
2175 | disagree, you can always use one of the other methods! |
---|
2176 | </Para> |
---|
2177 | --> |
---|
2178 | </listitem> |
---|
2179 | |
---|
2180 | </VarListEntry> |
---|
2181 | |
---|
2182 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
2183 | |
---|
2184 | <VarListEntry><Term>See Also</Term> |
---|
2185 | |
---|
2186 | <listitem><Para>*begin, *infer exports</Para></listitem> |
---|
2187 | |
---|
2188 | </VarListEntry> |
---|
2189 | |
---|
2190 | </VariableList> |
---|
2191 | |
---|
2192 | </Sect3> |
---|
2193 | |
---|
2194 | <Sect3><Title>FIX</Title> |
---|
2195 | |
---|
2196 | <VariableList> |
---|
2197 | |
---|
2198 | <VarListEntry><Term>Syntax</Term> |
---|
2199 | |
---|
2200 | <listitem><Para>*fix <station> [reference] |
---|
2201 | [ <x> <y> <z> |
---|
2202 | [ <x std err> <y std err> <z std err> |
---|
2203 | [ <cov(x,y)> <cov(y,z)> <cov(z,x)> ] ] ] |
---|
2204 | </Para></listitem> |
---|
2205 | |
---|
2206 | </VarListEntry> |
---|
2207 | |
---|
2208 | <VarListEntry><Term>Example</Term> |
---|
2209 | |
---|
2210 | <listitem> |
---|
2211 | <Para> |
---|
2212 | <programlisting> |
---|
2213 | *fix entrance.0 32768 86723 1760</programlisting> |
---|
2214 | |
---|
2215 | <programlisting> |
---|
2216 | *fix KT114_96 reference 36670.37 83317.43 1903.97</programlisting> |
---|
2217 | </Para> |
---|
2218 | </listitem> |
---|
2219 | |
---|
2220 | </VarListEntry> |
---|
2221 | |
---|
2222 | <VarListEntry><Term>Description</Term> |
---|
2223 | |
---|
2224 | <listitem> |
---|
2225 | <Para> |
---|
2226 | *fix fixes the position of <station> at the given coordinates. |
---|
2227 | If you haven't specified the coordinate system with "*cs", you can |
---|
2228 | omit the position and it will default to (0,0,0). The standard errors default |
---|
2229 | to zero (fix station exactly). cavern will give an error if you attempt to fix |
---|
2230 | the same survey station twice at different coordinates, or a warning if you fix |
---|
2231 | it twice with matching coordinates. |
---|
2232 | </Para> |
---|
2233 | |
---|
2234 | <Para> |
---|
2235 | You can also specify just one standard error (in which case it is assumed |
---|
2236 | equal in X, Y, and Z) or two (in which case the first is taken as the |
---|
2237 | standard error in X and Y, and the second as the standard error in Z). |
---|
2238 | </Para> |
---|
2239 | |
---|
2240 | <Para> |
---|
2241 | If you have covariances for the fix, you can also specify these - the |
---|
2242 | order is cov(x,y) cov(y,z) cov(z,x). |
---|
2243 | </Para> |
---|
2244 | |
---|
2245 | <Para> |
---|
2246 | If you've specified a coordinate system (see <command>*cs</command>) then |
---|
2247 | that determines the meaning of X, Y and Z (if you want to specify the |
---|
2248 | units for altitude, note that using a PROJ string containing |
---|
2249 | <command>+vunits</command> allows this - e.g. <command>+vunits=us-ft</command> |
---|
2250 | for US survey feet). If you don't specify a coordinate system, then the |
---|
2251 | coordinates must be in metres. The standard deviations must always be |
---|
2252 | in metres (and the covariances in metres squared). |
---|
2253 | </Para> |
---|
2254 | |
---|
2255 | <Para> |
---|
2256 | You can fix as many stations as you like - just use a *fix command for each |
---|
2257 | one. Cavern will check that all stations are connected to |
---|
2258 | at least one fixed point so that co-ordinates can be calculated for all |
---|
2259 | stations. |
---|
2260 | </Para> |
---|
2261 | |
---|
2262 | <Para> |
---|
2263 | By default cavern will warn about stations which have been FIX-ed but |
---|
2264 | not used otherwise, as this might be due to a typo in the station |
---|
2265 | name. This is unhelpful if you want to include a standard file of benchmarks, |
---|
2266 | some of which won't be used. In this sort of situation, specify "REFERENCE" |
---|
2267 | after the station name in the FIX command to suppress this warning for a |
---|
2268 | particular station. |
---|
2269 | </Para> |
---|
2270 | |
---|
2271 | <Note><Para> |
---|
2272 | X is Easting, Y is Northing, and Z is altitude. This convention was chosen |
---|
2273 | since on a map, the horizontal (X) axis is usually East, and the vertical |
---|
2274 | axis (Y) North. The choice of altitude (rather than depth) for Z is taken |
---|
2275 | from surface maps, and makes for less confusion when dealing with cave |
---|
2276 | systems with more than one entrance. It also gives a right-handed |
---|
2277 | set of axes. |
---|
2278 | </Para></Note> |
---|
2279 | |
---|
2280 | </listitem> |
---|
2281 | </VarListEntry> |
---|
2282 | |
---|
2283 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
2284 | |
---|
2285 | <!-- <VarListEntry><Term>See Also</Term> |
---|
2286 | |
---|
2287 | <listitem><Para></Para></listitem> |
---|
2288 | |
---|
2289 | </VarListEntry> |
---|
2290 | --> |
---|
2291 | |
---|
2292 | </VariableList> |
---|
2293 | |
---|
2294 | </Sect3> |
---|
2295 | |
---|
2296 | <!-- |
---|
2297 | <Sect3><Title></Title> |
---|
2298 | |
---|
2299 | <VariableList> |
---|
2300 | |
---|
2301 | <VarListEntry><Term>Syntax</Term> |
---|
2302 | |
---|
2303 | <listitem><Para>*</Para></listitem> |
---|
2304 | |
---|
2305 | </VarListEntry> |
---|
2306 | |
---|
2307 | <VarListEntry><Term>Example</Term> |
---|
2308 | |
---|
2309 | <listitem> |
---|
2310 | <Para> |
---|
2311 | <programlisting> |
---|
2312 | *</programlisting> |
---|
2313 | </Para> |
---|
2314 | </listitem> |
---|
2315 | |
---|
2316 | </VarListEntry> |
---|
2317 | |
---|
2318 | <VarListEntry><Term>Description</Term> |
---|
2319 | |
---|
2320 | <listitem><Para> |
---|
2321 | </Para></listitem> |
---|
2322 | |
---|
2323 | </VarListEntry> |
---|
2324 | |
---|
2325 | <VarListEntry><Term>Caveats </Term> </VarListEntry> |
---|
2326 | |
---|
2327 | <VarListEntry><Term>See Also</Term> |
---|
2328 | |
---|
2329 | <listitem><Para></Para></listitem> |
---|
2330 | |
---|
2331 | </VarListEntry> |
---|
2332 | |
---|
2333 | </VariableList> |
---|
2334 | |
---|
2335 | </Sect3> |
---|
2336 | --> |
---|
2337 | |
---|
2338 | <Sect3><Title>FLAGS</Title> |
---|
2339 | |
---|
2340 | <VariableList> |
---|
2341 | |
---|
2342 | <VarListEntry><Term>Syntax</Term> |
---|
2343 | |
---|
2344 | <listitem><Para>*flags <flags></Para></listitem> |
---|
2345 | |
---|
2346 | </VarListEntry> |
---|
2347 | |
---|
2348 | <VarListEntry><Term>Example</Term> |
---|
2349 | |
---|
2350 | <listitem> |
---|
2351 | <Para> |
---|
2352 | <programlisting> |
---|
2353 | *flags duplicate not surface</programlisting> |
---|
2354 | </Para> |
---|
2355 | </listitem> |
---|
2356 | |
---|
2357 | </VarListEntry> |
---|
2358 | |
---|
2359 | <VarListEntry><Term>Description</Term> |
---|
2360 | |
---|
2361 | <listitem><Para> |
---|
2362 | *flags updates the current flag settings. |
---|
2363 | Flags not mentioned retain their previous state. Valid flags |
---|
2364 | are DUPLICATE, SPLAY, and SURFACE, and a flag may be preceded with NOT to |
---|
2365 | turn it off. |
---|
2366 | </Para> |
---|
2367 | |
---|
2368 | <Para> |
---|
2369 | Survey legs marked SURFACE are hidden from plots by default, and not |
---|
2370 | included in cave survey length calculations. Survey legs marked as |
---|
2371 | DUPLICATE or SPLAY are also not included in cave survey length |
---|
2372 | calculations; legs marked SPLAY are ignored by the extend program. |
---|
2373 | DUPLICATE is intended for the case when if you have two different |
---|
2374 | surveys along the same section of passage (for example to tie two |
---|
2375 | surveys into a permanent survey station); SPLAY is intended for |
---|
2376 | cases such as radial legs in a large chamber. |
---|
2377 | </Para> |
---|
2378 | </listitem> |
---|
2379 | |
---|
2380 | </VarListEntry> |
---|
2381 | |
---|
2382 | <VarListEntry><Term>See Also</Term> |
---|
2383 | |
---|
2384 | <listitem><Para>*begin</Para></listitem> |
---|
2385 | |
---|
2386 | </VarListEntry> |
---|
2387 | |
---|
2388 | </VariableList> |
---|
2389 | |
---|
2390 | </Sect3> |
---|
2391 | |
---|
2392 | <Sect3><Title>INCLUDE</Title> |
---|
2393 | |
---|
2394 | <VariableList> |
---|
2395 | |
---|
2396 | <VarListEntry><Term>Syntax</Term> |
---|
2397 | |
---|
2398 | <listitem><Para>*include <filename></Para></listitem> |
---|
2399 | |
---|
2400 | </VarListEntry> |
---|
2401 | |
---|
2402 | <VarListEntry><Term>Example</Term> |
---|
2403 | |
---|
2404 | <listitem> |
---|
2405 | <Para> |
---|
2406 | <programlisting> |
---|
2407 | *include mission</programlisting> |
---|
2408 | |
---|
2409 | <programlisting> |
---|
2410 | *include "the pits"</programlisting> |
---|
2411 | </Para> |
---|
2412 | </listitem> |
---|
2413 | |
---|
2414 | </VarListEntry> |
---|
2415 | |
---|
2416 | <VarListEntry><Term>Description</Term> |
---|
2417 | |
---|
2418 | <listitem><Para> |
---|
2419 | *include processes <filename> as if it were inserted at this |
---|
2420 | place in the current file. (i.e. The current settings are carried |
---|
2421 | into <filename>, and any alterations to settings in <filename> |
---|
2422 | will be carried back again). There's one exception to this (for |
---|
2423 | obscure historical reasons) which is that the survey prefix is |
---|
2424 | restored upon return to the original file. Since *begin and *end |
---|
2425 | nesting cannot cross files, this can only make a difference if you |
---|
2426 | use the deprecated *prefix command. |
---|
2427 | </Para> |
---|
2428 | |
---|
2429 | <Para>If <filename> contains spaces, it must be enclosed in quotes. |
---|
2430 | </Para> |
---|
2431 | |
---|
2432 | <Para>An included file which does not have a complete path |
---|
2433 | is resolved relative to the directory which the parent file is in |
---|
2434 | (just as relative HTML links do). Cavern will try adding a <filename>.svx</filename> |
---|
2435 | extension, and will also try translating "\" to "/". |
---|
2436 | And as a last |
---|
2437 | resort, it will try a lower case version of the filename (so if you |
---|
2438 | use Unix and someone sends you a DOS/Windows dataset with mismatched |
---|
2439 | case, unzip it with "unzip -L" and UNIX cavern will process it). |
---|
2440 | </Para> |
---|
2441 | |
---|
2442 | <Para> |
---|
2443 | The depth to which you can nest |
---|
2444 | include files may be limited by the operating system |
---|
2445 | you use. Usually the limit is fairly high (>30), but if you want to be able to |
---|
2446 | process your dataset with <Application>Survex</Application> on any supported platform, it |
---|
2447 | would be prudent not to go overboard with nested include files. |
---|
2448 | </Para> |
---|
2449 | </listitem> |
---|
2450 | </VarListEntry> |
---|
2451 | |
---|
2452 | </VariableList> |
---|
2453 | |
---|
2454 | </Sect3> |
---|
2455 | |
---|
2456 | <Sect3><Title>INFER</Title> |
---|
2457 | |
---|
2458 | <VariableList> |
---|
2459 | |
---|
2460 | <VarListEntry><Term>Syntax</Term> |
---|
2461 | |
---|
2462 | <listitem> |
---|
2463 | <Para>*infer plumbs on|off</Para> |
---|
2464 | |
---|
2465 | <Para>*infer equates on|off</Para> |
---|
2466 | |
---|
2467 | <Para>*infer exports on|off</Para> |
---|
2468 | </listitem> |
---|
2469 | |
---|
2470 | </VarListEntry> |
---|
2471 | |
---|
2472 | <!-- |
---|
2473 | <VarListEntry><Term>Example</Term> |
---|
2474 | |
---|
2475 | <listitem> |
---|
2476 | <programlisting> |
---|
2477 | </programlisting> |
---|
2478 | |
---|
2479 | </listitem> |
---|
2480 | |
---|
2481 | </VarListEntry> |
---|
2482 | --> |
---|
2483 | |
---|
2484 | <VarListEntry><Term>Description</Term> |
---|
2485 | |
---|
2486 | <listitem> |
---|
2487 | <Para>"*infer plumbs on" tells cavern to interpret gradients of +/- 90 |
---|
2488 | degrees as UP/DOWN (so it |
---|
2489 | will not apply the clino correction to them). This is useful when |
---|
2490 | the data has not been converted to have UP and DOWN in it. |
---|
2491 | </Para> |
---|
2492 | |
---|
2493 | <para>"*infer equates on" tells cavern to interpret a leg with |
---|
2494 | a tape reading of zero as a *equate. this prevents tape corrections |
---|
2495 | being applied to them. |
---|
2496 | </para> |
---|
2497 | |
---|
2498 | <para>"*infer exports on" is necessary when you have a dataset which is |
---|
2499 | partly annotated with *export. It tells cavern not to complain about |
---|
2500 | missing *export commands in part of the dataset. Also stations which |
---|
2501 | were used to join surveys are marked as exported in the 3d file. |
---|
2502 | </para> |
---|
2503 | </listitem> |
---|
2504 | |
---|
2505 | </VarListEntry> |
---|
2506 | |
---|
2507 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
2508 | |
---|
2509 | <!-- |
---|
2510 | <VarListEntry><Term>See Also</Term> |
---|
2511 | |
---|
2512 | <listitem><Para>*end, *prefix</Para></listitem> |
---|
2513 | |
---|
2514 | </VarListEntry> |
---|
2515 | --> |
---|
2516 | |
---|
2517 | </VariableList> |
---|
2518 | |
---|
2519 | </Sect3> |
---|
2520 | |
---|
2521 | <Sect3><Title>INSTRUMENT</Title> |
---|
2522 | |
---|
2523 | <VariableList> |
---|
2524 | |
---|
2525 | <VarListEntry><Term>Syntax</Term> |
---|
2526 | |
---|
2527 | <listitem><Para>*instrument <instrument> <identifier></Para></listitem> |
---|
2528 | |
---|
2529 | </VarListEntry> |
---|
2530 | |
---|
2531 | <VarListEntry><Term>Example</Term> |
---|
2532 | |
---|
2533 | <listitem> |
---|
2534 | <Para> |
---|
2535 | <programlisting> |
---|
2536 | *instrument compass "CUCC 2" |
---|
2537 | *instrument clino "CUCC 2" |
---|
2538 | *instrument tape "CUCC Fisco Ranger open reel"</programlisting> |
---|
2539 | </Para> |
---|
2540 | </listitem> |
---|
2541 | |
---|
2542 | </VarListEntry> |
---|
2543 | |
---|
2544 | <VarListEntry><Term>Validity</Term> |
---|
2545 | |
---|
2546 | <listitem><Para>valid at the start of a *begin/*end block. |
---|
2547 | </Para></listitem> |
---|
2548 | |
---|
2549 | </VarListEntry> |
---|
2550 | |
---|
2551 | <VarListEntry><Term>Description</Term> |
---|
2552 | |
---|
2553 | <listitem><Para> |
---|
2554 | *instrument specifies the particular instruments used to perform a |
---|
2555 | survey. |
---|
2556 | </Para></listitem> |
---|
2557 | |
---|
2558 | </VarListEntry> |
---|
2559 | |
---|
2560 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
2561 | |
---|
2562 | <VarListEntry><Term>See Also</Term> |
---|
2563 | |
---|
2564 | <listitem><Para>*begin, *date, *team</Para></listitem> |
---|
2565 | |
---|
2566 | </VarListEntry> |
---|
2567 | |
---|
2568 | </VariableList> |
---|
2569 | |
---|
2570 | </Sect3> |
---|
2571 | |
---|
2572 | <Sect3><Title>PREFIX</Title> |
---|
2573 | |
---|
2574 | <VariableList> |
---|
2575 | |
---|
2576 | <VarListEntry><Term>Syntax</Term> |
---|
2577 | |
---|
2578 | <listitem><Para>*prefix <survey></Para></listitem> |
---|
2579 | |
---|
2580 | </VarListEntry> |
---|
2581 | |
---|
2582 | <VarListEntry><Term>Example</Term> |
---|
2583 | |
---|
2584 | <listitem> |
---|
2585 | <Para> |
---|
2586 | <programlisting> |
---|
2587 | *prefix flapjack</programlisting> |
---|
2588 | </Para> |
---|
2589 | </listitem> |
---|
2590 | |
---|
2591 | </VarListEntry> |
---|
2592 | |
---|
2593 | <VarListEntry><Term>Description</Term> |
---|
2594 | |
---|
2595 | <listitem><Para> |
---|
2596 | *prefix sets the current survey. |
---|
2597 | </Para></listitem> |
---|
2598 | |
---|
2599 | </VarListEntry> |
---|
2600 | |
---|
2601 | <VarListEntry><Term>Caveats </Term> |
---|
2602 | |
---|
2603 | <listitem><Para>*prefix is deprecated - you should use *begin and *end |
---|
2604 | instead.</Para></listitem> |
---|
2605 | |
---|
2606 | </VarListEntry> |
---|
2607 | |
---|
2608 | <VarListEntry><Term>See Also</Term> |
---|
2609 | |
---|
2610 | <listitem><Para>*begin, *end</Para></listitem> |
---|
2611 | |
---|
2612 | </VarListEntry> |
---|
2613 | |
---|
2614 | </VariableList> |
---|
2615 | |
---|
2616 | </Sect3> |
---|
2617 | |
---|
2618 | <Sect3><Title>REF</Title> |
---|
2619 | |
---|
2620 | <VariableList> |
---|
2621 | |
---|
2622 | <VarListEntry><Term>Syntax</Term> |
---|
2623 | |
---|
2624 | <listitem><Para>*ref <string></Para></listitem> |
---|
2625 | |
---|
2626 | </VarListEntry> |
---|
2627 | |
---|
2628 | <VarListEntry><Term>Example</Term> |
---|
2629 | |
---|
2630 | <listitem> |
---|
2631 | <Para> |
---|
2632 | <programlisting> |
---|
2633 | *ref "survey folder 2007#12" |
---|
2634 | </programlisting> |
---|
2635 | </Para> |
---|
2636 | </listitem> |
---|
2637 | |
---|
2638 | </VarListEntry> |
---|
2639 | |
---|
2640 | <VarListEntry><Term>Validity</Term> |
---|
2641 | |
---|
2642 | <listitem><Para>valid at the start of a *begin/*end block. |
---|
2643 | </Para></listitem> |
---|
2644 | |
---|
2645 | </VarListEntry> |
---|
2646 | |
---|
2647 | <VarListEntry><Term>Description</Term> |
---|
2648 | |
---|
2649 | <listitem><Para> |
---|
2650 | *ref allows you to specify a reference. If the reference contains spaces, you |
---|
2651 | must enclose it in double quotes. Survex doesn't try to interpret the |
---|
2652 | reference in any way, so it's up to you how you use it - for example it could |
---|
2653 | specify where the original survey notes can be found. |
---|
2654 | </Para> |
---|
2655 | |
---|
2656 | <Para> |
---|
2657 | *ref was added in Survex 1.2.23. |
---|
2658 | </Para></listitem> |
---|
2659 | |
---|
2660 | </VarListEntry> |
---|
2661 | |
---|
2662 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
2663 | |
---|
2664 | <VarListEntry><Term>See Also</Term> |
---|
2665 | |
---|
2666 | <listitem><Para>*begin, *date, *instrument, *team</Para></listitem> |
---|
2667 | |
---|
2668 | </VarListEntry> |
---|
2669 | |
---|
2670 | </VariableList> |
---|
2671 | |
---|
2672 | </Sect3> |
---|
2673 | |
---|
2674 | <Sect3><Title>REQUIRE</Title> |
---|
2675 | |
---|
2676 | <VariableList> |
---|
2677 | |
---|
2678 | <VarListEntry><Term>Syntax</Term> |
---|
2679 | |
---|
2680 | <listitem><Para>*require <version></Para></listitem> |
---|
2681 | |
---|
2682 | </VarListEntry> |
---|
2683 | |
---|
2684 | <VarListEntry><Term>Example</Term> |
---|
2685 | |
---|
2686 | <listitem> |
---|
2687 | <Para> |
---|
2688 | <programlisting> |
---|
2689 | *require 0.98</programlisting> |
---|
2690 | </Para> |
---|
2691 | </listitem> |
---|
2692 | |
---|
2693 | </VarListEntry> |
---|
2694 | |
---|
2695 | <VarListEntry><Term>Description</Term> |
---|
2696 | |
---|
2697 | <listitem><Para> |
---|
2698 | *require checks that the version of cavern in use is at least |
---|
2699 | <version> and stops with an error if not. |
---|
2700 | So if your dataset requires a feature |
---|
2701 | introduced in a particular version, you can add a *require command and |
---|
2702 | users will know what version they need to upgrade to, rather than |
---|
2703 | getting an error message and having to guess what the real problem is. |
---|
2704 | </Para></listitem> |
---|
2705 | |
---|
2706 | </VarListEntry> |
---|
2707 | |
---|
2708 | </VariableList> |
---|
2709 | |
---|
2710 | </Sect3> |
---|
2711 | |
---|
2712 | <Sect3><Title>SD</Title> |
---|
2713 | |
---|
2714 | <VariableList> |
---|
2715 | |
---|
2716 | <VarListEntry><Term>Syntax</Term> |
---|
2717 | |
---|
2718 | <listitem><Para>*sd <quantity list> <standard deviation> |
---|
2719 | </Para></listitem> |
---|
2720 | |
---|
2721 | </VarListEntry> |
---|
2722 | |
---|
2723 | <VarListEntry><Term>Example</Term> |
---|
2724 | |
---|
2725 | <listitem> |
---|
2726 | <Para> |
---|
2727 | <programlisting> |
---|
2728 | *sd tape 0.15 metres</programlisting> |
---|
2729 | </Para> |
---|
2730 | </listitem> |
---|
2731 | |
---|
2732 | </VarListEntry> |
---|
2733 | |
---|
2734 | <VarListEntry><Term>Description</Term> |
---|
2735 | |
---|
2736 | <listitem><Para> |
---|
2737 | *sd sets the standard deviation of a measurement. |
---|
2738 | </Para> |
---|
2739 | |
---|
2740 | <Para> |
---|
2741 | <quantity> is one of (each group gives alternative names for the same |
---|
2742 | quantity): |
---|
2743 | </Para> |
---|
2744 | |
---|
2745 | <ItemizedList> |
---|
2746 | <listitem><para>TAPE, LENGTH</para></listitem> |
---|
2747 | <listitem><para>BACKTAPE, BACKLENGTH (added in Survex 1.2.25)</para></listitem> |
---|
2748 | <listitem><para>COMPASS, BEARING</para></listitem> |
---|
2749 | <listitem><para>BACKCOMPASS, BACKBEARING</para></listitem> |
---|
2750 | <listitem><para>CLINO, GRADIENT</para></listitem> |
---|
2751 | <listitem><para>BACKCLINO, BACKGRADIENT</para></listitem> |
---|
2752 | <listitem><para>COUNTER, COUNT</para></listitem> |
---|
2753 | <listitem><para>DEPTH</para></listitem> |
---|
2754 | <listitem><para>DECLINATION</para></listitem> |
---|
2755 | <listitem><para>DX, EASTING</para></listitem> |
---|
2756 | <listitem><para>DY, NORTHING</para></listitem> |
---|
2757 | <listitem><para>DZ, ALTITUDE</para></listitem> |
---|
2758 | <listitem><para>LEFT</para></listitem> |
---|
2759 | <listitem><para>RIGHT</para></listitem> |
---|
2760 | <listitem><para>UP, CEILING</para></listitem> |
---|
2761 | <listitem><para>DOWN, FLOOR</para></listitem> |
---|
2762 | <listitem><para>LEVEL</para></listitem> |
---|
2763 | <listitem><para>PLUMB</para></listitem> |
---|
2764 | <listitem><para>POSITION</para></listitem> |
---|
2765 | </ItemizedList> |
---|
2766 | |
---|
2767 | <Para> |
---|
2768 | <standard deviation> must include units and thus is typically |
---|
2769 | "0.05 metres", or "0.02 degrees". See *units below for full list |
---|
2770 | of valid units. |
---|
2771 | </Para> |
---|
2772 | |
---|
2773 | <!-- FIXME mention central limit theorem --> |
---|
2774 | <Para> |
---|
2775 | To utilise this command fully you need to understand what a |
---|
2776 | <emphasis>standard deviation</emphasis> is. |
---|
2777 | It gives a value to the 'spread' of the errors |
---|
2778 | in a measurement. Assuming that these are normally distributed |
---|
2779 | we can say that 95.44% of the actual lengths will fall within two |
---|
2780 | standard deviations of the measured length. i.e. a tape SD of |
---|
2781 | 0.25 metres means that the actual length of a tape measurement |
---|
2782 | is within + or - 0.5 metres of the recorded value 95.44% of the time. |
---|
2783 | So if the measurement is 7.34m then the actual length is very |
---|
2784 | likely to be between 6.84m and 7.84m. This example corresponds |
---|
2785 | to BCRA grade 3. Note that this is just one interpretation of |
---|
2786 | the BCRA standard, taking the permitted error values as 2SD 95.44% |
---|
2787 | confidence limits. If you want to take the readings as being some |
---|
2788 | other limit (e.g. 1SD = 68.26%) then you will need to change the BCRA3 |
---|
2789 | and BCRA5 files accordingly. This issue is explored in more |
---|
2790 | detail in various surveying articles. |
---|
2791 | <!-- |
---|
2792 | 2.565 sd 99% |
---|
2793 | 2.5 sd 98.76% |
---|
2794 | 2 sd 95.44% |
---|
2795 | 1 sd 68.26% |
---|
2796 | .97 sd 66.67% |
---|
2797 | 1.15 sd 75% |
---|
2798 | --> |
---|
2799 | </Para></listitem> |
---|
2800 | |
---|
2801 | </VarListEntry> |
---|
2802 | |
---|
2803 | <VarListEntry><Term>See Also</Term> |
---|
2804 | |
---|
2805 | <listitem><Para>*units</Para></listitem> |
---|
2806 | |
---|
2807 | </VarListEntry> |
---|
2808 | |
---|
2809 | </VariableList> |
---|
2810 | |
---|
2811 | </Sect3> |
---|
2812 | |
---|
2813 | <Sect3><Title>SET</Title> |
---|
2814 | |
---|
2815 | <VariableList> |
---|
2816 | |
---|
2817 | <VarListEntry><Term>Syntax</Term> |
---|
2818 | |
---|
2819 | <listitem><Para>*set <item> <character list></Para></listitem> |
---|
2820 | |
---|
2821 | </VarListEntry> |
---|
2822 | |
---|
2823 | <VarListEntry><Term>Example</Term> |
---|
2824 | |
---|
2825 | <listitem> |
---|
2826 | <Para> |
---|
2827 | <programlisting> |
---|
2828 | *set blank x09x20 |
---|
2829 | *set decimal ,</programlisting> |
---|
2830 | |
---|
2831 | Note that you need to eliminate comma from being a blank before setting it as |
---|
2832 | a decimal - otherwise the comma in "*set decimal ," is parsed as a blank, and |
---|
2833 | you set decimal to not have any characters representing it. |
---|
2834 | </Para> |
---|
2835 | </listitem> |
---|
2836 | |
---|
2837 | </VarListEntry> |
---|
2838 | |
---|
2839 | <VarListEntry><Term>Description</Term> |
---|
2840 | |
---|
2841 | <listitem><Para> |
---|
2842 | *set sets the specified <item> to the character or characters |
---|
2843 | given in <character list>. The example sets the decimal |
---|
2844 | separator to be a comma. |
---|
2845 | </Para> |
---|
2846 | |
---|
2847 | <Para> |
---|
2848 | xAB means the character with hex value AB. Eg x20 is a space. |
---|
2849 | </Para> |
---|
2850 | |
---|
2851 | <Para> |
---|
2852 | The complete list of items that can be set, the defaults (in |
---|
2853 | brackets), and the meaning of the item, is: |
---|
2854 | </Para> |
---|
2855 | |
---|
2856 | <ItemizedList> |
---|
2857 | |
---|
2858 | <ListItem><Para> |
---|
2859 | BLANK (x09x20,) Separates fields |
---|
2860 | </Para></ListItem> |
---|
2861 | |
---|
2862 | <ListItem><Para> |
---|
2863 | COMMENT (;) Introduces comments |
---|
2864 | </Para></ListItem> |
---|
2865 | |
---|
2866 | <ListItem><Para> |
---|
2867 | DECIMAL (.) Decimal point character |
---|
2868 | </Para></ListItem> |
---|
2869 | |
---|
2870 | <ListItem><Para> |
---|
2871 | EOL (x0Ax0D) End of line character |
---|
2872 | </Para></ListItem> |
---|
2873 | |
---|
2874 | <ListItem><Para> |
---|
2875 | KEYWORD (*) Introduces keywords |
---|
2876 | </Para></ListItem> |
---|
2877 | |
---|
2878 | <ListItem><Para> |
---|
2879 | MINUS (-) Indicates negative number |
---|
2880 | </Para></ListItem> |
---|
2881 | |
---|
2882 | <ListItem><Para> |
---|
2883 | NAMES (_-) Non-alphanumeric chars permitted in station |
---|
2884 | names (letters and numbers are always permitted). |
---|
2885 | </Para></ListItem> |
---|
2886 | |
---|
2887 | <ListItem><Para> |
---|
2888 | OMIT (-) Contents of field omitted (e.g. in plumbed legs) |
---|
2889 | </Para></ListItem> |
---|
2890 | |
---|
2891 | <ListItem><Para> |
---|
2892 | PLUS (+) Indicates positive number |
---|
2893 | </Para></ListItem> |
---|
2894 | |
---|
2895 | <ListItem><Para> |
---|
2896 | ROOT (\) Prefix in force at start of current file (use of ROOT is deprecated) |
---|
2897 | </Para></ListItem> |
---|
2898 | |
---|
2899 | <ListItem><Para> |
---|
2900 | SEPARATOR (.) Level separator in prefix hierarchy |
---|
2901 | </Para></ListItem> |
---|
2902 | |
---|
2903 | <!-- FIXME OPEN ({) and CLOSE (}) --> |
---|
2904 | </ItemizedList> |
---|
2905 | |
---|
2906 | <Para> |
---|
2907 | The special characters may not be alphanumeric. |
---|
2908 | </Para> |
---|
2909 | |
---|
2910 | </listitem> |
---|
2911 | |
---|
2912 | </VarListEntry> |
---|
2913 | |
---|
2914 | </VariableList> |
---|
2915 | |
---|
2916 | </Sect3> |
---|
2917 | |
---|
2918 | <Sect3><Title>SOLVE</Title> |
---|
2919 | |
---|
2920 | <VariableList> |
---|
2921 | |
---|
2922 | <VarListEntry><Term>Syntax</Term> |
---|
2923 | |
---|
2924 | <listitem><Para>*solve</Para></listitem> |
---|
2925 | |
---|
2926 | </VarListEntry> |
---|
2927 | |
---|
2928 | <VarListEntry><Term>Example</Term> |
---|
2929 | |
---|
2930 | <listitem> |
---|
2931 | <Para> |
---|
2932 | <programlisting> |
---|
2933 | *include 1997data |
---|
2934 | *solve |
---|
2935 | *include 1998data |
---|
2936 | </programlisting> |
---|
2937 | </Para> |
---|
2938 | </listitem> |
---|
2939 | |
---|
2940 | </VarListEntry> |
---|
2941 | |
---|
2942 | <VarListEntry><Term>Description</Term> |
---|
2943 | |
---|
2944 | <listitem><Para> |
---|
2945 | Distributes misclosures around any loops in the survey and fixes |
---|
2946 | the positions of all existing stations. This command is intended |
---|
2947 | for situations where you have some new surveys adding extensions |
---|
2948 | to an already drawn-up survey which you wish to avoid completely |
---|
2949 | redrawing. You can read in the old data, use *SOLVE to fix it, and then |
---|
2950 | read in the new data. Then old stations will be in the same |
---|
2951 | positions as they are in the existing drawn up survey, even if new loops |
---|
2952 | have been formed by the extensions. |
---|
2953 | </Para></listitem> |
---|
2954 | |
---|
2955 | </VarListEntry> |
---|
2956 | |
---|
2957 | </VariableList> |
---|
2958 | |
---|
2959 | </Sect3> |
---|
2960 | |
---|
2961 | <Sect3><Title>TEAM</Title> |
---|
2962 | |
---|
2963 | <VariableList> |
---|
2964 | |
---|
2965 | <VarListEntry><Term>Syntax</Term> |
---|
2966 | |
---|
2967 | <listitem><Para>*team <person> <role>...</Para></listitem> |
---|
2968 | |
---|
2969 | </VarListEntry> |
---|
2970 | |
---|
2971 | <VarListEntry><Term>Example</Term> |
---|
2972 | |
---|
2973 | <listitem> |
---|
2974 | <Para> |
---|
2975 | <programlisting> |
---|
2976 | *team "Nick Proctor" compass clino tape |
---|
2977 | *team "Anthony Day" notes pictures tape |
---|
2978 | </programlisting> |
---|
2979 | </Para> |
---|
2980 | </listitem> |
---|
2981 | |
---|
2982 | </VarListEntry> |
---|
2983 | |
---|
2984 | <VarListEntry><Term>Validity</Term> |
---|
2985 | |
---|
2986 | <listitem><Para>valid at the start of a *begin/*end block. |
---|
2987 | </Para></listitem> |
---|
2988 | <!-- FIXME valid roles are? --> |
---|
2989 | |
---|
2990 | </VarListEntry> |
---|
2991 | |
---|
2992 | <VarListEntry><Term>Description</Term> |
---|
2993 | |
---|
2994 | <listitem><Para> |
---|
2995 | *team specifies the people involved in a survey and what role they |
---|
2996 | filled during that trip. |
---|
2997 | </Para></listitem> |
---|
2998 | |
---|
2999 | </VarListEntry> |
---|
3000 | |
---|
3001 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
3002 | |
---|
3003 | <VarListEntry><Term>See Also</Term> |
---|
3004 | |
---|
3005 | <listitem><Para>*begin, *date, *instrument</Para></listitem> |
---|
3006 | |
---|
3007 | </VarListEntry> |
---|
3008 | |
---|
3009 | </VariableList> |
---|
3010 | |
---|
3011 | </Sect3> |
---|
3012 | |
---|
3013 | <Sect3><Title>TITLE</Title> |
---|
3014 | |
---|
3015 | <VariableList> |
---|
3016 | |
---|
3017 | <VarListEntry><Term>Syntax</Term> |
---|
3018 | |
---|
3019 | <listitem><Para>*title <title></Para></listitem> |
---|
3020 | |
---|
3021 | </VarListEntry> |
---|
3022 | |
---|
3023 | <VarListEntry><Term>Example</Term> |
---|
3024 | |
---|
3025 | <listitem> |
---|
3026 | <programlisting> |
---|
3027 | *title Dreamtime</programlisting> |
---|
3028 | |
---|
3029 | <programlisting> |
---|
3030 | *title "Mission Impossible"</programlisting> |
---|
3031 | </listitem> |
---|
3032 | |
---|
3033 | </VarListEntry> |
---|
3034 | |
---|
3035 | <VarListEntry><Term>Description</Term> |
---|
3036 | |
---|
3037 | <listitem><Para>*title allows you to set the descriptive title for a survey. |
---|
3038 | If the title contains spaces, you need to enclose it in quotes (""). |
---|
3039 | If there is no *title command, the title defaults to the survey name |
---|
3040 | given in the *begin command. |
---|
3041 | </Para> |
---|
3042 | </listitem> |
---|
3043 | |
---|
3044 | </VarListEntry> |
---|
3045 | |
---|
3046 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
3047 | |
---|
3048 | <!-- |
---|
3049 | <VarListEntry><Term>See Also</Term> |
---|
3050 | |
---|
3051 | <listitem><Para>*end, *prefix</Para></listitem> |
---|
3052 | |
---|
3053 | </VarListEntry> |
---|
3054 | --> |
---|
3055 | |
---|
3056 | </VariableList> |
---|
3057 | |
---|
3058 | </Sect3> |
---|
3059 | |
---|
3060 | <Sect3><Title>TRUNCATE</Title> |
---|
3061 | |
---|
3062 | <VariableList> |
---|
3063 | |
---|
3064 | <VarListEntry><Term>Syntax</Term> |
---|
3065 | |
---|
3066 | <listitem><Para>*truncate <length>|off</Para></listitem> |
---|
3067 | |
---|
3068 | </VarListEntry> |
---|
3069 | |
---|
3070 | <!-- FIXME: |
---|
3071 | <VarListEntry><Term>Example</Term> |
---|
3072 | |
---|
3073 | <listitem> |
---|
3074 | <programlisting> |
---|
3075 | </programlisting> |
---|
3076 | |
---|
3077 | </listitem> |
---|
3078 | |
---|
3079 | </VarListEntry> |
---|
3080 | --> |
---|
3081 | |
---|
3082 | <VarListEntry><Term>Description</Term> |
---|
3083 | |
---|
3084 | <listitem><Para>Station names may be of any length in <Application>Survex</Application>, but some |
---|
3085 | other (mostly older) cave surveying software only regard the first few |
---|
3086 | characters of a name as significant (e.g. "entran" and "entrance" |
---|
3087 | might be treated as the same). To facilitate using data imported from |
---|
3088 | such a package <Application>Survex</Application> allows you to truncate names to whatever |
---|
3089 | length you want (but by default truncation is off). |
---|
3090 | </Para> |
---|
3091 | |
---|
3092 | <Para>Figures for the number of characters which are significant in various |
---|
3093 | software packages: Compass currently has a limit of 12, |
---|
3094 | CMAP has a limit of 6, |
---|
3095 | Smaps 4 had a limit of 8, |
---|
3096 | <!-- FIXME any limits for other software, winkarst for example? --> |
---|
3097 | Surveyor87/8 used 8. |
---|
3098 | <Application>Survex</Application> itself used 8 per prefix |
---|
3099 | level up to version 0.41, and 12 per prefix level up to 0.73 (more recent |
---|
3100 | versions removed this rather archaic restriction). |
---|
3101 | </Para> |
---|
3102 | </listitem> |
---|
3103 | |
---|
3104 | </VarListEntry> |
---|
3105 | |
---|
3106 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
3107 | |
---|
3108 | <VarListEntry><Term>See Also</Term> |
---|
3109 | |
---|
3110 | <listitem><Para>*case</Para></listitem> |
---|
3111 | |
---|
3112 | </VarListEntry> |
---|
3113 | |
---|
3114 | </VariableList> |
---|
3115 | |
---|
3116 | </Sect3> |
---|
3117 | |
---|
3118 | <Sect3><Title>UNITS</Title> |
---|
3119 | |
---|
3120 | <VariableList> |
---|
3121 | |
---|
3122 | <VarListEntry><Term>Syntax</Term> |
---|
3123 | |
---|
3124 | <listitem><Para> |
---|
3125 | *units <quantity list> [<factor>] <unit> |
---|
3126 | </Para> |
---|
3127 | <Para> |
---|
3128 | *units default |
---|
3129 | </Para></listitem> |
---|
3130 | |
---|
3131 | </VarListEntry> |
---|
3132 | |
---|
3133 | <VarListEntry><Term>Example</Term> |
---|
3134 | |
---|
3135 | <listitem> |
---|
3136 | <Para> |
---|
3137 | <programlisting> |
---|
3138 | *units tape metres</programlisting> |
---|
3139 | |
---|
3140 | <programlisting> |
---|
3141 | *units compass backcompass clino backclino grads</programlisting> |
---|
3142 | |
---|
3143 | <programlisting> |
---|
3144 | *units dx dy dz 1000 metres ; data given as kilometres</programlisting> |
---|
3145 | |
---|
3146 | <programlisting> |
---|
3147 | *units left right up down feet</programlisting> |
---|
3148 | </Para> |
---|
3149 | </listitem> |
---|
3150 | |
---|
3151 | </VarListEntry> |
---|
3152 | |
---|
3153 | <VarListEntry><Term>Description</Term> |
---|
3154 | |
---|
3155 | <listitem><Para> |
---|
3156 | <quantity> is one of the following (grouped entries are just alternative names for the same thing): |
---|
3157 | TAPE/LENGTH, BACKTAPE/BACKLENGTH (added in Survex 1.2.25), COMPASS/BEARING, BACKCOMPASS/BACKBEARING, CLINO/GRADIENT, BACKCLINO/BACKGRADIENT, COUNTER/COUNT, DEPTH, DECLINATION, DX/EASTING, DY/NORTHING, DZ/ALTITUDE, LEFT, RIGHT, UP/CEILING, DOWN/FLOOR |
---|
3158 | </Para> |
---|
3159 | |
---|
3160 | <Para>Changes current units of all the quantities listed to [<factor>] |
---|
3161 | <unit>. Note that quantities can be expressed either as |
---|
3162 | the instrument (e.g. COMPASS) or the measurement (e.g. BEARING). |
---|
3163 | </Para> |
---|
3164 | |
---|
3165 | <Para><factor> allows you to easy specify situations such as measuring |
---|
3166 | distance with a diving line knotted every 10cm (*units distance 0.1 metres). |
---|
3167 | If <factor> is omitted it defaults to 1.0. If specified, it must be |
---|
3168 | non-zero. |
---|
3169 | </Para> |
---|
3170 | |
---|
3171 | <Para>Valid units for listed quantities are: |
---|
3172 | </Para> |
---|
3173 | |
---|
3174 | <Para>TAPE/LENGTH, BACKTAPE/BACKLENGTH, COUNTER/COUNT, DEPTH, DX/EASTING, DY/NORTHING, DZ/ALTITUDE |
---|
3175 | in YARDS|FEET|METRIC|METRES|METERS (default: METRES) |
---|
3176 | </Para> |
---|
3177 | |
---|
3178 | <Para>CLINO/GRADIENT, BACKCLINO/BACKGRADIENT |
---|
3179 | in DEGS|DEGREES|GRADS|MILS|MINUTES|PERCENT|PERCENTAGE (default: DEGREES) |
---|
3180 | </Para> |
---|
3181 | |
---|
3182 | <Para>COMPASS/BEARING, BACKCOMPASS/BACKBEARING, DECLINATION |
---|
3183 | in DEGS|DEGREES|GRADS|MILS|MINUTES (default: DEGREES) |
---|
3184 | </Para> |
---|
3185 | |
---|
3186 | <Para>(360 degrees = 400 grads (also known as Mils)) |
---|
3187 | </Para> |
---|
3188 | </listitem> |
---|
3189 | |
---|
3190 | </VarListEntry> |
---|
3191 | |
---|
3192 | <!-- <VarListEntry><Term>Caveats </Term> </VarListEntry> --> |
---|
3193 | |
---|
3194 | <VarListEntry><Term>See Also</Term> |
---|
3195 | |
---|
3196 | <listitem><Para>*calibrate</Para></listitem> |
---|
3197 | |
---|
3198 | </VarListEntry> |
---|
3199 | |
---|
3200 | </VariableList> |
---|
3201 | |
---|
3202 | </Sect3> |
---|
3203 | |
---|
3204 | </Sect2> |
---|
3205 | |
---|
3206 | </Sect1> |
---|
3207 | |
---|
3208 | <!-- FIXME rename to "Cookbook"? --> |
---|
3209 | <Sect1><Title>Contents of <filename>.svx</filename> files: How do I?</Title> |
---|
3210 | <?dbhtml filename="svxhowto.htm"> |
---|
3211 | |
---|
3212 | <Para> |
---|
3213 | Here is some example <Application>Survex</Application> data (a very small cave numbered 1623/163): |
---|
3214 | </Para> |
---|
3215 | |
---|
3216 | <programlisting> |
---|
3217 | 2 1 26.60 222 17.5 |
---|
3218 | 2 3 10.85 014 7 |
---|
3219 | 2 4 7.89 254 -11 |
---|
3220 | 4 5 2.98 - DOWN |
---|
3221 | 5 6 9.29 271 -28.5</programlisting> |
---|
3222 | |
---|
3223 | <Para> |
---|
3224 | You can vary the data ordering. The default is: |
---|
3225 | </Para> |
---|
3226 | |
---|
3227 | <Para> |
---|
3228 | from-station to-station tape compass clino |
---|
3229 | </Para> |
---|
3230 | |
---|
3231 | <Para> |
---|
3232 | This data demonstrates a number of useful features of <Application>Survex</Application>: |
---|
3233 | </Para> |
---|
3234 | |
---|
3235 | <Para> |
---|
3236 | Legs can be measured either way round, which allows the use of |
---|
3237 | techniques like "leap-frogging" (which is where legs |
---|
3238 | alternate forwards and backwards). |
---|
3239 | </Para> |
---|
3240 | |
---|
3241 | <Para> |
---|
3242 | Also notice that there is a spur in the survey (2 to 3). You |
---|
3243 | do not need to specify this specially. |
---|
3244 | </Para> |
---|
3245 | |
---|
3246 | <Para> |
---|
3247 | <Application>Survex</Application> places few restrictions on station naming (see "Survey |
---|
3248 | Station Names" in the previous section), so you can number the stations |
---|
3249 | as they were in the original survey notes. Although not apparent from |
---|
3250 | this example, there is no requirement for each leg to connect to an |
---|
3251 | existing station. <Application>Survex</Application> can accept data in any order, and will |
---|
3252 | check for connectedness once all the data has been read in. |
---|
3253 | </Para> |
---|
3254 | |
---|
3255 | <Para> |
---|
3256 | Each survey is also likely to have other information associated |
---|
3257 | with it, such as instrument calibrations, etc. This has been |
---|
3258 | omitted from this example to keep things simple. |
---|
3259 | </Para> |
---|
3260 | |
---|
3261 | <Para> |
---|
3262 | Most caves will take more than just one survey trip to map. Commonly |
---|
3263 | the numbering in each survey will begin at 1, so we need to be |
---|
3264 | able to tell apart stations with the same number in different |
---|
3265 | surveys. |
---|
3266 | </Para> |
---|
3267 | |
---|
3268 | <Para> |
---|
3269 | To accomplish this, <Application>Survex</Application> has a very flexible system of hierarchical |
---|
3270 | prefixes. All you need do is give each survey a unique name or |
---|
3271 | number, and enter the data like so: |
---|
3272 | </Para> |
---|
3273 | |
---|
3274 | <programlisting> |
---|
3275 | *begin 163 |
---|
3276 | *export 1 |
---|
3277 | 2 1 26.60 222 17.5 |
---|
3278 | 2 3 10.85 014 7 |
---|
3279 | 2 4 7.89 254 -11 |
---|
3280 | 4 5 2.98 - DOWN |
---|
3281 | 5 6 9.29 271 -28.5 |
---|
3282 | *end 163</programlisting> |
---|
3283 | |
---|
3284 | <Para><Application>Survex</Application> will name the stations by attaching the current prefix. |
---|
3285 | In this case, the stations will be named 163.1, 163.2, etc. |
---|
3286 | </Para> |
---|
3287 | |
---|
3288 | <Para>We have a convention with the CUCC Austria data that the entrance survey |
---|
3289 | station of a cave is named P<cave number>, P163 in this case. We |
---|
3290 | can accomplish this like so: |
---|
3291 | </Para> |
---|
3292 | |
---|
3293 | <programlisting> |
---|
3294 | *equate P163 163.1 |
---|
3295 | *entrance P163 |
---|
3296 | *begin 163 |
---|
3297 | *export 1 |
---|
3298 | 2 1 26.60 222 17.5 |
---|
3299 | 2 3 10.85 014 7 |
---|
3300 | 2 4 7.89 254 -11 |
---|
3301 | 4 5 2.98 - DOWN |
---|
3302 | 5 6 9.29 271 -28.5 |
---|
3303 | *end 163</programlisting> |
---|
3304 | |
---|
3305 | <Sect2><Title>Specify surface survey data</Title> |
---|
3306 | |
---|
3307 | <Para> |
---|
3308 | Say you have 2 underground surveys and 2 surface ones with 2 fixed reference |
---|
3309 | points. You want to mark the surface surveys so that their length isn't |
---|
3310 | included in length statistics, and so that Aven knows to display them |
---|
3311 | differently. To do this you mark surface data with the "surface" flag |
---|
3312 | - this is set with "*flags surface" like so: |
---|
3313 | </Para> |
---|
3314 | |
---|
3315 | <programlisting> |
---|
3316 | ; fixed reference points |
---|
3317 | *fix fix_a 12345 56789 1234 |
---|
3318 | *fix fix_b 23456 67890 1111 |
---|
3319 | |
---|
3320 | ; surface data (enclosed in *begin ... *end to stop the *flags command |
---|
3321 | ; from "leaking" out) |
---|
3322 | *begin |
---|
3323 | *flags surface |
---|
3324 | *include surface1 |
---|
3325 | *include surface2 |
---|
3326 | *end |
---|
3327 | |
---|
3328 | ; underground data |
---|
3329 | *include cave1 |
---|
3330 | *include cave2</programlisting> |
---|
3331 | |
---|
3332 | <Para> |
---|
3333 | You might also have a survey which starts on the surface and heads into a |
---|
3334 | cave. This can be easily handled too - here's an example which goes in |
---|
3335 | one entrance, through the cave, and out of another entrance: |
---|
3336 | </Para> |
---|
3337 | |
---|
3338 | <programlisting> |
---|
3339 | *begin BtoC |
---|
3340 | *title "161b to 161c" |
---|
3341 | *date 1990.08.06 ; trip 1990-161c-3 in 1990 logbook |
---|
3342 | |
---|
3343 | *begin |
---|
3344 | *flags surface |
---|
3345 | 02 01 3.09 249 -08.5 |
---|
3346 | 02 03 4.13 252.5 -26 |
---|
3347 | *end |
---|
3348 | |
---|
3349 | 04 03 6.00 020 +37 |
---|
3350 | 04 05 3.07 329 -31 |
---|
3351 | 06 05 2.67 203 -40.5 |
---|
3352 | 06 07 2.20 014 +04 |
---|
3353 | 07 08 2.98 032 +04 |
---|
3354 | 08 09 2.73 063.5 +21 |
---|
3355 | 09 10 12.35 059 +15 |
---|
3356 | |
---|
3357 | *begin |
---|
3358 | *flags surface |
---|
3359 | 11 10 4.20 221.5 -11.5 |
---|
3360 | 11 12 5.05 215 +03.5 |
---|
3361 | 11 13 6.14 205 +12.5 |
---|
3362 | 13 14 15.40 221 -14 |
---|
3363 | *end |
---|
3364 | |
---|
3365 | *end BtoC</programlisting> |
---|
3366 | |
---|
3367 | <Para> |
---|
3368 | Note that to avoid needless complication, Survex regards each leg as |
---|
3369 | being either "surface" or "not surface" - if a leg spans the boundary you'll |
---|
3370 | have to call it one or the other. It's good surveying practice to |
---|
3371 | deliberately put a station at the surface/underground interface |
---|
3372 | (typically the highest closed contour or drip line) so this generally |
---|
3373 | isn't an onerous restriction. |
---|
3374 | </Para> |
---|
3375 | |
---|
3376 | </Sect2> |
---|
3377 | |
---|
3378 | <Sect2><Title>Specify the ordering and type of data</Title> |
---|
3379 | |
---|
3380 | <Para>The *DATA command is used to specify the data style, and the |
---|
3381 | order in which the readings are given.</Para> |
---|
3382 | |
---|
3383 | </Sect2> |
---|
3384 | |
---|
3385 | <Sect2><Title>Deal with Plumbs or Legs Across Static Water</Title> |
---|
3386 | |
---|
3387 | <!-- FIXME |
---|
3388 | <Para> |
---|
3389 | They can be given |
---|
3390 | as +90, or -90, but as they are not usually measured with the |
---|
3391 | clino, but with a plumb of some sort, then it is useful to distinguish |
---|
3392 | them in this way so that any clino adjustment is not applied to |
---|
3393 | these values. |
---|
3394 | </Para> |
---|
3395 | |
---|
3396 | FIXME: paste in section from mail to list |
---|
3397 | |
---|
3398 | <Para> |
---|
3399 | Note that a similar effect can be achieved by using the "*infer plumbs" command |
---|
3400 | to stop clino corrections being applied to -90 and +90 clino readings. |
---|
3401 | </Para> |
---|
3402 | --> |
---|
3403 | |
---|
3404 | <Para> |
---|
3405 | Plumbed legs should be given using 'UP' or 'DOWN' in place of the |
---|
3406 | clino reading and a dash (or a different specified 'OMIT' character) |
---|
3407 | in place of the compass reading. This distinguishes |
---|
3408 | them from legs measured with a compass and clino. Here's an example: |
---|
3409 | </Para> |
---|
3410 | |
---|
3411 | <programlisting> |
---|
3412 | 1 2 21.54 - UP |
---|
3413 | 3 2 7.36 017 +17 |
---|
3414 | 3 4 1.62 091 +08 |
---|
3415 | 5 4 10.38 - DOWN</programlisting> |
---|
3416 | |
---|
3417 | <Para> |
---|
3418 | U/D or +V/-V may be used instead of UP/DOWN; the check is not case |
---|
3419 | sensitive. |
---|
3420 | </Para> |
---|
3421 | |
---|
3422 | <Para> |
---|
3423 | Legs surveyed across the surface of a static body of water where no |
---|
3424 | clino reading is taken (since the surface of the water can be assumed |
---|
3425 | to be flat) can be indicated by using LEVEL in place of a clino reading. |
---|
3426 | This prevents the clino correction being applied. Here's an example: |
---|
3427 | </Para> |
---|
3428 | |
---|
3429 | <programlisting> |
---|
3430 | 1 2 11.37 190 -12 |
---|
3431 | 3 2 7.36 017 LEVEL |
---|
3432 | 3 4 1.62 091 LEVEL</programlisting> |
---|
3433 | |
---|
3434 | </Sect2> |
---|
3435 | |
---|
3436 | <Sect2><Title>Specify a BCRA grade</Title> |
---|
3437 | |
---|
3438 | <Para>The *SD command can be used to specify the standard deviations of the |
---|
3439 | various measurements (tape, compass, clino, etc). Examples files are |
---|
3440 | supplied which define BCRA Grade 3 and BCRA Grade 5 using a number of *sd |
---|
3441 | commands. You can use these by simply including them at the relevant point, |
---|
3442 | as follows: |
---|
3443 | </Para> |
---|
3444 | |
---|
3445 | <programlisting> |
---|
3446 | *begin somewhere |
---|
3447 | ; This survey is only grade 3 |
---|
3448 | *include grade3 |
---|
3449 | 2 1 26.60 222 17.5 |
---|
3450 | 2 3 10.85 014 7 |
---|
3451 | ; etc |
---|
3452 | *end somewhere</programlisting> |
---|
3453 | |
---|
3454 | <Para>The default values for the standard deviations are those for |
---|
3455 | BCRA grade 5. Note that it is good practice to keep the *include |
---|
3456 | Grade3 within *Begin and *End commands otherwise it will apply |
---|
3457 | to following survey data, which may not be what you intended. |
---|
3458 | </Para> |
---|
3459 | |
---|
3460 | </Sect2> |
---|
3461 | |
---|
3462 | <Sect2><Title>Specify different accuracy for a leg</Title> |
---|
3463 | |
---|
3464 | <Para>For example, suppose the tape on the plumbed leg in this survey |
---|
3465 | is suspected of being less accurate than the rest of the survey because |
---|
3466 | the length was obtained by measuring the length of the rope used to rig |
---|
3467 | the pitch. We can set a higher sd for this one measurement and use a |
---|
3468 | *begin/*end block to make sure this setting only applies to the one |
---|
3469 | leg: |
---|
3470 | </Para> |
---|
3471 | |
---|
3472 | <programlisting> |
---|
3473 | 2 1 26.60 222 17.5 |
---|
3474 | 2 3 10.85 014 7 |
---|
3475 | 2 4 7.89 254 -11 |
---|
3476 | *begin |
---|
3477 | ; tape measurement was taken from the rope length |
---|
3478 | *sd tape 0.5 metres |
---|
3479 | 4 5 34.50 - DOWN |
---|
3480 | *end |
---|
3481 | 5 6 9.29 271 -28.5</programlisting> |
---|
3482 | |
---|
3483 | <!-- FIXME also *calibrate and *instrument? Except rope is measure with the |
---|
3484 | tape... --> |
---|
3485 | </Sect2> |
---|
3486 | |
---|
3487 | <Sect2><Title>Enter Repeated Readings</Title> |
---|
3488 | |
---|
3489 | <Para>If your survey data contains multiple versions of each leg (for example, |
---|
3490 | pockettopo produces such data), then provided these are adjacent to one another |
---|
3491 | Survex 1.2.17 and later will automatically average these and treat them as a |
---|
3492 | single leg. |
---|
3493 | </Para> |
---|
3494 | |
---|
3495 | </Sect2> |
---|
3496 | |
---|
3497 | <Sect2><Title>Enter Radiolocation Data</Title> |
---|
3498 | |
---|
3499 | <!-- FIXME comments from David Gibson here --> |
---|
3500 | <Para>This is done by using the *SD command to specify the appropriate |
---|
3501 | errors for the radiolocation `survey leg' so that the loop closure |
---|
3502 | algorithm knows how to distribute errors if it forms part of a loop. |
---|
3503 | </Para> |
---|
3504 | |
---|
3505 | <Para>The best approach for a radiolocation where the underground station |
---|
3506 | is vertically below the surface station is to represent it as a |
---|
3507 | plumbed leg, giving suitable SDs for the length and plumb angle. The |
---|
3508 | horizontal positioning of this is generally quite accurate, but the |
---|
3509 | vertical positioning may be much less well known. E.g: we have a |
---|
3510 | radiolocation of about 50m depth +/- 20m and horizontal accuracy of |
---|
3511 | +/- 8m. Over 50m the +/-8m is equivalent to an angle of 9 degrees, so |
---|
3512 | that is the expected plumb error. 20m is the expected error in the |
---|
3513 | length. To get the equivalent SD we assume that 99.74% of readings will |
---|
3514 | be within 3 standard deviations of the error value. Thus we divide the |
---|
3515 | expected errors by 3 to get the SD we should specify: |
---|
3516 | </Para> <!-- 3 SD? or same as BCRA3.SVX, etc --> |
---|
3517 | |
---|
3518 | <programlisting> |
---|
3519 | *begin |
---|
3520 | *sd length 6.67 metres |
---|
3521 | *sd plumb 3 degrees |
---|
3522 | surface underground 50 - down |
---|
3523 | *end</programlisting> |
---|
3524 | |
---|
3525 | <Para> |
---|
3526 | We wrap the radiolocation leg in a *begin/*end block to make |
---|
3527 | sure that the special *sd settings only apply to this one leg. |
---|
3528 | </Para> |
---|
3529 | |
---|
3530 | <Para>For more information on the expected errors from radiolocations |
---|
3531 | see Compass Points Issue 10, available online at |
---|
3532 | <ulink url="http://www.chaos.org.uk/survex/cp/CP10/CPoint10.htm">http://www.chaos.org.uk/survex/cp/CP10/CPoint10.htm</ulink> |
---|
3533 | </Para> |
---|
3534 | |
---|
3535 | </Sect2> |
---|
3536 | |
---|
3537 | <Sect2><Title>Enter Diving Data</Title> |
---|
3538 | |
---|
3539 | <Para>Surveys made underwater using a diver's depth gauge can be |
---|
3540 | processed - use the *Data command to specify that the following data |
---|
3541 | is of this type. |
---|
3542 | </Para> |
---|
3543 | |
---|
3544 | </Sect2> |
---|
3545 | |
---|
3546 | <Sect2><Title>Enter Theodolite data</Title> |
---|
3547 | |
---|
3548 | <Para> |
---|
3549 | Theodolite data with turned angles is not yet explicitly catered |
---|
3550 | for, so for now you will need to convert it into equivalent legs in |
---|
3551 | another style - normal or cylpolar are likely to be the best choices. |
---|
3552 | </Para> |
---|
3553 | |
---|
3554 | <Para> |
---|
3555 | If there is no vertical info in your theodolite data then you should |
---|
3556 | use the cylpolar style and use *sd command to specify very low |
---|
3557 | accuracy (high SD) in the depth so that the points will move in the |
---|
3558 | vertical plane as required if the end points are fixed or the survey |
---|
3559 | is part of a loop. |
---|
3560 | </Para> |
---|
3561 | |
---|
3562 | </Sect2> |
---|
3563 | |
---|
3564 | </Sect1> |
---|
3565 | |
---|
3566 | <Sect1><Title>General: How do I?</Title> |
---|
3567 | <?dbhtml filename="genhowto.htm"> |
---|
3568 | |
---|
3569 | <Sect2><Title>Create a new survey</Title> |
---|
3570 | |
---|
3571 | <Para>You simply create a text file containing the relevant survey data, |
---|
3572 | using a text editor, and save it with a suitable name with a <filename>.svx</filename> |
---|
3573 | extension. The |
---|
3574 | easiest way is to look at some of the example data and use that |
---|
3575 | as a template. Nearly all surveys will need a bit of basic info |
---|
3576 | as well as the survey data itself: e.g. the date (*date), comments |
---|
3577 | about where, what cave, a name for the survey (using *begin and *end), |
---|
3578 | instrument error corrections etc. Here is a typical survey file: |
---|
3579 | </Para> |
---|
3580 | |
---|
3581 | <Para>All the lines starting with ';' are comments, which are ignored |
---|
3582 | by <Application>Survex</Application>. You can also see the use of 'DOWN' for plumbs, and |
---|
3583 | *calibrate tape for dealing with a tape length error (in this case |
---|
3584 | the end of the tape had fallen off so measurements were made from the |
---|
3585 | 20cm point).</Para> |
---|
3586 | |
---|
3587 | <programlisting> |
---|
3588 | *equate chaos.1 triassic.pt3.8 |
---|
3589 | *equate chaos.2 triassic.pt3.9 |
---|
3590 | |
---|
3591 | *begin chaos |
---|
3592 | *title "Bottomless Pit of Eternal Chaos to Redemption pitch" |
---|
3593 | *date 1996.07.11 |
---|
3594 | *team "Nick Proctor" compass clino tape |
---|
3595 | *team "Anthony Day" notes pictures tape |
---|
3596 | *instrument compass "CUCC 2" |
---|
3597 | *instrument clino "CUCC 2" |
---|
3598 | ;Calibration: Cairn-Rock 071 072 071, -22 -22 -22 |
---|
3599 | ; Rock-Cairn 252 251 252, +21 +21 +21 |
---|
3600 | ;Calibration at 161d entrance from cairn nr entrance to |
---|
3601 | ;prominent rock edge lower down. This is different from |
---|
3602 | ;calibration used for thighs survey of 5 July 1996 |
---|
3603 | |
---|
3604 | *export 1 2 |
---|
3605 | |
---|
3606 | ;Tape is 20cm too short |
---|
3607 | *calibrate tape +0.2 |
---|
3608 | |
---|
3609 | 1 2 9.48 208 +08 |
---|
3610 | 2 3 9.30 179 -23 |
---|
3611 | 3 4 2.17 057 +09 |
---|
3612 | 5 4 10.13 263 +78 |
---|
3613 | 5 6 2.10 171 -73 |
---|
3614 | 7 6 7.93 291 +75 |
---|
3615 | *begin |
---|
3616 | *calibrate tape 0 |
---|
3617 | 8 7 35.64 262 +86 ;true length measured for this leg |
---|
3618 | *end |
---|
3619 | 8 9 24.90 - DOWN |
---|
3620 | 10 9 8.61 031 -43 |
---|
3621 | 10 11 2.53 008 -34 |
---|
3622 | 11 12 2.70 286 -20 |
---|
3623 | 13 12 5.36 135 +23 |
---|
3624 | 14 13 1.52 119 -12 |
---|
3625 | 15 14 2.00 036 +13 |
---|
3626 | 16 15 2.10 103 +12 |
---|
3627 | 17 16 1.40 068 -07 |
---|
3628 | 17 18 1.53 285 -42 |
---|
3629 | 19 18 5.20 057 -36 |
---|
3630 | 19 20 2.41 161 -67 |
---|
3631 | 20 21 27.47 - DOWN |
---|
3632 | 21 22 9.30 192 -29 |
---|
3633 | *end chaos</programlisting> |
---|
3634 | |
---|
3635 | </Sect2> |
---|
3636 | |
---|
3637 | <Sect2><Title>Join surveys together</Title> |
---|
3638 | |
---|
3639 | <Para>Once you have more than one survey you need to specify how they |
---|
3640 | link together. To do this use *export to make the stations to be |
---|
3641 | joined accessible in the enclosing survey, then *equate in the |
---|
3642 | enclosing survey to join them together. |
---|
3643 | <!-- FIXME example --> |
---|
3644 | </Para> |
---|
3645 | |
---|
3646 | </Sect2> |
---|
3647 | |
---|
3648 | <Sect2><Title>Organise my surveys</Title> |
---|
3649 | |
---|
3650 | <Para>This is actually a large subject. There are many ways you can |
---|
3651 | organise your data using <Application>Survex</Application>. Take a look at the example dataset |
---|
3652 | for some ideas of ways to go about it. |
---|
3653 | </Para> |
---|
3654 | |
---|
3655 | <Sect3><Title>Fixed Points (Control Points)</Title> |
---|
3656 | |
---|
3657 | <Para>The *fix command is used to specify fixed points (also know as control |
---|
3658 | points). See the description of this command in the "Cavern Commands" |
---|
3659 | section of this manual. |
---|
3660 | </Para> |
---|
3661 | |
---|
3662 | </Sect3> |
---|
3663 | |
---|
3664 | <Sect3><Title>More than one survey per trip</Title> |
---|
3665 | |
---|
3666 | <Para>Suppose you have two separate bits of surveying which were done on the |
---|
3667 | same trip. So the calibration details, etc. are the same for both. But you |
---|
3668 | want to give a different survey name to the two sections. This is easily |
---|
3669 | achieved like so: |
---|
3670 | </Para> |
---|
3671 | |
---|
3672 | <programlisting> |
---|
3673 | *begin |
---|
3674 | *calibrate compass 1.0 |
---|
3675 | *calibrate clino 0.5 |
---|
3676 | *begin altroute |
---|
3677 | ; first survey |
---|
3678 | *end altroute |
---|
3679 | *begin faraway |
---|
3680 | ; second survey |
---|
3681 | *end faraway |
---|
3682 | *end</programlisting> |
---|
3683 | |
---|
3684 | </Sect3> |
---|
3685 | |
---|
3686 | </Sect2> |
---|
3687 | |
---|
3688 | <Sect2><Title>Add surface topography</Title> |
---|
3689 | |
---|
3690 | <Para>Survex 1.2.18 added support for loading terrain data and rendering it as |
---|
3691 | a transparent surface. Currently the main documentation for this is maintained |
---|
3692 | as a <ulink url="https://trac.survex.com/wiki/TerrainData">wiki page</ulink> |
---|
3693 | as this allows us to update it between releases. |
---|
3694 | </Para> |
---|
3695 | |
---|
3696 | <Para> |
---|
3697 | We recommend using this new code in preference, but previously the simplest |
---|
3698 | approach was to generate a <filename>.svx</filename> file with the surface mesh |
---|
3699 | in and display it with the survey data. |
---|
3700 | </Para> |
---|
3701 | |
---|
3702 | <Para> |
---|
3703 | It is possible to generate |
---|
3704 | a mesh or contours overlaying your area by various means. NASA have made |
---|
3705 | 1 arc-second (approximately 30m) terrain data available for the USA for |
---|
3706 | some years, with only 3 arc-second data available for other countries. |
---|
3707 | However, starting in 2014 they're gradually making 1 arc-second data |
---|
3708 | available for more countries. |
---|
3709 | </Para> |
---|
3710 | |
---|
3711 | <Para> |
---|
3712 | If you want a better resolution that this, reading heights from the |
---|
3713 | contours on a map is one approach. It's laborious, but feasible for |
---|
3714 | a small area. |
---|
3715 | </Para> |
---|
3716 | |
---|
3717 | <Para> |
---|
3718 | Details of several methods are given in the BCRA Cave Surveying |
---|
3719 | Group magazine Compass Points issue 11, available online at |
---|
3720 | <ulink url="http://www.chaos.org.uk/survex/cp/CP11/CPoint11.htm#Art_5">http://www.chaos.org.uk/survex/cp/CP11/CPoint11.htm#Art_5</ulink> |
---|
3721 | </Para> |
---|
3722 | |
---|
3723 | <Para>If you're using another program to generate a <filename>.svx</filename> file for the surface |
---|
3724 | mesh, it's best to use the NOSURVEY data style. |
---|
3725 | Simply fix all the grid intersections at the correct |
---|
3726 | coordinates and height, and put legs between them using the NOSURVEY style. |
---|
3727 | Here's a grid of 4 squares and 9 intersections: |
---|
3728 | </Para> |
---|
3729 | |
---|
3730 | <programlisting> |
---|
3731 | *fix 00 000 000 1070 |
---|
3732 | *fix 01 000 100 1089 |
---|
3733 | *fix 02 000 200 1093 |
---|
3734 | |
---|
3735 | *fix 10 100 000 1062 |
---|
3736 | *fix 11 100 100 1080 |
---|
3737 | *fix 12 100 200 1089 |
---|
3738 | |
---|
3739 | *fix 20 200 000 1050 |
---|
3740 | *fix 21 200 100 1065 |
---|
3741 | *fix 22 200 200 1077 |
---|
3742 | |
---|
3743 | *data nosurvey station |
---|
3744 | |
---|
3745 | 00 |
---|
3746 | 01 |
---|
3747 | 02 |
---|
3748 | |
---|
3749 | 10 |
---|
3750 | 11 |
---|
3751 | 12 |
---|
3752 | |
---|
3753 | 20 |
---|
3754 | 21 |
---|
3755 | 22 |
---|
3756 | |
---|
3757 | 00 |
---|
3758 | 10 |
---|
3759 | 20 |
---|
3760 | |
---|
3761 | 01 |
---|
3762 | 11 |
---|
3763 | 21 |
---|
3764 | |
---|
3765 | 02 |
---|
3766 | 12 |
---|
3767 | 22</programlisting> |
---|
3768 | |
---|
3769 | <Para> |
---|
3770 | This is far simpler than trying to create fake tape/compass/clino legs of |
---|
3771 | the right length for each line in the mesh. It's also very fast to process |
---|
3772 | with cavern. |
---|
3773 | </Para> |
---|
3774 | |
---|
3775 | </Sect2> |
---|
3776 | |
---|
3777 | <Sect2><Title>Overlay a grid</Title> |
---|
3778 | |
---|
3779 | <Para>Aven is able to display a grid, but this functionality isn't currently |
---|
3780 | available in printouts. |
---|
3781 | You can achieve a similar effect for now by creating a <filename>.svx</filename> file |
---|
3782 | where the survey legs form a grid. |
---|
3783 | </Para> |
---|
3784 | |
---|
3785 | </Sect2> |
---|
3786 | |
---|
3787 | <Sect2><Title>Import data from other programs</Title> |
---|
3788 | |
---|
3789 | <Para><Application>Survex</Application> supports a number of features to help with importing |
---|
3790 | existing data. You can specify the ordering of items on a line using *Data |
---|
3791 | (see <Application>Survex</Application> Keywords above), and you can specify the characters used |
---|
3792 | to mean different things using *Set (see <Application>Survex</Application> Keywords above). |
---|
3793 | </Para> |
---|
3794 | |
---|
3795 | <Para>The Ignore and Ignoreall options to the *Data command are often |
---|
3796 | particularly useful, e.g. if you have a dataset with LRUD info or comments |
---|
3797 | on the ends of lines. |
---|
3798 | </Para> |
---|
3799 | |
---|
3800 | <Sect3><Title>Changing Meanings of Characters</Title> |
---|
3801 | |
---|
3802 | <Para>e.g. if you have some data with station names containing the |
---|
3803 | characters '?' and '+' (which are not permitted in a name by default) |
---|
3804 | then the command: |
---|
3805 | </Para> |
---|
3806 | |
---|
3807 | <programlisting> |
---|
3808 | *SET NAMES ?+</programlisting> |
---|
3809 | |
---|
3810 | <Para> |
---|
3811 | specifies that question marks and plus signs are permitted in station names. |
---|
3812 | A-Z, a-z, and 0-9 are always permitted. '_' and '-' are also permitted by |
---|
3813 | default, but aren't in this example. |
---|
3814 | </Para> |
---|
3815 | |
---|
3816 | <Para>If your data uses a comma ',' instead of a decimal point, then |
---|
3817 | you use |
---|
3818 | </Para> |
---|
3819 | |
---|
3820 | <programlisting> |
---|
3821 | *SET DECIMAL ,</programlisting> |
---|
3822 | |
---|
3823 | <Para>to specify that ',' is now the decimal separator instead of '.'. |
---|
3824 | </Para> |
---|
3825 | |
---|
3826 | <!-- FIXME |
---|
3827 | <Para>Note that there are plenty of ways you can use this facility to |
---|
3828 | completely confuse the software, as it may not be able to work out what is |
---|
3829 | going on, or it may simply be ambiguous. It can cope with some ambiguity (e.g. |
---|
3830 | the '-' character is used both for 'MINUS' and for 'OMIT'), but there are |
---|
3831 | limits. If you have a dataset that you can not make <Application>Survex</Application> |
---|
3832 | understand, then send it to us, and we will see what can be done. |
---|
3833 | </Para> |
---|
3834 | --> |
---|
3835 | |
---|
3836 | </Sect3> |
---|
3837 | |
---|
3838 | <!-- |
---|
3839 | Nobody seems to have the CfH convertor... |
---|
3840 | but it's probably no longer useful anyway |
---|
3841 | |
---|
3842 | <Sect3><Title>Other Converters</Title> |
---|
3843 | |
---|
3844 | <Para>We have an Excel 5 macro for converting The Lotus 123 spreadsheets |
---|
3845 | used by the German survey software Cad Für Höhlen into |
---|
3846 | <Application>Survex</Application> data files. Other converters may also come to be available. |
---|
3847 | These will normally be available via the |
---|
3848 | <ulink url="https://survex.com/"><Application>Survex</Application> Web pages</ulink>. |
---|
3849 | </Para> |
---|
3850 | |
---|
3851 | </Sect3> |
---|
3852 | --> |
---|
3853 | |
---|
3854 | </Sect2> |
---|
3855 | |
---|
3856 | <Sect2><Title>Export data from <Application>Survex</Application></Title> |
---|
3857 | |
---|
3858 | <Para>See Rosetta Stal in the Related Tools section of the Survex web |
---|
3859 | site. This is a utility written by Taco van Ieperen and Gary Petrie. |
---|
3860 | Note though that this only supports a subset of the svx format, |
---|
3861 | and only work on Microsoft Windows. The Survex support is limited |
---|
3862 | and doesn't understand the more recently added commands.</Para> |
---|
3863 | |
---|
3864 | </Sect2> |
---|
3865 | |
---|
3866 | <Sect2><Title>See errors and warnings that have gone off the screen</Title> |
---|
3867 | |
---|
3868 | <Para>When you run <Application>Survex</Application> it will process the specified survey data |
---|
3869 | files in order, reporting any warnings and errors. If there are no |
---|
3870 | errors, the output files are written and various statistics about the |
---|
3871 | survey are displayed. If there are a lot of warnings or errors, they can |
---|
3872 | scroll off the screen and it's not always possible to scroll back to |
---|
3873 | read them. |
---|
3874 | </Para> |
---|
3875 | |
---|
3876 | <Para>The easiest way to see all the text is to use <command>cavern |
---|
3877 | --log</command> to redirect output to a <filename>.log</filename> file, |
---|
3878 | which you can then inspect with a text editor. |
---|
3879 | </Para> |
---|
3880 | |
---|
3881 | <!-- <command>cavern cavename > tmpfile</command> --> |
---|
3882 | |
---|
3883 | </Sect2> |
---|
3884 | |
---|
3885 | <Sect2><Title>Create an Extended Elevation</Title> |
---|
3886 | |
---|
3887 | <Para>Use the Extend program. This takes <filename>.3d</filename> files and |
---|
3888 | 'flattens' them. See 'Extend' for details. |
---|
3889 | </Para> |
---|
3890 | |
---|
3891 | </Sect2> |
---|
3892 | |
---|
3893 | </Sect1> |
---|
3894 | |
---|
3895 | <!-- |
---|
3896 | <Sect1><Title>Appendices</Title> |
---|
3897 | <?dbhtml filename="appendix.htm"> |
---|
3898 | |
---|
3899 | <Para>Files provided |
---|
3900 | </Para> |
---|
3901 | |
---|
3902 | <Para>Command specification |
---|
3903 | </Para> |
---|
3904 | |
---|
3905 | </Sect1> |
---|
3906 | --> |
---|
3907 | <Sect1><Title>Working with Larry Fish's Compass</Title> |
---|
3908 | <?dbhtml filename="compass.htm"> |
---|
3909 | |
---|
3910 | <Para> |
---|
3911 | Survex can read Compass survey data - both raw data (.DAT and .MAK |
---|
3912 | files) and processed survey data (.PLT and .PLF files). You can even |
---|
3913 | use <command>*include compassfile.dat</command> in a <filename>.svx</filename> file and |
---|
3914 | it'll work! |
---|
3915 | </Para> |
---|
3916 | |
---|
3917 | <Para> |
---|
3918 | One point to note (this tripped us up!): station names in DAT files are |
---|
3919 | case sensitive and so Survex reads DAT files with the equivalent of |
---|
3920 | <command>*case preserve</command>. The default in SVX files is |
---|
3921 | <command>*case lower</command>. So this won't work: |
---|
3922 | |
---|
3923 | <programlisting> |
---|
3924 | *fix CE1 0 0 0 |
---|
3925 | *include datfilewhichusesCE1.dat</programlisting> |
---|
3926 | |
---|
3927 | Because the CE1 in the *fix is actually interpreted as ce1. This is |
---|
3928 | what you have to do: |
---|
3929 | |
---|
3930 | <programlisting> |
---|
3931 | *begin |
---|
3932 | *case preserve |
---|
3933 | *fix CE1 0 0 0 |
---|
3934 | *include datfilewhichusesCE1.dat |
---|
3935 | *end</programlisting> |
---|
3936 | </Para> |
---|
3937 | |
---|
3938 | </Sect1> |
---|
3939 | |
---|
3940 | <Sect1><Title>Mailing List</Title> |
---|
3941 | <?dbhtml filename="maillist.htm"> |
---|
3942 | |
---|
3943 | <Para>The best way to contact the authors and other Survex users is the |
---|
3944 | Survex mailing list - for details visit: |
---|
3945 | <ulink url="https://survex.com/maillist.html">https://survex.com/maillist.html</ulink> |
---|
3946 | </Para> |
---|
3947 | |
---|
3948 | <Para>We'd be delighted to hear how you get on with <Application>Survex</Application> and |
---|
3949 | welcome comments and suggestions for improvements.</Para> |
---|
3950 | |
---|
3951 | <Para> |
---|
3952 | And we'd love you to contribute your skills to help make <Application>Survex</Application> even |
---|
3953 | better. Point out areas of the documentation which could be made clearer, or |
---|
3954 | sections which are missing entirely. Download test releases, try them out, and |
---|
3955 | let us know if you find problems or have suggestions for improvements. |
---|
3956 | If there's no translation to your language, you could provide one. |
---|
3957 | Or if you're a developer, <emphasis>"Say it with code"</emphasis>. There's |
---|
3958 | plenty to do, so feel free to join in. |
---|
3959 | </Para> |
---|
3960 | |
---|
3961 | </Sect1> |
---|
3962 | |
---|
3963 | <Sect1><Title>Future Developments</Title> |
---|
3964 | <?dbhtml filename="future.htm"> |
---|
3965 | |
---|
3966 | <Para> |
---|
3967 | Now that <Application>Survex</Application> has reached version 1.0, we are continuing progress |
---|
3968 | towards version 2, in a series of steps, evolving out of |
---|
3969 | Survex 1.0. The GUI framework is being based on aven, with |
---|
3970 | the printer drivers and other utility programs being pulled in |
---|
3971 | and integrated into the menus.</Para> |
---|
3972 | |
---|
3973 | <Para>Aven is built on <Application>wxWidgets</Application>, which means that it can easily support |
---|
3974 | Unix, Microsoft Windows, and Mac OS X.</Para> |
---|
3975 | |
---|
3976 | <Para>More information on our plans is on the <ulink |
---|
3977 | url="https://survex.com/">web site</ulink>. |
---|
3978 | </Para> |
---|
3979 | |
---|
3980 | </Sect1> |
---|
3981 | |
---|
3982 | </article> |
---|