Debian Codegraph @

doc/html/libharp_product_metadata.html

raw
1 <!DOCTYPE html>
2 <html class="writer-html5" lang="en">
3 <head>
4 <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
5
6 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
7 <title>Product Metadata &mdash; HARP 1.29 documentation</title>
8 <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
9 <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
10 <link rel="stylesheet" type="text/css" href="_static/custom.css" />
11
12
13 <!--[if lt IE 9]>
14 <script src="_static/js/html5shiv.min.js"></script>
15 <![endif]-->
16
17 <script src="_static/jquery.js"></script>
18 <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
19 <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
20 <script src="_static/doctools.js"></script>
21 <script src="_static/sphinx_highlight.js"></script>
22 <script src="_static/js/theme.js"></script>
23 <link rel="index" title="Index" href="genindex.html" />
24 <link rel="next" title="Variable" href="libharp_variable.html" />
25 <link rel="prev" title="Product" href="libharp_product.html" />
26 </head>
27
28 <body class="wy-body-for-nav">
29 <div class="wy-grid-for-nav">
30 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
31 <div class="wy-side-scroll">
32 <div class="wy-side-nav-search" >
33
34
35
36 <a href="index.html" class="icon icon-home">
37 HARP
38 </a>
39 <div class="version">
40 1.29
41 </div>
42 </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
43 <ul class="current">
44 <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
45 <li class="toctree-l1"><a class="reference internal" href="conventions/index.html">Conventions</a></li>
46 <li class="toctree-l1"><a class="reference internal" href="algorithms/index.html">Algorithms</a></li>
47 <li class="toctree-l1"><a class="reference internal" href="operations.html">Operations</a></li>
48 <li class="toctree-l1"><a class="reference internal" href="ingestions/index.html">Ingestion definitions</a></li>
49 <li class="toctree-l1 current"><a class="reference internal" href="libharp.html">C library</a><ul class="current">
50 <li class="toctree-l2"><a class="reference internal" href="libharp.html#introduction">Introduction</a></li>
51 <li class="toctree-l2 current"><a class="reference internal" href="libharp.html#modules">Modules</a><ul class="current">
52 <li class="toctree-l3"><a class="reference internal" href="libharp_collocation.html">Collocation</a></li>
53 <li class="toctree-l3"><a class="reference internal" href="libharp_dataset.html">Dataset</a></li>
54 <li class="toctree-l3"><a class="reference internal" href="libharp_documentation.html">Documentation</a></li>
55 <li class="toctree-l3"><a class="reference internal" href="libharp_error.html">Error</a></li>
56 <li class="toctree-l3"><a class="reference internal" href="libharp_general.html">General</a></li>
57 <li class="toctree-l3"><a class="reference internal" href="libharp_geometry.html">Geometry</a></li>
58 <li class="toctree-l3"><a class="reference internal" href="libharp_product.html">Product</a></li>
59 <li class="toctree-l3 current"><a class="current reference internal" href="#">Product Metadata</a></li>
60 <li class="toctree-l3"><a class="reference internal" href="libharp_variable.html">Variable</a></li>
61 </ul>
62 </li>
63 </ul>
64 </li>
65 <li class="toctree-l1"><a class="reference internal" href="idl.html">IDL interface</a></li>
66 <li class="toctree-l1"><a class="reference internal" href="matlab.html">MATLAB interface</a></li>
67 <li class="toctree-l1"><a class="reference internal" href="python.html">Python interface</a></li>
68 <li class="toctree-l1"><a class="reference internal" href="R.html">R interface</a></li>
69 <li class="toctree-l1"><a class="reference internal" href="tools.html">Command line tools</a></li>
70 </ul>
71
72 </div>
73 </div>
74 </nav>
75
76 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
77 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
78 <a href="index.html">HARP</a>
79 </nav>
80
81 <div class="wy-nav-content">
82 <div class="rst-content">
83 <div role="navigation" aria-label="Page navigation">
84 <ul class="wy-breadcrumbs">
85 <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
86 <li class="breadcrumb-item"><a href="libharp.html">C library</a></li>
87 <li class="breadcrumb-item active">Product Metadata</li>
88 <li class="wy-breadcrumbs-aside">
89 </li>
90 </ul>
91 <hr/>
92 </div>
93 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
94 <div itemprop="articleBody">
95
96 <section id="product-metadata">
97 <h1>Product Metadata</h1>
98 <dl>
99 <dt class="sig sig-object cpp">
100 <span class="target" id="group__harp__product__metadata"></span><em><span class="pre">group</span></em> <span class="sig-name descname"><span class="pre">harp_product_metadata</span></span></dt>
101 <dd><p>The HARP Product Metadata module contains everything related to HARP product metadata.</p>
102 <div class="breathe-sectiondef docutils container">
103 <p class="breathe-sectiondef-title rubric" id="breathe-section-title-typedefs">Typedefs</p>
104 <dl class="cpp type">
105 <dt class="sig sig-object cpp" id="_CPPv421harp_product_metadata">
106 <span id="_CPPv321harp_product_metadata"></span><span id="_CPPv221harp_product_metadata"></span><span id="harp_product_metadata"></span><span class="target" id="group__harp__product__metadata_1gab5b5c315ba7b68e2b3b0febe56862516"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv428harp_product_metadata_struct" title="harp_product_metadata_struct"><span class="n"><span class="pre">harp_product_metadata_struct</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_product_metadata</span></span></span><br /></dt>
107 <dd><p>HARP Product Metadata typedef </p>
108 </dd></dl>
109
110 </div>
111 <div class="breathe-sectiondef docutils container">
112 <p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
113 <dl class="cpp function">
114 <dt class="sig sig-object cpp" id="_CPPv428harp_product_metadata_deleteP21harp_product_metadata">
115 <span id="_CPPv328harp_product_metadata_deleteP21harp_product_metadata"></span><span id="_CPPv228harp_product_metadata_deleteP21harp_product_metadata"></span><span id="harp_product_metadata_delete__harp_product_metadataP"></span><span class="target" id="group__harp__product__metadata_1ga0441223827f4d70bc6ded0cb8a727628"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_product_metadata_delete</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv421harp_product_metadata" title="harp_product_metadata"><span class="n"><span class="pre">harp_product_metadata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">metadata</span></span><span class="sig-paren">)</span><br /></dt>
116 <dd><p>Delete product metadata. Remove metadata and all attached variables and attributes. </p>
117 <dl class="field-list simple">
118 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
119 <dd class="field-odd"><p><strong>metadata</strong> – HARP metadata. </p>
120 </dd>
121 </dl>
122 </dd></dl>
123
124 <dl class="cpp function">
125 <dt class="sig sig-object cpp" id="_CPPv425harp_product_metadata_newPP21harp_product_metadata">
126 <span id="_CPPv325harp_product_metadata_newPP21harp_product_metadata"></span><span id="_CPPv225harp_product_metadata_newPP21harp_product_metadata"></span><span id="harp_product_metadata_new__harp_product_metadataPP"></span><span class="target" id="group__harp__product__metadata_1gad7c2c009e17399ad72476548a498f7b0"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_product_metadata_new</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv421harp_product_metadata" title="harp_product_metadata"><span class="n"><span class="pre">harp_product_metadata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">new_metadata</span></span><span class="sig-paren">)</span><br /></dt>
127 <dd><p>Create new product metadata. The metadata will be initialized with 0.0 datetime_start/end. </p>
128 <dl class="field-list simple">
129 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
130 <dd class="field-odd"><p><strong>new_metadata</strong> – Pointer to the C variable where the new HARP product metadata will be stored. </p>
131 </dd>
132 <dt class="field-even">Returns<span class="colon">:</span></dt>
133 <dd class="field-even"><p><ul class="simple">
134 <li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Success. </p></li>
135 <li><p><code class="docutils literal notranslate"><span class="pre">-1</span></code>, Error occurred (check <a class="reference internal" href="libharp_error.html#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>). </p></li>
136 </ul>
137 </p>
138 </dd>
139 </dl>
140 </dd></dl>
141
142 <dl class="cpp function">
143 <dt class="sig sig-object cpp" id="_CPPv427harp_product_metadata_printP21harp_product_metadataPFiPKczE">
144 <span id="_CPPv327harp_product_metadata_printP21harp_product_metadataPFiPKczE"></span><span id="_CPPv227harp_product_metadata_printP21harp_product_metadataPFiPKczE"></span><span class="target" id="group__harp__product__metadata_1gac0b6ff404a5d629b07dd65d6fa44fb76"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_product_metadata_print</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv421harp_product_metadata" title="harp_product_metadata"><span class="n"><span class="pre">harp_product_metadata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">metadata</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">print</span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">)</span></span><span class="sig-paren">)</span><br /></dt>
145 <dd><p>Print product metadata. This will print a comma-separated list of:<ul class="simple">
146 <li><p>filename</p></li>
147 <li><p>datetime_start</p></li>
148 <li><p>datetime_stop</p></li>
149 <li><p>time (dimension length)</p></li>
150 <li><p>latitude (dimension length)</p></li>
151 <li><p>longitude (dimension length)</p></li>
152 <li><p>vertical (dimension length)</p></li>
153 <li><p>spectral (dimension length)</p></li>
154 <li><p>source_product </p></li>
155 </ul>
156 </p>
157 <dl class="field-list simple">
158 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
159 <dd class="field-odd"><ul class="simple">
160 <li><p><strong>metadata</strong> – Pointer to the metadata to print. </p></li>
161 <li><p><strong>print</strong> – Pointer to the function that should be used for printing. </p></li>
162 </ul>
163 </dd>
164 </dl>
165 </dd></dl>
166
167 </div>
168 <dl class="cpp struct">
169 <dt class="sig sig-object cpp" id="_CPPv428harp_product_metadata_struct">
170 <span id="_CPPv328harp_product_metadata_struct"></span><span id="_CPPv228harp_product_metadata_struct"></span><span id="harp_product_metadata_struct"></span><span class="target" id="structharp__product__metadata__struct"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_product_metadata_struct</span></span></span><br /></dt>
171 <dd><div class="docutils container">
172 <em>#include &lt;harp.h&gt;</em></div>
173 <p>HARP Product Metadata struct </p>
174 </dd></dl>
175
176 </dd></dl>
177
178 </section>
179
180
181 </div>
182 </div>
183 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
184 <a href="libharp_product.html" class="btn btn-neutral float-left" title="Product" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
185 <a href="libharp_variable.html" class="btn btn-neutral float-right" title="Variable" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
186 </div>
187
188 <hr/>
189
190 <div role="contentinfo">
191 <p>&#169; Copyright 2015-2026 S[&amp;]T, The Netherlands.</p>
192 </div>
193
194
195
196 </footer>
197 </div>
198 </div>
199 </section>
200 </div>
201 <script>
202 jQuery(function () {
203 SphinxRtdTheme.Navigation.enable(true);
204 });
205 </script>
206
207 </body>
208 </html>