File: aven.htm

package info (click to toggle)
survex 1.4.17-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 14,268 kB
  • sloc: ansic: 21,446; cpp: 18,495; sh: 5,401; javascript: 831; perl: 755; makefile: 610; python: 83; xml: 35
file content (224 lines) | stat: -rw-r--r-- 13,959 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
<!DOCTYPE html>

<html lang="en" data-content_root="./">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

    <title>aven &#8212; Survex 1.4.17 documentation</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
    <script src="_static/documentation_options.js?v=91e0adf2"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <link rel="index" title="Index" href="genindex.htm" />
    <link rel="search" title="Search" href="search.htm" />
   
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  

  
  

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <section id="aven">
<h1>aven<a class="headerlink" href="#aven" title="Link to this heading">¶</a></h1>
<section id="synopsis">
<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Link to this heading">¶</a></h2>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">aven</span></code> [–survey=<cite>SURVEY</cite>] [–print] <cite>SURVEY_FILE</cite></p>
</div></blockquote>
</section>
<section id="description">
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Link to this heading">¶</a></h2>
<p>Aven displays processed cave surveys in a window and allows you to
manipulate the view.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">SURVEY_FILE</span></code> is an unprocessed survey data format which <code class="docutils literal notranslate"><span class="pre">cavern</span></code>
can process, then <code class="docutils literal notranslate"><span class="pre">aven</span></code> will run <code class="docutils literal notranslate"><span class="pre">cavern</span></code> on it, and if successful,
display the processed data.  If there are any warnings and errors, it will
show a log window with the output with clickable links to open the affected
file at the problematic line.</p>
<p><code class="docutils literal notranslate"><span class="pre">SURVEY_FILE</span></code> can also be processed survey data - a Survex <code class="docutils literal notranslate"><span class="pre">.3d</span></code> file, a
Compass <code class="docutils literal notranslate"><span class="pre">.plt</span></code> file or a CMAP <code class="docutils literal notranslate"><span class="pre">.sht</span></code> file.  It can also be a Survex
<code class="docutils literal notranslate"><span class="pre">.pos</span></code> file or a CMP <code class="docutils literal notranslate"><span class="pre">.una</span></code> or <code class="docutils literal notranslate"><span class="pre">.adj</span></code> file, but for these only
stations are shown, not any legs (for <code class="docutils literal notranslate"><span class="pre">.pos</span></code> this is because the format
only records station positions).  (All Survex programs which read <code class="docutils literal notranslate"><span class="pre">.3d</span></code>
files can also transparently handle these formats.)</p>
<section id="on-screen-indicators">
<h3>On-Screen Indicators<a class="headerlink" href="#on-screen-indicators" title="Link to this heading">¶</a></h3>
<p>There is an auto-resizing scale bar along the bottom of the screen
which varies in length as you zoom in or out.  You can left-button drag
on this to zoom, and right click gives a menu to select units or hide
the scale bar (to get it back go to the Control-&gt;Indicators menu from
the menu bar).</p>
<p>In the lower right corner is a compass indicator showing which way is North.
You can drag this to rotate the view; if while dragging you move the mouse
outside the compass the view snaps to 45° positions: N/NE/E/SE/S/SW/W/NW.
Right click gives menu to change the view to N/S/E/W, select units, or
hide the compass (to get it back go to the Control-&gt;Indicators menu from
the menu bar).</p>
<p>Just to the left of the compass is clino indicator showing the angle of tilt.
You can drag this to tilt the view; if while dragging you move the mouse
outside the clino the view snaps to 90° positions: plan/elevation/inverted
plan.  Right click gives menu to change the view to plan/elevation, select
units, or hide the clino (to get it back go to the Control-&gt;Indicators menu
from the menu bar).</p>
<p>In the upper right is a colour key showing the correspondence between colour
and depth (by default - you can also colour by other criteria).  Right click
gives a menu to choose what to colour by, select units, or hide the colour
key (to get it back go to the Control-&gt;Indicators menu from the menu bar).</p>
</section>
<section id="mouse-control">
<h3>Mouse Control<a class="headerlink" href="#mouse-control" title="Link to this heading">¶</a></h3>
<p>Using the mouse to move the cave will probably feel most natural.  We suggest
you try each of these out after reading this section to get a feel for how they
work.</p>
<p>If you hold down the right button then the view is panned when you move the
mouse - it effectively feels like you are dragging the cave around.</p>
<p>If you hold down the left button, then the view is rotated as you move left or
right, and zoomed as you move up and down.  If you hold down <code class="docutils literal notranslate"><span class="pre">Ctrl</span></code> while
dragging with the left mouse button, then moving up and down instead tilts the
view.  Tilt goes 180 degrees from plan view through elevation view to a view
from directly below (upside down plan) - aven deliberately doesn’t allow going
beyond horizontal into an inverted view.</p>
<p>If your mouse has a middle button then holding it down and moving the mouse up
and down tilts the cave.  Moving the mouse left and right has no effect.</p>
<p>And if you have a scrollwheel, this can be used to zoom in/out.</p>
<p>By default the mouse moves the cave, but if you press <code class="docutils literal notranslate"><span class="pre">Ctrl-R</span></code>, then the
mouse will move the viewpoint instead (i.e. everything will go in the opposite
direction).  Apparently this feels more natural to some people.</p>
</section>
<section id="keyboard-control">
<h3>Keyboard Control<a class="headerlink" href="#keyboard-control" title="Link to this heading">¶</a></h3>
<p>As with mouse controls, a little experimentation should give a better
understanding of how these work.</p>
<p>All keyboard shortcuts have a corresponding menu items which should show the
keyboard shortcut - this provides a way within the application to see the
keyboard shortcut for a particular action.</p>
<p><code class="docutils literal notranslate"><span class="pre">Delete</span></code> is useful if you get lost!  It resets the scale, position, and
rotation speed, so that the cave returns to the centre of the screen.  There
are also keyboard controls to use</p>
<p><code class="docutils literal notranslate"><span class="pre">P</span></code> and <code class="docutils literal notranslate"><span class="pre">L</span></code> select Plan and eLevation respectively.  Changing between plan
to elevation is animated to help you see where you are and how things relate.
This animation is automatically disabled on slow machines to avoid user
frustration.  You can force skipping the animation by pressing the key again
during it, so a double press will always take you there quickly.</p>
<p><code class="docutils literal notranslate"><span class="pre">Space</span></code> toggles on and off automatic rotation about a vertical axis through
the current centre point (which is moved by panning the view or by selecting
a station or survey).  <code class="docutils literal notranslate"><span class="pre">R</span></code> toggles the direction of auto-rotation.  The speed
of auto-rotation can be controlled by <code class="docutils literal notranslate"><span class="pre">Z</span></code> and <code class="docutils literal notranslate"><span class="pre">X</span></code>.</p>
<p>Crosses and/or labels can be displayed at survey stations.  <code class="docutils literal notranslate"><span class="pre">Ctrl-X</span></code> toggles
crosses and <code class="docutils literal notranslate"><span class="pre">Ctrl-N</span></code> station names.  <code class="docutils literal notranslate"><span class="pre">Ctrl-L</span></code> toggles the display of survey
legs and <code class="docutils literal notranslate"><span class="pre">Ctrl-F</span></code> of surface survey legs.</p>
<p><code class="docutils literal notranslate"><span class="pre">Ctrl-G</span></code> toggles display of an auto-sizing grid.</p>
<p><code class="docutils literal notranslate"><span class="pre">Ctrl-B</span></code> toggles display of a bounding box.</p>
<p><code class="docutils literal notranslate"><span class="pre">O</span></code> toggles display of non-overlapping/all names.  For a large survey turning
on overlapping names will make update rather slow.</p>
<p>Holding down <code class="docutils literal notranslate"><span class="pre">Shift</span></code> accelerates all the following movement keys:</p>
<p>The cursor keys pan the survey view (like dragging with the right mouse button).</p>
<p><code class="docutils literal notranslate"><span class="pre">Ctrl</span></code> plus cursor keys rotate and tilt (like the mouse left button with
<code class="docutils literal notranslate"><span class="pre">Ctrl</span></code> held down).  <code class="docutils literal notranslate"><span class="pre">C</span></code>/<code class="docutils literal notranslate"><span class="pre">V</span></code> do the same as <code class="docutils literal notranslate"><span class="pre">Ctrl</span></code> plus cursor
left/right, while Apostrophe <code class="docutils literal notranslate"><span class="pre">'</span></code>, and Slash <code class="docutils literal notranslate"><span class="pre">/</span></code> do the same as <code class="docutils literal notranslate"><span class="pre">Ctrl</span></code>
plus cursor up/down.</p>
<p><code class="docutils literal notranslate"><span class="pre">[</span></code> and <code class="docutils literal notranslate"><span class="pre">]</span></code> zoom out and in respectively.</p>
</section>
</section>
<section id="options">
<h2>OPTIONS<a class="headerlink" href="#options" title="Link to this heading">¶</a></h2>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">-p</span></code>, <code class="docutils literal notranslate"><span class="pre">--print</span></code></dt><dd><p>Load the specified file, open the print dialog to allow printing, then exit.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-s</span></code>, <code class="docutils literal notranslate"><span class="pre">--survey=</span></code><cite>SURVEY</cite></dt><dd><p>Only load the sub-survey <cite>SURVEY</cite>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--help</span></code></dt><dd><p>display short help and exit</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--version</span></code></dt><dd><p>output version information and exit</p>
</dd>
</dl>
</section>
</section>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.htm">Survex</a></h1>








<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.htm">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="getstart.htm">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="cmdline.htm">Survex Programs</a></li>
<li class="toctree-l1"><a class="reference internal" href="datafile.htm">Survex data files</a></li>
<li class="toctree-l1"><a class="reference internal" href="svxhowto.htm"><code class="docutils literal notranslate"><span class="pre">.svx</span></code> Cookbook</a></li>
<li class="toctree-l1"><a class="reference internal" href="genhowto.htm">General: How do I?</a></li>
<li class="toctree-l1"><a class="reference internal" href="compass.htm">Larry Fish’s Compass</a></li>
<li class="toctree-l1"><a class="reference internal" href="walls.htm">David McKenzie’s Walls</a></li>
<li class="toctree-l1"><a class="reference internal" href="cmap.htm">Bob Thrun’s CMAP</a></li>
<li class="toctree-l1"><a class="reference internal" href="img.htm">Using the img library</a></li>
<li class="toctree-l1"><a class="reference internal" href="maillist.htm">Mailing List</a></li>
<li class="toctree-l1"><a class="reference internal" href="future.htm">Future Developments</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="index.htm">Documentation overview</a><ul>
  </ul></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.htm" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &#169;1998-2025.
      
      |
      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
      
    </div>

    

    
  </body>
</html>