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