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