aboutsummaryrefslogtreecommitdiff
path: root/operations/conversions/pop.html
blob: dc8680d507b230b3dc82207cda06e08c8cf38c58 (plain)
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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Pop coordinate value to pipeline stack &mdash; PROJ 9.0.0 documentation</title>
      <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
    <link rel="shortcut icon" href="../../_static/favicon.png"/>
    <link rel="canonical" href="https://proj.orgoperations/conversions/pop.html"/>
  <!--[if lt IE 9]>
    <script src="../../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
        <script src="../../_static/jquery.js"></script>
        <script src="../../_static/underscore.js"></script>
        <script src="../../_static/doctools.js"></script>
    <script src="../../_static/js/theme.js"></script>
    <link rel="author" title="About these documents" href="../../about.html" />
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="Push coordinate value to pipeline stack" href="push.html" />
    <link rel="prev" title="No operation" href="noop.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search"  style="background: #353130" >
            <a href="../../index.html">
            <img src="../../_static/logo.png" class="logo" alt="Logo"/>
          </a>
              <div class="version">
                9.0.0
              </div>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../about.html">About</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../news.html">News</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../download.html">Download</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../usage/index.html">Using PROJ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../apps/index.html">Applications</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Coordinate operations</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../projections/index.html">Projections</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Conversions</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="axisswap.html">Axis swap</a></li>
<li class="toctree-l3"><a class="reference internal" href="cart.html">Geodetic to cartesian conversion</a></li>
<li class="toctree-l3"><a class="reference internal" href="geoc.html">Geocentric Latitude</a></li>
<li class="toctree-l3"><a class="reference internal" href="latlon.html">Lat/long (Geodetic alias)</a></li>
<li class="toctree-l3"><a class="reference internal" href="noop.html">No operation</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Pop coordinate value to pipeline stack</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#examples">Examples</a></li>
<li class="toctree-l4"><a class="reference internal" href="#parameters">Parameters</a></li>
<li class="toctree-l4"><a class="reference internal" href="#further-reading">Further reading</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="push.html">Push coordinate value to pipeline stack</a></li>
<li class="toctree-l3"><a class="reference internal" href="set.html">Set coordinate value</a></li>
<li class="toctree-l3"><a class="reference internal" href="topocentric.html">Geocentric to topocentric conversion</a></li>
<li class="toctree-l3"><a class="reference internal" href="unitconvert.html">Unit conversion</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../transformations/index.html">Transformations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../pipeline.html">The pipeline operator</a></li>
<li class="toctree-l2"><a class="reference internal" href="../operations_computation.html">Computation of coordinate operations between two CRS</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../resource_files.html">Resource files</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../geodesic.html">Geodesic calculations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../specifications/index.html">Specifications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../community/index.html">Community</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../zreferences.html">References</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu"  style="background: #353130" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../index.html">PROJ</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
          <li><a href="../index.html">Coordinate operations</a> &raquo;</li>
          <li><a href="index.html">Conversions</a> &raquo;</li>
      <li>Pop coordinate value to pipeline stack</li>
      <li class="wy-breadcrumbs-aside">
              <a href="https://github.com/OSGeo/PROJ/edit/8.2/docs/source/operations/conversions/pop.rst" class="fa fa-github"> Edit on GitHub</a>
      </li>
  </ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation">
        <a href="noop.html" class="btn btn-neutral float-left" title="No operation" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="push.html" class="btn btn-neutral float-right" title="Push coordinate value to pipeline stack" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  </div>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="pop-coordinate-value-to-pipeline-stack">
