Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
edwardhartnett committed Oct 27, 2023
1 parent 40fe2e6 commit 1ef69d4
Show file tree
Hide file tree
Showing 218 changed files with 6,012 additions and 4,790 deletions.
2 changes: 1 addition & 1 deletion cmplxpack_8c.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a099225c582defca6ab562d9a

<p class="reference">References <a class="el" href="compack_8c_source.html#l00042">compack()</a>, and <a class="el" href="misspack_8c_source.html#l00042">misspack()</a>.</p>

<p class="reference">Referenced by <a class="el" href="g2__addfield_8c_source.html#l00098">g2_addfield()</a>.</p>
<p class="reference">Referenced by <a class="el" href="g2__addfield_8c_source.html#l00099">g2_addfield()</a>.</p>

</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion cmplxpack_8c_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;}</div>
<div class="ttc" id="acmplxpack_8c_html_a099225c582defca6ab562d9aad5bc20b"><div class="ttname"><a href="cmplxpack_8c.html#a099225c582defca6ab562d9aad5bc20b">cmplxpack</a></div><div class="ttdeci">void cmplxpack(float *fld, g2int ndpts, g2int idrsnum, g2int *idrstmpl, unsigned char *cpack, g2int *lcpack)</div><div class="ttdoc">This subroutine packs up a data field using a complex packing algorithm as defined in the GRIB2 docum...</div><div class="ttdef"><b>Definition:</b> <a href="cmplxpack_8c_source.html#l00036">cmplxpack.c:36</a></div></div>
<div class="ttc" id="acompack_8c_html_acbf694045589babceb7412ac6faadc39"><div class="ttname"><a href="compack_8c.html#acbf694045589babceb7412ac6faadc39">compack</a></div><div class="ttdeci">void compack(float *fld, g2int ndpts, g2int idrsnum, g2int *idrstmpl, unsigned char *cpack, g2int *lcpack)</div><div class="ttdoc">This subroutine packs up a data field using a complex packing algorithm as defined in the GRIB2 docum...</div><div class="ttdef"><b>Definition:</b> <a href="compack_8c_source.html#l00042">compack.c:42</a></div></div>
<div class="ttc" id="agrib2_8h_html_af0b63b0e0f41f07f562a4367e2a60838"><div class="ttname"><a href="grib2_8h.html#af0b63b0e0f41f07f562a4367e2a60838">g2int</a></div><div class="ttdeci">int64_t g2int</div><div class="ttdoc">Long integer type.</div><div class="ttdef"><b>Definition:</b> <a href="grib2_8h_source.html#l00031">grib2.h:31</a></div></div>
<div class="ttc" id="agrib2_8h_html_af0b63b0e0f41f07f562a4367e2a60838"><div class="ttname"><a href="grib2_8h.html#af0b63b0e0f41f07f562a4367e2a60838">g2int</a></div><div class="ttdeci">int64_t g2int</div><div class="ttdoc">Long integer type.</div><div class="ttdef"><b>Definition:</b> <a href="grib2_8h_source.html#l00033">grib2.h:33</a></div></div>
<div class="ttc" id="agrib2__int_8h_html"><div class="ttname"><a href="grib2__int_8h.html">grib2_int.h</a></div><div class="ttdoc">Header file with internal function prototypes NCEPLIBS-g2c library.</div></div>
<div class="ttc" id="agrib2__int_8h_html_aaa78613e8bf42b3dbd6d3813371bc339"><div class="ttname"><a href="grib2__int_8h.html#aaa78613e8bf42b3dbd6d3813371bc339">misspack</a></div><div class="ttdeci">void misspack(float *fld, g2int ndpts, g2int idrsnum, g2int *idrstmpl, unsigned char *cpack, g2int *lcpack)</div><div class="ttdoc">This function packs up a data field using a complex packing algorithm as defined in the GRIB2 documen...</div><div class="ttdef"><b>Definition:</b> <a href="misspack_8c_source.html#l00042">misspack.c:42</a></div></div>
</div><!-- fragment --></div><!-- contents -->
Expand Down
2 changes: 1 addition & 1 deletion compack_8c_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -473,7 +473,7 @@
<div class="ttc" id="acompack_8c_html_acbf694045589babceb7412ac6faadc39"><div class="ttname"><a href="compack_8c.html#acbf694045589babceb7412ac6faadc39">compack</a></div><div class="ttdeci">void compack(float *fld, g2int ndpts, g2int idrsnum, g2int *idrstmpl, unsigned char *cpack, g2int *lcpack)</div><div class="ttdoc">This subroutine packs up a data field using a complex packing algorithm as defined in the GRIB2 docum...</div><div class="ttdef"><b>Definition:</b> <a href="compack_8c_source.html#l00042">compack.c:42</a></div></div>
<div class="ttc" id="agbits_8c_html_a92b32e56ff8941c5026d460f4fe2aec3"><div class="ttname"><a href="gbits_8c.html#a92b32e56ff8941c5026d460f4fe2aec3">sbits</a></div><div class="ttdeci">void sbits(unsigned char *out, g2int *in, g2int iskip, g2int nbits, g2int nskip, g2int n)</div><div class="ttdoc">Store bits - put arbitrary size values into a packed bit string, taking the low order bits from each ...</div><div class="ttdef"><b>Definition:</b> <a href="gbits_8c_source.html#l00180">gbits.c:180</a></div></div>
<div class="ttc" id="agbits_8c_html_af9e044ba7da32a5415e351ed647ef676"><div class="ttname"><a href="gbits_8c.html#af9e044ba7da32a5415e351ed647ef676">sbit</a></div><div class="ttdeci">void sbit(unsigned char *out, g2int *in, g2int iskip, g2int nbits)</div><div class="ttdoc">Store bits - put arbitrary size values into a packed bit string, taking the low order bits from each ...</div><div class="ttdef"><b>Definition:</b> <a href="gbits_8c_source.html#l00038">gbits.c:38</a></div></div>
<div class="ttc" id="agrib2_8h_html_af0b63b0e0f41f07f562a4367e2a60838"><div class="ttname"><a href="grib2_8h.html#af0b63b0e0f41f07f562a4367e2a60838">g2int</a></div><div class="ttdeci">int64_t g2int</div><div class="ttdoc">Long integer type.</div><div class="ttdef"><b>Definition:</b> <a href="grib2_8h_source.html#l00031">grib2.h:31</a></div></div>
<div class="ttc" id="agrib2_8h_html_af0b63b0e0f41f07f562a4367e2a60838"><div class="ttname"><a href="grib2_8h.html#af0b63b0e0f41f07f562a4367e2a60838">g2int</a></div><div class="ttdeci">int64_t g2int</div><div class="ttdoc">Long integer type.</div><div class="ttdef"><b>Definition:</b> <a href="grib2_8h_source.html#l00033">grib2.h:33</a></div></div>
<div class="ttc" id="agrib2__int_8h_html"><div class="ttname"><a href="grib2__int_8h.html">grib2_int.h</a></div><div class="ttdoc">Header file with internal function prototypes NCEPLIBS-g2c library.</div></div>
<div class="ttc" id="agrib2__int_8h_html_a1594a8cc9a699a73a870b9ec4231fbd3"><div class="ttname"><a href="grib2__int_8h.html#a1594a8cc9a699a73a870b9ec4231fbd3">mkieee</a></div><div class="ttdeci">void mkieee(float *a, g2int *rieee, g2int num)</div><div class="ttdoc">This subroutine stores a list of real values in 32-bit IEEE floating point format.</div><div class="ttdef"><b>Definition:</b> <a href="mkieee_8c_source.html#l00022">mkieee.c:22</a></div></div>
<div class="ttc" id="agrib2__int_8h_html_a6b284a64a4b42cd86db872ae7e1eeaa8"><div class="ttname"><a href="grib2__int_8h.html#a6b284a64a4b42cd86db872ae7e1eeaa8">int_power</a></div><div class="ttdeci">double int_power(double x, g2int y)</div><div class="ttdoc">Function similar to C pow() power function.</div><div class="ttdef"><b>Definition:</b> <a href="int__power_8c_source.html#l00018">int_power.c:18</a></div></div>
Expand Down
6 changes: 3 additions & 3 deletions comunpack_8c.html
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab6cce79f010456f1e882fa1c

