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