wcslib (8.2.2)

(root)/
share/
doc/
wcslib-8.2.2/
html/
structdpkey.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WCSLIB: dpkey Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">WCSLIB<span id="projectnumber">&#160;8.2.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">dpkey Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Store for <code><b>DP</b>ja</code> and <code><b>DQ</b>ia</code> keyvalues.  
 <a href="structdpkey.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="dis_8h_source.html">dis.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a7585bc8185c349dc4e13b7964606933e" id="r_a7585bc8185c349dc4e13b7964606933e"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdpkey.html#a7585bc8185c349dc4e13b7964606933e">field</a> [72]</td></tr>
<tr class="separator:a7585bc8185c349dc4e13b7964606933e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeab33684c9284d0d73757224b32a6d73" id="r_aeab33684c9284d0d73757224b32a6d73"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdpkey.html#aeab33684c9284d0d73757224b32a6d73">j</a></td></tr>
<tr class="separator:aeab33684c9284d0d73757224b32a6d73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adce16b786bbb5d4663e9cb201b124a0e" id="r_adce16b786bbb5d4663e9cb201b124a0e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdpkey.html#adce16b786bbb5d4663e9cb201b124a0e">type</a></td></tr>
<tr class="separator:adce16b786bbb5d4663e9cb201b124a0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18c6c3caf495a1f57ef0cb1e800e974f" id="r_a18c6c3caf495a1f57ef0cb1e800e974f"><td class="memItemLeft" >union {&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73f465aa77fd7e6c4598222f170305b2" id="r_a73f465aa77fd7e6c4598222f170305b2"><td class="memItemLeft" >&#160;&#160;&#160;int&#160;&#160;&#160;<a class="el" href="structdpkey.html#a1fa8264c0a1237e9e4303058d3633569">i</a>&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:a73f465aa77fd7e6c4598222f170305b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c29475a06864314963962eb576397c2" id="r_a3c29475a06864314963962eb576397c2"><td class="memItemLeft" >&#160;&#160;&#160;double&#160;&#160;&#160;<a class="el" href="structdpkey.html#af662dfc2d66f2803d73583780079281a">f</a>&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:a3c29475a06864314963962eb576397c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18c6c3caf495a1f57ef0cb1e800e974f" id="r_a18c6c3caf495a1f57ef0cb1e800e974f"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdpkey.html#a18c6c3caf495a1f57ef0cb1e800e974f">value</a>&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:a18c6c3caf495a1f57ef0cb1e800e974f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Store for <code><b>DP</b>ja</code> and <code><b>DQ</b>ia</code> keyvalues. </p>
<p>The <b>dpkey</b> struct is used to pass the parsed contents of <code><b>DP</b>ja</code> or <code><b>DQ</b>ia</code> keyrecords to <a class="el" href="dis_8h.html#ad1bdf4497eb4513ca8431e1baa419041" title="Setup routine for the disprm struct.">disset()</a> via the <a class="el" href="structdisprm.html" title="Distortion parameters.">disprm</a> struct. A <a class="el" href="structdisprm.html" title="Distortion parameters.">disprm</a> struct must hold only <code><b>DP</b>ja</code> or <code><b>DQ</b>ia</code> keyvalues, not both.</p>
<p>All members of this struct are to be set by the user. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a7585bc8185c349dc4e13b7964606933e" name="a7585bc8185c349dc4e13b7964606933e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7585bc8185c349dc4e13b7964606933e">&#9670;&#160;</a></span>field</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char dpkey::field</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Given</em>) The full field name of the record, including the keyword name. Note that the colon delimiter separating the field name and the value in record-valued keyvalues is not part of the field name. For example, in the following: </p><div class="fragment"><div class="line">DP3A = <span class="stringliteral">&#39;AXIS.1: 2&#39;</span></div>
</div><!-- fragment --><p>the full record field name is &quot;DP3A<code><b>.AXIS.</b></code>1&quot;, and the record's value is 2. </p>

</div>
</div>
<a id="aeab33684c9284d0d73757224b32a6d73" name="aeab33684c9284d0d73757224b32a6d73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeab33684c9284d0d73757224b32a6d73">&#9670;&#160;</a></span>j</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int dpkey::j</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Given</em>) Axis number (1-relative), i.e. the j in <code><b>DP</b>ja</code> or i in <code><b>DQ</b>ia</code>. </p>

</div>
</div>
<a id="adce16b786bbb5d4663e9cb201b124a0e" name="adce16b786bbb5d4663e9cb201b124a0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adce16b786bbb5d4663e9cb201b124a0e">&#9670;&#160;</a></span>type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int dpkey::type</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Given</em>) The data type of the record's value </p><ul>
<li>
0: Integer (stored as an int), </li>
<li>
1: Floating point (stored as a double). </li>
</ul>

</div>
</div>
<a id="a1fa8264c0a1237e9e4303058d3633569" name="a1fa8264c0a1237e9e4303058d3633569"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1fa8264c0a1237e9e4303058d3633569">&#9670;&#160;</a></span>i</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int dpkey::i</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="af662dfc2d66f2803d73583780079281a" name="af662dfc2d66f2803d73583780079281a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af662dfc2d66f2803d73583780079281a">&#9670;&#160;</a></span>f</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double dpkey::f</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a18c6c3caf495a1f57ef0cb1e800e974f" name="a18c6c3caf495a1f57ef0cb1e800e974f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18c6c3caf495a1f57ef0cb1e800e974f">&#9670;&#160;</a></span>value</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">union dpkey::value</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(<em>Given</em>) A union comprised of </p><ul>
<li>
<a class="el" href="structdpkey.html#a1fa8264c0a1237e9e4303058d3633569">dpkey::i</a>, </li>
<li>
<a class="el" href="structdpkey.html#af662dfc2d66f2803d73583780079281a">dpkey::f</a>, </li>
</ul>
<p>the record's value. </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 29 2023 19:09:57 for WCSLIB by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>