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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
|
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Dimensions — HARP 1.5 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="next" title="Global attributes" href="global_attributes.html" />
<link rel="prev" title="Data types" href="datatypes.html" />
<script src="../_static/js/modernizr.min.js"></script>
</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">
<a href="../index.html" class="icon icon-home"> HARP
</a>
<div class="version">
1.5
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Conventions</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="datatypes.html">Data types</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Dimensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="global_attributes.html">Global attributes</a></li>
<li class="toctree-l2"><a class="reference internal" href="variable_attributes.html">Variable attributes</a></li>
<li class="toctree-l2"><a class="reference internal" href="variables.html">Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="variable_names.html">Variable names</a></li>
<li class="toctree-l2"><a class="reference internal" href="categorical_variables.html">Categorical Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="datetime.html">Datetime values</a></li>
<li class="toctree-l2"><a class="reference internal" href="filenames.html">File naming</a></li>
<li class="toctree-l2"><a class="reference internal" href="netcdf3.html">netCDF-3</a></li>
<li class="toctree-l2"><a class="reference internal" href="hdf4.html">HDF4</a></li>
<li class="toctree-l2"><a class="reference internal" href="hdf5.html">HDF5/netCDF-4</a></li>
<li class="toctree-l2"><a class="reference internal" href="compatibility.html">Compatibility with other standards</a></li>
<li class="toctree-l2"><a class="reference internal" href="collocation_result.html">Collocation result file</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../algorithms/index.html">Algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="../operations.html">Operations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ingestions/index.html">Ingestion definitions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../libharp.html">C library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../idl.html">IDL interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../matlab.html">MATLAB interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../python.html">Python interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tools.html">Command line tools</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">HARP</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> »</li>
<li><a href="index.html">Conventions</a> »</li>
<li>Dimensions</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="dimensions">
<h1>Dimensions</h1>
<p>HARP has strict rules regarding the dimensions of variables. Each dimension of a variable may be used to represent a
physical dimension (such as time, latitude, longitude, height, etcetera), or it may be used as an independent dimension.</p>
<p>Only dimension types supported by HARP can be used. These types are:</p>
<dl class="docutils">
<dt><code class="docutils literal notranslate"><span class="pre">time</span></code></dt>
<dd>Temporal dimension; this is also the only appendable dimension.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">vertical</span></code></dt>
<dd>Vertical dimension, indicating height or depth.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">spectral</span></code></dt>
<dd>Spectral dimension, associated with wavelength, wavenumber, or frequency.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">latitude</span></code></dt>
<dd>Latitude dimension, only to be used for the latitude axis of a regular latitude x longitude grid.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">longitude</span></code></dt>
<dd>Longitude dimension, only to be used for the longitude axis of a regular latitude x longitude grid.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">independent</span></code></dt>
<dd>Independent dimension, used to index other quantities, such as the corner coordinates of ground pixel polygons.</dd>
</dl>
<p>Within a HARP product, all dimensions of the same type should have the same length, <em>except</em> independent dimensions. For
example, it is an error to have two variables within the same product that both have a time dimension, yet of a
different length.</p>
<p>A variable with more than one dimension has to use a fixed ordering of the dimensions. In the HARP documentation the
ordering is always documented using the so-called ‘C convention’ for dimension ordering. Using the C convention, the
last dimension (writing from left to right) is the fastest running dimension when enumerating all elements, compared to
the Fortran convention, where the first dimension is the fastest running dimension. Note that different file access
libraries may have different conventions with regard to how they deal with array ordering in their function interfaces.</p>
<p>The order in which dimensions need to be provided for a variable is defined by the following rules:</p>
<blockquote>
<div><ul class="simple">
<li>If present, the <code class="docutils literal notranslate"><span class="pre">time</span></code> dimension is always the first (i.e. slowest running) dimension.</li>
<li>Next are categorical dimensions used for grouping. For instance, this can be the <code class="docutils literal notranslate"><span class="pre">spectral</span></code> dimension when it is
used to distinguish between retrievals performed using different choices of wavelength, or to distinguish data from
different spectral bands.</li>
<li>Next are the spatial dimensions, ordered as <code class="docutils literal notranslate"><span class="pre">latitude</span></code>, <code class="docutils literal notranslate"><span class="pre">longitude</span></code>, <code class="docutils literal notranslate"><span class="pre">vertical</span></code>.</li>
<li>Next is the <code class="docutils literal notranslate"><span class="pre">spectral</span></code> dimension when it is used as an actual axis (e.g. for L1 spectral data for instruments that
measure along a spectral axis).</li>
<li>Any independent dimensions come last (i.e. they will always be the fastest running dimensions).</li>
</ul>
</div></blockquote>
<p>So, for a spectral axis used for grouping, the ordering should be:</p>
<blockquote>
<div><code class="docutils literal notranslate"><span class="pre">time</span></code>, <code class="docutils literal notranslate"><span class="pre">spectral</span></code>, <code class="docutils literal notranslate"><span class="pre">latitude</span></code>, <code class="docutils literal notranslate"><span class="pre">longitude</span></code>, <code class="docutils literal notranslate"><span class="pre">vertical</span></code>, <code class="docutils literal notranslate"><span class="pre">independent</span></code></div></blockquote>
<p>And, for a spectral axis used for L1 data from spectral instruments, the ordering should be:</p>
<blockquote>
<div><code class="docutils literal notranslate"><span class="pre">time</span></code>, <code class="docutils literal notranslate"><span class="pre">latitude</span></code>, <code class="docutils literal notranslate"><span class="pre">longitude</span></code>, <code class="docutils literal notranslate"><span class="pre">vertical</span></code>, <code class="docutils literal notranslate"><span class="pre">spectral</span></code>, <code class="docutils literal notranslate"><span class="pre">independent</span></code></div></blockquote>
<p>A variable should only use dimensions on which it is dependent. This means that the radiance variable for L1 data of a
nadir looking spectral instrument on a satellite will generally only have the dimensions <code class="docutils literal notranslate"><span class="pre">time</span></code> and <code class="docutils literal notranslate"><span class="pre">spectral</span></code> (and
not <code class="docutils literal notranslate"><span class="pre">latitude</span></code>, <code class="docutils literal notranslate"><span class="pre">longitude</span></code>, <code class="docutils literal notranslate"><span class="pre">vertical</span></code>, or <code class="docutils literal notranslate"><span class="pre">independent</span></code>).</p>
<p>Note that only a single grid can be used for each type of dimension per time value. This means that, for example, it is
possible to change the vertical grid from sample to sample, but it is not possible to use different vertical grids
for the <em>same</em> sample.</p>
<p>To allow a different vertical grid from sample to sample, the <code class="docutils literal notranslate"><span class="pre">altitude</span></code> variable should have dimensions
<code class="docutils literal notranslate"><span class="pre">{time,vertical}</span></code> (instead of <code class="docutils literal notranslate"><span class="pre">{vertical}</span></code>). This way, the altitude values for the first sample, <code class="docutils literal notranslate"><span class="pre">altitude[0,:]</span></code>,
may differ from the altitude values for the second sample, <code class="docutils literal notranslate"><span class="pre">altitude[1,:]</span></code>, and so on. However, for an averaging
kernel, which has dimensions <code class="docutils literal notranslate"><span class="pre">{time,vertical,vertical}</span></code>, the altitude values for both vertical dimensions are
necessarily the same for each single sample.</p>
<p>A grid that differs from sample to sample could have a different effective length per sample. This is implemented by
taking the maximum length over all samples as the length of the dimension and padding the dimension for each sample at
the end with ‘invalid’ values (e.g. <code class="docutils literal notranslate"><span class="pre">NaN</span></code>). For instance, you can have an <code class="docutils literal notranslate"><span class="pre">altitude{time,vertical}</span></code> variable where
<code class="docutils literal notranslate"><span class="pre">altitude[0,:]</span></code> has 7 levels and equals <code class="docutils literal notranslate"><span class="pre">[0,</span> <span class="pre">5,</span> <span class="pre">10,</span> <span class="pre">15,</span> <span class="pre">20,</span> <span class="pre">25,</span> <span class="pre">30]</span></code> and <code class="docutils literal notranslate"><span class="pre">altitude[1,:]</span></code> has only 6 levels and
equals <code class="docutils literal notranslate"><span class="pre">[0,</span> <span class="pre">6,</span> <span class="pre">12,</span> <span class="pre">18,</span> <span class="pre">24,</span> <span class="pre">30,</span> <span class="pre">NaN]</span></code>.</p>
<p>Operations performed by HARP will determine the effective length of a dimension for each sample by ignoring all trailing
<code class="docutils literal notranslate"><span class="pre">NaN</span></code> values of the axis variable that is used for the operation (e.g. the <code class="docutils literal notranslate"><span class="pre">altitude</span></code> or <code class="docutils literal notranslate"><span class="pre">pressure</span></code> variable for a
vertical dimension or the <code class="docutils literal notranslate"><span class="pre">wavelength</span></code> or <code class="docutils literal notranslate"><span class="pre">wavenumber</span></code> variable for a spectral dimension).</p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="global_attributes.html" class="btn btn-neutral float-right" title="Global attributes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="datatypes.html" class="btn btn-neutral" title="Data types" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2015-2018 S&T, The Netherlands
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script async="async" type="text/javascript" src="/usr/share/javascript/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|
