wcslib (8.2.2)

(root)/
share/
doc/
wcslib-8.2.2/
html/
structauxprm.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: auxprm 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">auxprm Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Additional auxiliary parameters.  
 <a href="structauxprm.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="wcs_8h_source.html">wcs.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:ae90fd56f574beaf8a3c5d7136bfb4a01" id="r_ae90fd56f574beaf8a3c5d7136bfb4a01"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structauxprm.html#ae90fd56f574beaf8a3c5d7136bfb4a01">rsun_ref</a></td></tr>
<tr class="separator:ae90fd56f574beaf8a3c5d7136bfb4a01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0319d8103f0f0a166715e74e329ded2d" id="r_a0319d8103f0f0a166715e74e329ded2d"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structauxprm.html#a0319d8103f0f0a166715e74e329ded2d">dsun_obs</a></td></tr>
<tr class="separator:a0319d8103f0f0a166715e74e329ded2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b058da5ec51c0521776cf96ce3a987a" id="r_a8b058da5ec51c0521776cf96ce3a987a"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structauxprm.html#a8b058da5ec51c0521776cf96ce3a987a">crln_obs</a></td></tr>
<tr class="separator:a8b058da5ec51c0521776cf96ce3a987a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a817ab87c5da2299e795cc260ad563436" id="r_a817ab87c5da2299e795cc260ad563436"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structauxprm.html#a817ab87c5da2299e795cc260ad563436">hgln_obs</a></td></tr>
<tr class="separator:a817ab87c5da2299e795cc260ad563436"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a596e2c4371fa92d04b64a4be6207ae" id="r_a5a596e2c4371fa92d04b64a4be6207ae"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structauxprm.html#a5a596e2c4371fa92d04b64a4be6207ae">hglt_obs</a></td></tr>
<tr class="separator:a5a596e2c4371fa92d04b64a4be6207ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4ca1436fb83cefcbdbe3f985a515552" id="r_ad4ca1436fb83cefcbdbe3f985a515552"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structauxprm.html#ad4ca1436fb83cefcbdbe3f985a515552">a_radius</a></td></tr>
<tr class="separator:ad4ca1436fb83cefcbdbe3f985a515552"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa12b84a421a5d852c469fada87d3149b" id="r_aa12b84a421a5d852c469fada87d3149b"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structauxprm.html#aa12b84a421a5d852c469fada87d3149b">b_radius</a></td></tr>
<tr class="separator:aa12b84a421a5d852c469fada87d3149b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6de4cfed899ff4db5225ccc4d44b5fd7" id="r_a6de4cfed899ff4db5225ccc4d44b5fd7"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structauxprm.html#a6de4cfed899ff4db5225ccc4d44b5fd7">c_radius</a></td></tr>
<tr class="separator:a6de4cfed899ff4db5225ccc4d44b5fd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf9924ec2b288ba8f548bfc6b72b0321" id="r_abf9924ec2b288ba8f548bfc6b72b0321"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structauxprm.html#abf9924ec2b288ba8f548bfc6b72b0321">blon_obs</a></td></tr>
<tr class="separator:abf9924ec2b288ba8f548bfc6b72b0321"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4d7e22bc28d11d46a9bdbf5e48561ea" id="r_af4d7e22bc28d11d46a9bdbf5e48561ea"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structauxprm.html#af4d7e22bc28d11d46a9bdbf5e48561ea">blat_obs</a></td></tr>
<tr class="separator:af4d7e22bc28d11d46a9bdbf5e48561ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af14345ab9fa7b6767d00dffee303a42c" id="r_af14345ab9fa7b6767d00dffee303a42c"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structauxprm.html#af14345ab9fa7b6767d00dffee303a42c">bdis_obs</a></td></tr>
<tr class="separator:af14345ab9fa7b6767d00dffee303a42c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87eb38047efbafe866142ea915bab39d" id="r_a87eb38047efbafe866142ea915bab39d"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structauxprm.html#a87eb38047efbafe866142ea915bab39d">dummy</a> [2]</td></tr>
<tr class="separator:a87eb38047efbafe866142ea915bab39d"><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>Additional auxiliary parameters. </p>
<p>The <b>auxprm</b> struct holds auxiliary coordinate system information of a specialist nature. It is anticipated that this struct will expand in future to accomodate additional parameters.</p>
<p>All members of this struct are to be set by the user. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="ae90fd56f574beaf8a3c5d7136bfb4a01" name="ae90fd56f574beaf8a3c5d7136bfb4a01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae90fd56f574beaf8a3c5d7136bfb4a01">&#9670;&#160;</a></span>rsun_ref</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double auxprm::rsun_ref</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(Given, auxiliary) Reference radius of the Sun used in coordinate calculations (m). </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double auxprm::dsun_obs</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(Given, auxiliary) Distance between the centre of the Sun and the observer (m). </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double auxprm::crln_obs</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(Given, auxiliary) Carrington heliographic longitude of the observer (deg). </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double auxprm::hgln_obs</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(Given, auxiliary) Stonyhurst heliographic longitude of the observer (deg). </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double auxprm::hglt_obs</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>(Given, auxiliary) Heliographic latitude (Carrington or Stonyhurst) of the observer (deg). </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double auxprm::a_radius</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Length of the semi-major axis of a triaxial ellipsoid approximating the shape of a body (e.g. planet) in the solar system (m). </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double auxprm::b_radius</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Length of the intermediate axis, normal to the semi-major and semi-minor axes, of a triaxial ellipsoid approximating the shape of a body (m). </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double auxprm::c_radius</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Length of the semi-minor axis, normal to the semi-major axis, of a triaxial ellipsoid approximating the shape of a body (m). </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double auxprm::blon_obs</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Bodycentric longitude of the observer in the coordinate system fixed to the planet or other solar system body (deg, in range 0 to 360). </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double auxprm::blat_obs</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Bodycentric latitude of the observer in the coordinate system fixed to the planet or other solar system body (deg). </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double auxprm::bdis_obs</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Bodycentric distance of the observer (m).</p>
<p>Global variable: const char *wcs_errmsg[] - Status return messages Error messages to match the status value returned from each function. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double auxprm::dummy[2]</td>
        </tr>
      </table>
</div><div class="memdoc">

</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>