<span id="pop"></span><h1>Pop coordinate value to pipeline stack<a class="headerlink" href="#pop-coordinate-value-to-pipeline-stack" title="Permalink to this headline">¶</a></h1>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.0.</span></p>
</div>
<p>Retrieve components of a coordinate that was saved in a previous pipeline step.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 27%" />
<col style="width: 73%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><strong>Alias</strong></p></td>
<td><p>pop</p></td>
</tr>
<tr class="row-even"><td><p><strong>Domain</strong></p></td>
<td><p>4D</p></td>
</tr>
<tr class="row-odd"><td><p><strong>Input type</strong></p></td>
<td><p>Any</p></td>
</tr>
<tr class="row-even"><td><p><strong>Output type</strong></p></td>
<td><p>Any</p></td>
</tr>
</tbody>
</table>
<p>This operations makes it possible to retrieve coordinate components that was
saved in previous pipeline steps. A retrieved coordinate component is loaded,
or <em>popped</em>, from a memory stack that is part of a <a class="reference internal" href="../pipeline.html#pipeline"><span class="std std-ref">pipeline</span></a>.
The pipeline coordinate stack is inspired by the stack data structure that is
commonly used in computer science. There’s four stacks available: One four each
coordinate dimension. The dimensions, or coordinate components, are numbered
1–4. It is only possible to move data to and from the stack within the same
coordinate component number. Values can be saved to the stack by using the
<a class="reference internal" href="push.html#push"><span class="std std-ref">push operation</span></a>.</p>
<p>If the pop operation is used by itself, e.g. not in a pipeline, it will
function as a no-operation that passes the coordinate through unchanged.
Similarly, if no coordinate component is available on the stack to be popped
the operation does nothing.</p>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<p>A common use of the <a class="reference internal" href="push.html#push"><span class="std std-ref">push</span></a> and pop operations is in 3D
<a class="reference internal" href="../transformations/helmert.html#helmert"><span class="std std-ref">Helmert</span></a> transformations where only the horizontal components
are needed. This is often the case when combining heights from a legacy
vertical reference with a modern geocentric reference. Below is a an example of
such a transformation, where the horizontal part is transformed with a Helmert
operation but the vertical part is kept exactly as the input was.</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>$ echo 12 56 12.3 2020 | cct +proj=pipeline  \
+step +proj=push +v_3                        \
+step +proj=cart +ellps=GRS80                \
+step +proj=helmert +x=3000 +y=1000 +z=2000  \
+step +proj=cart +ellps=GRS80 +inv           \
+step +proj=pop +v_3                         \

 12.0056753463   55.9866540552       12.3000     2000.0000
</pre></div>
</div>
<p>Note that the third coordinate component in the output is the same as the input.</p>
<p>The same transformation without the push and pop operations would look like this:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>$ echo 12 56 12.3 2020 | cct +proj=pipeline  \
+step +proj=cart +ellps=GRS80                \
+step +proj=helmert +x=3000 +y=1000 +z=2000  \
+step +proj=cart +ellps=GRS80 +inv           \

      12.0057        55.9867     3427.7404     2000.0000
</pre></div>
</div>
<p>Here the vertical component is adjusted significantly.</p>
</section>
<section id="parameters">
<h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-arg-v_1">
<span id="cmdoption-arg-v-1"></span><span class="sig-name descname"><span class="pre">+v_1</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-arg-v_1" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves the first coordinate component from the pipeline stack</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-arg-v_2">
<span id="cmdoption-arg-v-2"></span><span class="sig-name descname"><span class="pre">+v_2</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-arg-v_2" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves the second coordinate component from the pipeline stack</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-arg-v_3">
<span id="cmdoption-arg-v-3"></span><span class="sig-name descname"><span class="pre">+v_3</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-arg-v_3" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves the third coordinate component from the pipeline stack</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-arg-v_4">
<span id="cmdoption-arg-v-4"></span><span class="sig-name descname"><span class="pre">+v_4</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-arg-v_4" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves the fourth coordinate component from the pipeline stack</p>
</dd></dl>

</section>
<section id="further-reading">
<h2>Further reading<a class="headerlink" href="#further-reading" title="Permalink to this headline">¶</a></h2>
<ol class="arabic simple">
<li><p><a class="reference external" href="https://en.wikipedia.org/wiki/Stack_(abstract_data_type)">Stack data structure on Wikipedia</a></p></li>
</ol>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="noop.html" class="btn btn-neutral float-left" title="No operation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="push.html" class="btn btn-neutral float-right" title="Push coordinate value to pipeline stack" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 1983-2022.
      <span class="lastupdated">Last updated on 22 Mar 2022.
      </span></p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>