<p>This subroutine unpacks a data field that was packed using a complex packing algorithm as defined in the GRIB2 documention, using info from the GRIB2 Data Representation <a href="https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/grib2_temp5-2.shtml">Template 5.2</a> or <a href="https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/grib2_temp5-3.shtml">Template 5.3</a>. </p>
<p>Supports GRIB2 complex packing templates with or without spatial differences (i.e. DRTs 5.2 and 5.3).</p>
<h3><a class="anchor" id="autotoc_md6"></a>
<h3><a class="anchor" id="autotoc_md7"></a>
Program History Log</h3>
<table class="markdownTable">
<tr class="markdownTableHead">
Expand All @@ -189,9 +189,9 @@ <h3><a class="anchor" id="autotoc_md6"></a>

<p class="definition">Definition at line <a class="el" href="comunpack_8c_source.html#l00042">42</a> of file <a class="el" href="comunpack_8c_source.html">comunpack.c</a>.</p>

<p class="reference">References <a class="el" href="gbits_8c_source.html#l00020">gbit()</a>, <a class="el" href="gbits_8c_source.html#l00057">gbits()</a>, <a class="el" href="int__power_8c_source.html#l00018">int_power()</a>, <a class="el" href="grib2__int_8h_source.html#l00417">LOG</a>, and <a class="el" href="rdieee_8c_source.html#l00021">rdieee()</a>.</p>
<p class="reference">References <a class="el" href="gbits_8c_source.html#l00020">gbit()</a>, <a class="el" href="gbits_8c_source.html#l00057">gbits()</a>, <a class="el" href="int__power_8c_source.html#l00018">int_power()</a>, <a class="el" href="grib2__int_8h_source.html#l00426">LOG</a>, and <a class="el" href="rdieee_8c_source.html#l00021">rdieee()</a>.</p>

