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
|
<!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>Variable attributes — HARP 1.16 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="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[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/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="next" title="Variables" href="variables.html" />
<link rel="prev" title="Global attributes" href="global_attributes.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" >
<a href="../index.html" class="icon icon-home"> HARP
</a>
<div class="version">
1.16
</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="../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"><a class="reference internal" href="dimensions.html">Dimensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="global_attributes.html">Global attributes</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">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="axis_variables.html">Axis variables</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="../R.html">R 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="Mobile navigation menu" >
<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="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> »</li>
<li><a href="index.html">Conventions</a> »</li>
<li>Variable attributes</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">
<section id="variable-attributes">
<h1>Variable attributes</h1>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">description</span></code> string (optional)</dt><dd><p>This attribute provides a human readable description of the content of the variable. It should make clear what the
source of the data was (e.g. measured, climatology, derived, etcetera).</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">dims</span></code> string (optional)</dt><dd><p>This attribute is only applicable for <a class="reference internal" href="hdf4.html"><span class="doc">HDF4</span></a> files (<a class="reference internal" href="netcdf3.html"><span class="doc">netCDF-3</span></a> uses named dimensions and
<a class="reference internal" href="hdf5.html"><span class="doc">HDF5</span></a> uses dimension scales).
This attribute stores the type of each dimension of the associated variable as a comma-separated list of
dimension type names. The number of dimension types should equal the number of dimensions of the variable.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">units</span></code> string (optional)</dt><dd><p>This attribute is used for data that has a physical unit. It should provide the unit in a form compatible with the
<code class="docutils literal notranslate"><span class="pre">udunits2</span></code> software. A <code class="docutils literal notranslate"><span class="pre">units</span></code> attribute is expected to be available for any variable defining a quantity.
If a variable represents a dimensionless quantity the <code class="docutils literal notranslate"><span class="pre">units</span></code> string should be an empty string (or have the value
<code class="docutils literal notranslate"><span class="pre">1</span></code> in case empty strings are not supported). The plural attribute name <code class="docutils literal notranslate"><span class="pre">units</span></code> is only used when storing HARP
data in a file (for compatibility reasons with other standards such as netCDF-CF); inside data structures of HARP
variables within C, Python, etc. the (more accurate) singular term <code class="docutils literal notranslate"><span class="pre">unit</span></code> is used.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">valid_min</span></code> [int8, int16, int32, float, double] (optional)</dt><dd><p>Provides the minimum value below which the data is to be considered invalid. The data type of this attribute should
match the data type of the associated variable. This attribute is <em>not</em> allowed to be present for variables of type
<em>string</em>. For variables of numeric type, this attribute should only be present if the variable actually contains
values below this threshold that are to be interpreted as <cite>missing</cite> or <cite>invalid</cite> values.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">valid_max</span></code> [int8, int16, int32, float, double] (optional)</dt><dd><p>Provides the maximum value above which the data is to be considered invalid. The data type of this attribute should
match the data type of the associated variable. This attribute is <em>not</em> allowed to be present for variables of type
<em>string</em>. For variables of numeric type, this attribute should only be present if the variable actually contains
values above this threshold that are to be interpreted as <cite>missing</cite> or <cite>invalid</cite> values.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">enum_name</span></code>/<code class="docutils literal notranslate"><span class="pre">flag_meanings</span></code> [string] (optional)</dt><dd><p>Provides the list of string values of the enumeration labels of a categorical variable. For the in-memory
representation (C, Python, etc.) this attribute is called <code class="docutils literal notranslate"><span class="pre">enum_name</span></code> and consists of a list of strings.
Within a <a class="reference internal" href="netcdf3.html"><span class="doc">netCDF-3</span></a>, <a class="reference internal" href="hdf4.html"><span class="doc">HDF4</span></a>, or <a class="reference internal" href="hdf5.html"><span class="doc">HDF5</span></a> file this attribute is stored as a
single string attribute named <code class="docutils literal notranslate"><span class="pre">flag_meanings</span></code> which contains a space separated list of the label names.</p>
</dd>
</dl>
<p>Note that <code class="docutils literal notranslate"><span class="pre">_FillValue</span></code> is not used by HARP. Whether a value is valid is purely determined by the <code class="docutils literal notranslate"><span class="pre">valid_min</span></code> and
<code class="docutils literal notranslate"><span class="pre">valid_max</span></code> attributes.</p>
<p>Note that files using the HARP data format can include variable attributes in addition to the ones mentioned above
(such as e.g. a <code class="docutils literal notranslate"><span class="pre">_FillValue</span></code> attribute). However, such attributes will be ignored when the product is imported.</p>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="global_attributes.html" class="btn btn-neutral float-left" title="Global attributes" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="variables.html" class="btn btn-neutral float-right" title="Variables" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2015-2022 S[&]T, The Netherlands.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|
