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