<p class="reference">Referenced by <a class="el" href="g2__unpack7_8c_source.html#l00067">g2c_unpack7_int()</a>.</p>
<p class="reference">Referenced by <a class="el" href="g2__unpack7_8c_source.html#l00068">g2c_unpack7_int()</a>.</p>

</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions comunpack_8c_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -397,10 +397,10 @@
<div class="ttc" id="acomunpack_8c_html_ab6cce79f010456f1e882fa1c027062da"><div class="ttname"><a href="comunpack_8c.html#ab6cce79f010456f1e882fa1c027062da">comunpack</a></div><div class="ttdeci">int comunpack(unsigned char *cpack, g2int lensec, g2int idrsnum, g2int *idrstmpl, g2int ndpts, float *fld)</div><div class="ttdoc">This subroutine unpacks a data field that was packed using a complex packing algorithm as defined in ...</div><div class="ttdef"><b>Definition:</b> <a href="comunpack_8c_source.html#l00042">comunpack.c:42</a></div></div>
<div class="ttc" id="agbits_8c_html_a1efb9739e947d94010aeba6daf62eca3"><div class="ttname"><a href="gbits_8c.html#a1efb9739e947d94010aeba6daf62eca3">gbit</a></div><div class="ttdeci">void gbit(unsigned char *in, g2int *iout, g2int iskip, g2int nbits)</div><div class="ttdoc">Get bits - unpack bits: Extract arbitrary size values from a packed bit string, right justifying each...</div><div class="ttdef"><b>Definition:</b> <a href="gbits_8c_source.html#l00020">gbits.c:20</a></div></div>
<div class="ttc" id="agbits_8c_html_a31ebdbbf262b7478d6a7cc4326f76ade"><div class="ttname"><a href="gbits_8c.html#a31ebdbbf262b7478d6a7cc4326f76ade">gbits</a></div><div class="ttdeci">void gbits(unsigned char *in, g2int *iout, g2int iskip, g2int nbits, g2int nskip, g2int n)</div><div class="ttdoc">Get bits - unpack bits: Extract arbitrary size values from a packed bit string, right justifying each...</div><div class="ttdef"><b>Definition:</b> <a href="gbits_8c_source.html#l00057">gbits.c:57</a></div></div>
<div class="ttc" id="agrib2_8h_html_af0b63b0e0f41f07f562a4367e2a60838"><div class="ttname"><a href="grib2_8h.html#af0b63b0e0f41f07f562a4367e2a60838">g2int</a></div><div class="ttdeci">int64_t g2int</div><div class="ttdoc">Long integer type.</div><div class="ttdef"><b>Definition:</b> <a href="grib2_8h_source.html#l00031">grib2.h:31</a></div></div>
<div class="ttc" id="agrib2_8h_html_af0b63b0e0f41f07f562a4367e2a60838"><div class="ttname"><a href="grib2_8h.html#af0b63b0e0f41f07f562a4367e2a60838">g2int</a></div><div class="ttdeci">int64_t g2int</div><div class="ttdoc">Long integer type.</div><div class="ttdef"><b>Definition:</b> <a href="grib2_8h_source.html#l00033">grib2.h:33</a></div></div>
<div class="ttc" id="agrib2__int_8h_html"><div class="ttname"><a href="grib2__int_8h.html">grib2_int.h</a></div><div class="ttdoc">Header file with internal function prototypes NCEPLIBS-g2c library.</div></div>
<div class="ttc" id="agrib2__int_8h_html_a6b284a64a4b42cd86db872ae7e1eeaa8"><div class="ttname"><a href="grib2__int_8h.html#a6b284a64a4b42cd86db872ae7e1eeaa8">int_power</a></div><div class="ttdeci">double int_power(double x, g2int y)</div><div class="ttdoc">Function similar to C pow() power function.</div><div class="ttdef"><b>Definition:</b> <a href="int__power_8c_source.html#l00018">int_power.c:18</a></div></div>
<div class="ttc" id="agrib2__int_8h_html_abb35b3e9ac2b0ff8cd7c0881988940c0"><div class="ttname"><a href="grib2__int_8h.html#abb35b3e9ac2b0ff8cd7c0881988940c0">LOG</a></div><div class="ttdeci">#define LOG(e)</div><div class="ttdoc">Ignore logging to stdout.</div><div class="ttdef"><b>Definition:</b> <a href="grib2__int_8h_source.html#l00417">grib2_int.h:417</a></div></div>
<div class="ttc" id="agrib2__int_8h_html_abb35b3e9ac2b0ff8cd7c0881988940c0"><div class="ttname"><a href="grib2__int_8h.html#abb35b3e9ac2b0ff8cd7c0881988940c0">LOG</a></div><div class="ttdeci">#define LOG(e)</div><div class="ttdoc">Ignore logging to stdout.</div><div class="ttdef"><b>Definition:</b> <a href="grib2__int_8h_source.html#l00426">grib2_int.h:426</a></div></div>
<div class="ttc" id="agrib2__int_8h_html_af4e2650852f7bbbfb531c977fcbd42ca"><div class="ttname"><a href="grib2__int_8h.html#af4e2650852f7bbbfb531c977fcbd42ca">rdieee</a></div><div class="ttdeci">void rdieee(g2int *rieee, float *a, g2int num)</div><div class="ttdoc">This subroutine reads a list of real values in 32-bit IEEE floating point format.</div><div class="ttdef"><b>Definition:</b> <a href="rdieee_8c_source.html#l00021">rdieee.c:21</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
Expand Down
4 changes: 2 additions & 2 deletions dec__jpeg2000_8c.html
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
<div class="textblock"><p>Decodes JPEG2000 code stream. </p>
<dl class="section author"><dt>Author</dt><dd>Stephen Gilbert </dd></dl>
<dl class="section date"><dt>Date</dt><dd>2002-12-02</dd></dl>
<h3><a class="anchor" id="autotoc_md7"></a>
<h3><a class="anchor" id="autotoc_md8"></a>
Program History Log</h3>
<table class="markdownTable">
<tr class="markdownTableHead">
Expand Down Expand Up @@ -314,7 +314,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac822263ee9732d7603f242a8

