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
|
<!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>MATLAB interface — 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="Python interface" href="python.html" />
<link rel="prev" title="IDL interface" href="idl.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"><a class="reference internal" href="conventions/index.html">Conventions</a></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 current"><a class="current reference internal" href="#">MATLAB interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#dimension-types">Dimension types</a></li>
<li class="toctree-l2"><a class="reference internal" href="#data-types">Data types</a></li>
<li class="toctree-l2"><a class="reference internal" href="#unicode">Unicode</a></li>
<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="#api-reference">API reference</a></li>
</ul>
</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>MATLAB interface</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="matlab-interface">
<h1>MATLAB interface</h1>
<p>The Matrix Laboratory (MATLAB) interface consists of a series of M-files
that provide the <cite>harp_import</cite>, <cite>harp_export</cite> and <cite>harp_version</cite> functions.</p>
<p>Products are represented in MATLAB as structures which can be manipulated freely
from within MATLAB. A product structure contains an array field for each variable
contained in the product.</p>
<p>Products can be exported as HARP compliant products in any of the file formats
supported by the HARP C library (netCDF/HDF4/HDF5). Such exported products can
subsequently be processed further using the <a class="reference internal" href="tools.html"><span class="doc">HARP command line tools</span></a>.</p>
<section id="dimension-types">
<h2>Dimension types</h2>
<p>The HARP C library defines several dimension types (time, vertical, latitude
etc.). This information is stored in the dimension_type field of each variable
in MATLAB. If a variable is a scalar (which has no dimensions), the dimension_type
field is not present.</p>
</section>
<section id="data-types">
<h2>Data types</h2>
<p>The HARP MATLAB interface takes care of the conversion of product and variables
from the C domain to the MATLAB domain and back. This section describes the
relation between types in the C domain and types in the MATLAB domain.</p>
<p>The table below shows the type map that is used when importing or ingesting a
product, i.e. when translating from the C domain to the MATLAB domain.</p>
<p>Variable data arrays are converted to arrays in the product structure. The data
type used for the converted array is determined from the HARP data type of the
variable according to the type map shown below. Zero-dimensional arrays of
length 1 are converted to MATLAB arrays of 1x1. The resulting MATLAB type is also
shown in the type map.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 58%" />
<col style="width: 42%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>HARP data type</p></th>
<th class="head"><p>MATLAB type</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>harp_type_int8</p></td>
<td><p>int8</p></td>
</tr>
<tr class="row-odd"><td><p>harp_type_int16</p></td>
<td><p>int16</p></td>
</tr>
<tr class="row-even"><td><p>harp_type_int32</p></td>
<td><p>int32</p></td>
</tr>
<tr class="row-odd"><td><p>harp_type_float</p></td>
<td><p>single</p></td>
</tr>
<tr class="row-even"><td><p>harp_type_double</p></td>
<td><p>double</p></td>
</tr>
<tr class="row-odd"><td><p>harp_type_string</p></td>
<td><p>char</p></td>
</tr>
</tbody>
</table>
</section>
<section id="unicode">
<h2>Unicode</h2>
<p>Zero-terminated C strings received from the HARP C library are always converted
to arrays of mxCHAR in MATLAB which is an unicode string.</p>
</section>
<section id="examples">
<h2>Examples</h2>
<div class="highlight-MATLAB notranslate"><div class="highlight"><pre><span></span><span class="p">;</span><span class="w"> </span><span class="n">Ingest</span><span class="w"> </span><span class="s">a</span><span class="w"> </span><span class="s">file</span><span class="w"> </span><span class="s">and</span><span class="w"> </span><span class="s">convert</span><span class="w"> </span><span class="s">it</span><span class="w"> </span><span class="s">to</span><span class="w"> </span><span class="s">a</span><span class="w"> </span><span class="s">HARP</span><span class="w"> </span><span class="s">product</span><span class="w"> </span><span class="s">(the</span><span class="w"></span>
<span class="p">;</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="s">that</span><span class="w"> </span><span class="s">is</span><span class="w"> </span><span class="s">used</span><span class="w"> </span><span class="s">in</span><span class="w"> </span><span class="s">this</span><span class="w"> </span><span class="s">example</span><span class="w"> </span><span class="s">is</span><span class="w"> </span><span class="s">an</span><span class="w"> </span><span class="s">ACE-FTS</span><span class="w"> </span><span class="s">file).</span><span class="w"></span>
<span class="n">product1</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">harp_import</span><span class="p">(</span><span class="s">"ss13799.asc"</span><span class="p">)</span><span class="w"></span>
<span class="p">;</span><span class="w"> </span><span class="n">Print</span><span class="w"> </span><span class="s">information</span><span class="w"> </span><span class="s">about</span><span class="w"> </span><span class="s">the</span><span class="w"> </span><span class="s">product.</span><span class="w"></span>
<span class="nb">disp</span><span class="p">(</span><span class="n">product1</span><span class="p">)</span><span class="w"></span>
<span class="p">;</span><span class="w"> </span><span class="n">Print</span><span class="w"> </span><span class="s">information</span><span class="w"> </span><span class="s">about</span><span class="w"> </span><span class="s">the</span><span class="w"> </span><span class="s">variable</span><span class="w"> </span><span class="s">'temperature'.</span><span class="w"></span>
<span class="nb">disp</span><span class="p">(</span><span class="n">product1</span><span class="p">.</span><span class="n">temperature</span><span class="p">)</span><span class="w"></span>
<span class="p">;</span><span class="w"> </span><span class="n">Print</span><span class="w"> </span><span class="s">the</span><span class="w"> </span><span class="s">contents</span><span class="w"> </span><span class="s">of</span><span class="w"> </span><span class="s">the</span><span class="w"> </span><span class="s">variable</span><span class="w"> </span><span class="s">'temperature'.</span><span class="w"></span>
<span class="n">product1</span><span class="p">.</span><span class="n">temperature</span><span class="p">.</span><span class="n">value</span><span class="w"></span>
<span class="p">;</span><span class="w"> </span><span class="n">Export</span><span class="w"> </span><span class="s">the</span><span class="w"> </span><span class="s">updated</span><span class="w"> </span><span class="s">product</span><span class="w"> </span><span class="s">as</span><span class="w"> </span><span class="s">an</span><span class="w"> </span><span class="s">HDF4</span><span class="w"> </span><span class="s">file</span><span class="w"> </span><span class="s">(the</span><span class="w"> </span><span class="s">format</span><span class="w"> </span><span class="s">must</span><span class="w"> </span><span class="s">be</span><span class="w"></span>
<span class="p">;</span><span class="w"> </span><span class="n">HDF4</span><span class="p">,</span><span class="w"> </span><span class="n">HDF5</span><span class="w"> </span><span class="n">or</span><span class="w"> </span><span class="n">netCDF</span><span class="p">,</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">no</span><span class="w"> </span><span class="nb">format</span><span class="w"> </span><span class="n">is</span><span class="w"> </span><span class="n">specified</span><span class="w"> </span><span class="n">netCDF</span><span class="w"> </span><span class="n">is</span><span class="w"> </span><span class="n">used</span><span class="p">).</span><span class="w"></span>
<span class="n">result</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">harp_export</span><span class="p">(</span><span class="n">product1</span><span class="p">,</span><span class="w"> </span><span class="s">"ace_fts_ss13799.hdf"</span><span class="p">,</span><span class="w"> </span><span class="s">"hdf4"</span><span class="p">)</span><span class="w"></span>
<span class="p">;</span><span class="w"> </span><span class="n">Print</span><span class="w"> </span><span class="s">the</span><span class="w"> </span><span class="s">result</span><span class="w"> </span><span class="s">of</span><span class="w"> </span><span class="s">the</span><span class="w"> </span><span class="s">export.</span><span class="w"></span>
<span class="nb">disp</span><span class="p">(</span><span class="n">result</span><span class="p">)</span><span class="w"></span>
<span class="p">;</span><span class="w"> </span><span class="n">Import</span><span class="w"> </span><span class="s">the</span><span class="w"> </span><span class="s">HDF4</span><span class="w"> </span><span class="s">file</span><span class="w"> </span><span class="s">and</span><span class="w"> </span><span class="s">perform</span><span class="w"> </span><span class="s">an</span><span class="w"> </span><span class="s">operation</span><span class="w"> </span><span class="s">to</span><span class="w"> </span><span class="s">exclude</span><span class="w"> </span><span class="s">the</span><span class="w"> </span><span class="s">variable</span><span class="w"></span>
<span class="p">;</span><span class="w"> </span><span class="n">temperature</span><span class="w"> </span><span class="p">(</span><span class="n">variable</span><span class="w"> </span><span class="n">name</span><span class="w"> </span><span class="n">must</span><span class="w"> </span><span class="n">be</span><span class="w"> </span><span class="n">in</span><span class="w"> </span><span class="n">uppercase</span><span class="p">).</span><span class="w"></span>
<span class="n">product2</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">harp_import</span><span class="p">(</span><span class="s">"ace_fts_ss13799.hdf"</span><span class="p">,</span><span class="w"> </span><span class="s">"exclude(TEMPERATURE)"</span><span class="p">);</span><span class="w"></span>
<span class="p">;</span><span class="w"> </span><span class="n">Print</span><span class="w"> </span><span class="s">information</span><span class="w"> </span><span class="s">about</span><span class="w"> </span><span class="s">the</span><span class="w"> </span><span class="s">product.</span><span class="w"></span>
<span class="nb">disp</span><span class="p">(</span><span class="n">product2</span><span class="p">)</span><span class="w"></span>
</pre></div>
</div>
</section>
<section id="api-reference">
<h2>API reference</h2>
<p>This section describes the functions defined by the HARP MATLAB interface.</p>
<dl class="py function">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">harp_import</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operations</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span></dt>
<dd><p>Import a product from a file.</p>
<p>This will first try to import the file as an HDF4, HDF5, or netCDF file that
complies to the HARP Data Format. If the file is not stored using the HARP
format then it will try to import it using one of the available ingestion
modules.</p>
<p>If the filename argument is a list of filenames or a globbing (glob.glob())
pattern then the harp.import_product() function will be called on each
individual file and the result of harp.concatenate() on the imported products
will be returned.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>filename</strong> (<em>str</em>) – Filename of the product to ingest</p></li>
<li><p><strong>operations</strong> (<em>str</em>) – Actions to apply as part of the import; should be
specified as a semi-colon separated string of operations.</p></li>
<li><p><strong>options</strong> (<em>str</em>) – Ingestion module specific options; should be specified as
a semi-colon separated string of key=value pairs; only
used if the file is not in HARP format.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Ingested product.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">harp_export</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">product</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'netcdf'</span></span></em><span class="sig-paren">)</span></dt>
<dd><p>Export a HARP compliant product.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>product</strong> (<em>str</em>) – Product to export.</p></li>
<li><p><strong>filename</strong> (<em>str</em>) – Filename of the exported product.</p></li>
<li><p><strong>file_format</strong> (<em>str</em>) – File format to use; one of ‘netcdf’, ‘hdf4’, or
‘hdf5’. If no format is specified, netcdf is used.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">harp_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
<dd><p>Returns the version number of HARP.</p>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="idl.html" class="btn btn-neutral float-left" title="IDL interface" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="python.html" class="btn btn-neutral float-right" title="Python interface" 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>
|