<p class="definition">Definition at line <a class="el" href="dec__jpeg2000_8c_source.html#l00044">44</a> of file <a class="el" href="dec__jpeg2000_8c_source.html">dec_jpeg2000.c</a>.</p>

<p class="reference">References <a class="el" href="grib2_8h_source.html#l00472">G2_JASPER_DECODE</a>, <a class="el" href="grib2_8h_source.html#l00473">G2_JASPER_DECODE_COLOR</a>, <a class="el" href="grib2_8h_source.html#l00470">G2_JASPER_INIT</a>, <a class="el" href="grib2__int_8h_source.html#l00033">G2C_JASPER_JPEG_FORMAT_NAME</a>, <a class="el" href="grib2_8h_source.html#l00420">G2C_JASPER_MAX_MEM</a>, and <a class="el" href="grib2__int_8h_source.html#l00417">LOG</a>.</p>
<p class="reference">References <a class="el" href="grib2_8h_source.html#l00487">G2_JASPER_DECODE</a>, <a class="el" href="grib2_8h_source.html#l00488">G2_JASPER_DECODE_COLOR</a>, <a class="el" href="grib2_8h_source.html#l00485">G2_JASPER_INIT</a>, <a class="el" href="grib2__int_8h_source.html#l00033">G2C_JASPER_JPEG_FORMAT_NAME</a>, <a class="el" href="grib2_8h_source.html#l00435">G2C_JASPER_MAX_MEM</a>, and <a class="el" href="grib2__int_8h_source.html#l00426">LOG</a>.</p>

<p class="reference">Referenced by <a class="el" href="dec__jpeg2000_8c_source.html#l00201">dec_jpeg2000()</a>, and <a class="el" href="dec__jpeg2000_8c_source.html#l00174">g2c_dec_jpeg2000()</a>.</p>

Expand Down
Loading

0 comments on commit 1ef69d4

Please sign in to comment.