wcslib (8.2.2)
<!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: disprm 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"> 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&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&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">disprm Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Distortion parameters.
<a href="structdisprm.html#details">More...</a></p>
<p><code>#include <<a class="el" href="dis_8h_source.html">dis.h</a>></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:a4d6ba28bee2fc636f4b2b9ca4b50b0a4" id="r_a4d6ba28bee2fc636f4b2b9ca4b50b0a4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a4d6ba28bee2fc636f4b2b9ca4b50b0a4">flag</a></td></tr>
<tr class="separator:a4d6ba28bee2fc636f4b2b9ca4b50b0a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a201bc2948f326bbed9a0e1f818720ef9" id="r_a201bc2948f326bbed9a0e1f818720ef9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a201bc2948f326bbed9a0e1f818720ef9">naxis</a></td></tr>
<tr class="separator:a201bc2948f326bbed9a0e1f818720ef9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a434f7952a43eba6485c03335179a25a7" id="r_a434f7952a43eba6485c03335179a25a7"><td class="memItemLeft" align="right" valign="top">char(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a434f7952a43eba6485c03335179a25a7">dtype</a> )[72]</td></tr>
<tr class="separator:a434f7952a43eba6485c03335179a25a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acac42172b4486502e27e1b6e198c557f" id="r_acac42172b4486502e27e1b6e198c557f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#acac42172b4486502e27e1b6e198c557f">ndp</a></td></tr>
<tr class="separator:acac42172b4486502e27e1b6e198c557f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6307557409cf4679a176f16b7dc14b7f" id="r_a6307557409cf4679a176f16b7dc14b7f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a6307557409cf4679a176f16b7dc14b7f">ndpmax</a></td></tr>
<tr class="separator:a6307557409cf4679a176f16b7dc14b7f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71567452603ef3effc07877e7366a5b2" id="r_a71567452603ef3effc07877e7366a5b2"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structdpkey.html">dpkey</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a71567452603ef3effc07877e7366a5b2">dp</a></td></tr>
<tr class="separator:a71567452603ef3effc07877e7366a5b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10a16217368a5cdd34d802fff442f383" id="r_a10a16217368a5cdd34d802fff442f383"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a10a16217368a5cdd34d802fff442f383">totdis</a></td></tr>
<tr class="separator:a10a16217368a5cdd34d802fff442f383"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac107b9b4c645a461036476290a87ab22" id="r_ac107b9b4c645a461036476290a87ab22"><td class="memItemLeft" align="right" valign="top">double * </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#ac107b9b4c645a461036476290a87ab22">maxdis</a></td></tr>
<tr class="separator:ac107b9b4c645a461036476290a87ab22"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a896bb8ce24e1b3cab7179eeaa0cfa2d4" id="r_a896bb8ce24e1b3cab7179eeaa0cfa2d4"><td class="memItemLeft" align="right" valign="top">int * </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a896bb8ce24e1b3cab7179eeaa0cfa2d4">docorr</a></td></tr>
<tr class="separator:a896bb8ce24e1b3cab7179eeaa0cfa2d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0fa6585e8b763cc0dcbe3775ca504a7" id="r_af0fa6585e8b763cc0dcbe3775ca504a7"><td class="memItemLeft" align="right" valign="top">int * </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#af0fa6585e8b763cc0dcbe3775ca504a7">Nhat</a></td></tr>
<tr class="separator:af0fa6585e8b763cc0dcbe3775ca504a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab62d14319c82c93c70d290728cab78c4" id="r_ab62d14319c82c93c70d290728cab78c4"><td class="memItemLeft" align="right" valign="top">int ** </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#ab62d14319c82c93c70d290728cab78c4">axmap</a></td></tr>
<tr class="separator:ab62d14319c82c93c70d290728cab78c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b0ac30436d7bb3e12e0ca1c64fda337" id="r_a8b0ac30436d7bb3e12e0ca1c64fda337"><td class="memItemLeft" align="right" valign="top">double ** </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a8b0ac30436d7bb3e12e0ca1c64fda337">offset</a></td></tr>
<tr class="separator:a8b0ac30436d7bb3e12e0ca1c64fda337"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f7b541d7130698acc6781b7ca83dab8" id="r_a1f7b541d7130698acc6781b7ca83dab8"><td class="memItemLeft" align="right" valign="top">double ** </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a1f7b541d7130698acc6781b7ca83dab8">scale</a></td></tr>
<tr class="separator:a1f7b541d7130698acc6781b7ca83dab8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c5120a5905e79191adf6d98bdc63e50" id="r_a1c5120a5905e79191adf6d98bdc63e50"><td class="memItemLeft" align="right" valign="top">int ** </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a1c5120a5905e79191adf6d98bdc63e50">iparm</a></td></tr>
<tr class="separator:a1c5120a5905e79191adf6d98bdc63e50"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9775ace81c64bf04c0fbe5b750bc2a79" id="r_a9775ace81c64bf04c0fbe5b750bc2a79"><td class="memItemLeft" align="right" valign="top">double ** </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a9775ace81c64bf04c0fbe5b750bc2a79">dparm</a></td></tr>
<tr class="separator:a9775ace81c64bf04c0fbe5b750bc2a79"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a51ff2cd3afbfdaed9da115f2f46f3ff9" id="r_a51ff2cd3afbfdaed9da115f2f46f3ff9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a51ff2cd3afbfdaed9da115f2f46f3ff9">i_naxis</a></td></tr>
<tr class="separator:a51ff2cd3afbfdaed9da115f2f46f3ff9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7fae0b75ba71ee0eaafaa1d3a20cc6af" id="r_a7fae0b75ba71ee0eaafaa1d3a20cc6af"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a7fae0b75ba71ee0eaafaa1d3a20cc6af">ndis</a></td></tr>
<tr class="separator:a7fae0b75ba71ee0eaafaa1d3a20cc6af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a40a81085335f9d9aa617eb9605ae9421" id="r_a40a81085335f9d9aa617eb9605ae9421"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structwcserr.html">wcserr</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a40a81085335f9d9aa617eb9605ae9421">err</a></td></tr>
<tr class="separator:a40a81085335f9d9aa617eb9605ae9421"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a52c639193240123e66b75e68a9a26add" id="r_a52c639193240123e66b75e68a9a26add"><td class="memItemLeft" align="right" valign="top">int(** </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a52c639193240123e66b75e68a9a26add">disp2x</a> )(<a class="el" href="dis_8h.html#a23068602f42552a4257462b2875d8c51">DISP2X_ARGS</a>)</td></tr>
<tr class="separator:a52c639193240123e66b75e68a9a26add"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae438b6d2aaea0e6b97c3a3377d6904f3" id="r_ae438b6d2aaea0e6b97c3a3377d6904f3"><td class="memItemLeft" align="right" valign="top">int(** </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#ae438b6d2aaea0e6b97c3a3377d6904f3">disx2p</a> )(<a class="el" href="dis_8h.html#ac593cd79fb7f89b1c7395d0ecf2f7876">DISX2P_ARGS</a>)</td></tr>
<tr class="separator:ae438b6d2aaea0e6b97c3a3377d6904f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb5079136a7ec5ae4effef9790e31439" id="r_afb5079136a7ec5ae4effef9790e31439"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#afb5079136a7ec5ae4effef9790e31439">m_flag</a></td></tr>
<tr class="separator:afb5079136a7ec5ae4effef9790e31439"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a8b2e3fc58d8f21668a82a93b199712" id="r_a6a8b2e3fc58d8f21668a82a93b199712"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a6a8b2e3fc58d8f21668a82a93b199712">m_naxis</a></td></tr>
<tr class="separator:a6a8b2e3fc58d8f21668a82a93b199712"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9649d0399d35dbad2c90127f8c7eeb75" id="r_a9649d0399d35dbad2c90127f8c7eeb75"><td class="memItemLeft" align="right" valign="top">char(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a9649d0399d35dbad2c90127f8c7eeb75">m_dtype</a> )[72]</td></tr>
<tr class="separator:a9649d0399d35dbad2c90127f8c7eeb75"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abea82d3433ef561c144dfe1f481e51b3" id="r_abea82d3433ef561c144dfe1f481e51b3"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structdpkey.html">dpkey</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#abea82d3433ef561c144dfe1f481e51b3">m_dp</a></td></tr>
<tr class="separator:abea82d3433ef561c144dfe1f481e51b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f692b3bb436ceab5861ec9566d127e4" id="r_a4f692b3bb436ceab5861ec9566d127e4"><td class="memItemLeft" align="right" valign="top">double * </td><td class="memItemRight" valign="bottom"><a class="el" href="structdisprm.html#a4f692b3bb436ceab5861ec9566d127e4">m_maxdis</a></td></tr>
<tr class="separator:a4f692b3bb436ceab5861ec9566d127e4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Distortion parameters. </p>
<p>The <b>disprm</b> struct contains all of the information required to apply a set of distortion functions. It consists of certain members that must be set by the user (<em>given</em>) and others that are set by the WCSLIB routines (<em>returned</em>). While the addresses of the arrays themselves may be set by <a class="el" href="dis_8h.html#a3e0e67bdd01c86eede779de63249c703" title="Default constructor for the disprm struct.">disinit()</a> if it (optionally) allocates memory, their contents must be set by the user. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a4d6ba28bee2fc636f4b2b9ca4b50b0a4" name="a4d6ba28bee2fc636f4b2b9ca4b50b0a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d6ba28bee2fc636f4b2b9ca4b50b0a4">◆ </a></span>flag</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int disprm::flag</td>
</tr>
</table>
</div><div class="memdoc">
<p>(Given and returned) This flag must be set to zero whenever any of the following members of the <b>disprm</b> struct are set or modified:</p>
<ul>
<li>
<a class="el" href="structdisprm.html#a201bc2948f326bbed9a0e1f818720ef9">disprm::naxis</a>, </li>
<li>
<a class="el" href="structdisprm.html#a434f7952a43eba6485c03335179a25a7">disprm::dtype</a>, </li>
<li>
<a class="el" href="structdisprm.html#acac42172b4486502e27e1b6e198c557f">disprm::ndp</a>, </li>
<li>
<a class="el" href="structdisprm.html#a71567452603ef3effc07877e7366a5b2">disprm::dp</a>. </li>
</ul>
<p>This signals the initialization routine, <a class="el" href="dis_8h.html#ad1bdf4497eb4513ca8431e1baa419041" title="Setup routine for the disprm struct.">disset()</a>, to recompute the returned members of the <b>disprm</b> struct. <a class="el" href="dis_8h.html#ad1bdf4497eb4513ca8431e1baa419041" title="Setup routine for the disprm struct.">disset()</a> will reset flag to indicate that this has been done.</p>
<p><b>PLEASE NOTE:</b> flag must be set to -1 when <a class="el" href="dis_8h.html#a3e0e67bdd01c86eede779de63249c703" title="Default constructor for the disprm struct.">disinit()</a> is called for the first time for a particular <b>disprm</b> struct in order to initialize memory management. It must ONLY be used on the first initialization otherwise memory leaks may result. </p>
</div>
</div>
<a id="a201bc2948f326bbed9a0e1f818720ef9" name="a201bc2948f326bbed9a0e1f818720ef9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a201bc2948f326bbed9a0e1f818720ef9">◆ </a></span>naxis</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int disprm::naxis</td>
</tr>
</table>
</div><div class="memdoc">
<p>(Given or returned) Number of pixel and world coordinate elements.</p>
<p>If <a class="el" href="dis_8h.html#a3e0e67bdd01c86eede779de63249c703" title="Default constructor for the disprm struct.">disinit()</a> is used to initialize the <b>disprm</b> struct (as would normally be the case) then it will set naxis from the value passed to it as a function argument. The user should not subsequently modify it. </p>
</div>
</div>
<a id="a434f7952a43eba6485c03335179a25a7" name="a434f7952a43eba6485c03335179a25a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a434f7952a43eba6485c03335179a25a7">◆ </a></span>dtype</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">disprm::dtype</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) Pointer to the first element of an array of char[72] containing the name of the distortion function for each axis. </p>
</div>
</div>
<a id="acac42172b4486502e27e1b6e198c557f" name="acac42172b4486502e27e1b6e198c557f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acac42172b4486502e27e1b6e198c557f">◆ </a></span>ndp</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int disprm::ndp</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) The number of entries in the <a class="el" href="structdisprm.html#a71567452603ef3effc07877e7366a5b2">disprm::dp</a>[] array. </p>
</div>
</div>
<a id="a6307557409cf4679a176f16b7dc14b7f" name="a6307557409cf4679a176f16b7dc14b7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6307557409cf4679a176f16b7dc14b7f">◆ </a></span>ndpmax</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int disprm::ndpmax</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) The length of the <a class="el" href="structdisprm.html#a71567452603ef3effc07877e7366a5b2">disprm::dp</a>[] array.</p>
<p>ndpmax will be set by <a class="el" href="dis_8h.html#a3e0e67bdd01c86eede779de63249c703" title="Default constructor for the disprm struct.">disinit()</a> if it allocates memory for <a class="el" href="structdisprm.html#a71567452603ef3effc07877e7366a5b2">disprm::dp</a>[], otherwise it must be set by the user. See also <a class="el" href="dis_8h.html#aa5486b870327544f7423ad2751fb4120" title="Memory allocation for DPja and DQia.">disndp()</a>. </p>
</div>
</div>
<a id="a71567452603ef3effc07877e7366a5b2" name="a71567452603ef3effc07877e7366a5b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71567452603ef3effc07877e7366a5b2">◆ </a></span>dp</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structdpkey.html">dpkey</a> disprm::dp</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) Address of the first element of an array of length ndpmax of dpkey structs.</p>
<p>As a FITS header parser encounters each <code><b>DP</b>ja</code> or <code><b>DQ</b>ia</code> keyword it should load it into a dpkey struct in the array and increment ndp. However, note that a single <b>disprm</b> struct must hold only <code><b>DP</b>ja</code> or <code><b>DQ</b>ia</code> keyvalues, not both. <a class="el" href="dis_8h.html#ad1bdf4497eb4513ca8431e1baa419041" title="Setup routine for the disprm struct.">disset()</a> interprets them as required by the particular distortion function. </p>
</div>
</div>
<a id="a10a16217368a5cdd34d802fff442f383" name="a10a16217368a5cdd34d802fff442f383"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10a16217368a5cdd34d802fff442f383">◆ </a></span>totdis</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double disprm::totdis</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) The maximum absolute value of the combination of all distortion functions specified as an offset in pixel coordinates computed over the whole image.</p>
<p>It is not necessary to reset the <b>disprm</b> struct (via <a class="el" href="dis_8h.html#ad1bdf4497eb4513ca8431e1baa419041" title="Setup routine for the disprm struct.">disset()</a>) when <a class="el" href="structdisprm.html#a10a16217368a5cdd34d802fff442f383">disprm::totdis</a> is changed. </p>
</div>
</div>
<a id="ac107b9b4c645a461036476290a87ab22" name="ac107b9b4c645a461036476290a87ab22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac107b9b4c645a461036476290a87ab22">◆ </a></span>maxdis</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double * disprm::maxdis</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) Pointer to the first element of an array of double specifying the maximum absolute value of the distortion for each axis computed over the whole image.</p>
<p>It is not necessary to reset the <b>disprm</b> struct (via <a class="el" href="dis_8h.html#ad1bdf4497eb4513ca8431e1baa419041" title="Setup routine for the disprm struct.">disset()</a>) when <a class="el" href="structdisprm.html#ac107b9b4c645a461036476290a87ab22">disprm::maxdis</a> is changed. </p>
</div>
</div>
<a id="a896bb8ce24e1b3cab7179eeaa0cfa2d4" name="a896bb8ce24e1b3cab7179eeaa0cfa2d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a896bb8ce24e1b3cab7179eeaa0cfa2d4">◆ </a></span>docorr</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int * disprm::docorr</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Pointer to the first element of an array of int containing flags that indicate the mode of correction for each axis.</p>
<p>If docorr is zero, the distortion function returns the corrected coordinates directly. Any other value indicates that the distortion function computes a correction to be added to pixel coordinates (prior distortion) or intermediate pixel coordinates (sequent distortion). </p>
</div>
</div>
<a id="af0fa6585e8b763cc0dcbe3775ca504a7" name="af0fa6585e8b763cc0dcbe3775ca504a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0fa6585e8b763cc0dcbe3775ca504a7">◆ </a></span>Nhat</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int * disprm::Nhat</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Pointer to the first element of an array of int containing the number of coordinate axes that form the independent variables of the distortion function for each axis. </p>
</div>
</div>
<a id="ab62d14319c82c93c70d290728cab78c4" name="ab62d14319c82c93c70d290728cab78c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab62d14319c82c93c70d290728cab78c4">◆ </a></span>axmap</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ** disprm::axmap</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Pointer to the first element of an array of int* containing pointers to the first elements of the axis mapping arrays for each axis.</p>
<p>An axis mapping associates the independent variables of a distortion function with the 0-relative image axis number. For example, consider an image with a spectrum on the first axis (axis 0), followed by RA (axis 1), Dec (axis2), and time (axis 3) axes. For a distortion in (RA,Dec) and no distortion on the spectral or time axes, the axis mapping arrays, axmap[j][], would be </p><div class="fragment"><div class="line">j=0: [-1, -1, -1, -1] ...no distortion on spectral axis,</div>
<div class="line"> 1: [ 1, 2, -1, -1] ...RA distortion depends on RA and Dec,</div>
<div class="line"> 2: [ 2, 1, -1, -1] ...Dec distortion depends on Dec and RA,</div>
<div class="line"> 3: [-1, -1, -1, -1] ...no distortion on time axis,</div>
</div><!-- fragment --><p>where -1 indicates that there is no corresponding independent variable. </p>
</div>
</div>
<a id="a8b0ac30436d7bb3e12e0ca1c64fda337" name="a8b0ac30436d7bb3e12e0ca1c64fda337"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b0ac30436d7bb3e12e0ca1c64fda337">◆ </a></span>offset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double ** disprm::offset</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Pointer to the first element of an array of double* containing pointers to the first elements of arrays of offsets used to renormalize the independent variables of the distortion function for each axis.</p>
<p>The offsets are subtracted from the independent variables before scaling. </p>
</div>
</div>
<a id="a1f7b541d7130698acc6781b7ca83dab8" name="a1f7b541d7130698acc6781b7ca83dab8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f7b541d7130698acc6781b7ca83dab8">◆ </a></span>scale</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double ** disprm::scale</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Pointer to the first element of an array of double* containing pointers to the first elements of arrays of scales used to renormalize the independent variables of the distortion function for each axis.</p>
<p>The scale is applied to the independent variables after the offsets are subtracted. </p>
</div>
</div>
<a id="a1c5120a5905e79191adf6d98bdc63e50" name="a1c5120a5905e79191adf6d98bdc63e50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c5120a5905e79191adf6d98bdc63e50">◆ </a></span>iparm</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ** disprm::iparm</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Pointer to the first element of an array of int* containing pointers to the first elements of the arrays of integer distortion parameters for each axis. </p>
</div>
</div>
<a id="a9775ace81c64bf04c0fbe5b750bc2a79" name="a9775ace81c64bf04c0fbe5b750bc2a79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9775ace81c64bf04c0fbe5b750bc2a79">◆ </a></span>dparm</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double ** disprm::dparm</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Pointer to the first element of an array of double* containing pointers to the first elements of the arrays of floating point distortion parameters for each axis. </p>
</div>
</div>
<a id="a51ff2cd3afbfdaed9da115f2f46f3ff9" name="a51ff2cd3afbfdaed9da115f2f46f3ff9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51ff2cd3afbfdaed9da115f2f46f3ff9">◆ </a></span>i_naxis</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int disprm::i_naxis</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Dimension of the internal arrays (normally equal to naxis). </p>
</div>
</div>
<a id="a7fae0b75ba71ee0eaafaa1d3a20cc6af" name="a7fae0b75ba71ee0eaafaa1d3a20cc6af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7fae0b75ba71ee0eaafaa1d3a20cc6af">◆ </a></span>ndis</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int disprm::ndis</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Returned</em>) The number of distortion functions. </p>
</div>
</div>
<a id="a40a81085335f9d9aa617eb9605ae9421" name="a40a81085335f9d9aa617eb9605ae9421"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40a81085335f9d9aa617eb9605ae9421">◆ </a></span>err</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structwcserr.html">wcserr</a> * disprm::err</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Returned</em>) If enabled, when an error status is returned, this struct contains detailed information about the error, see <a class="el" href="wcserr_8h.html#a1691b8bd184d40ca6fda255be078fa53" title="Enable/disable error messaging.">wcserr_enable()</a>. </p>
</div>
</div>
<a id="a52c639193240123e66b75e68a9a26add" name="a52c639193240123e66b75e68a9a26add"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52c639193240123e66b75e68a9a26add">◆ </a></span>disp2x</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(** disprm::disp2x)(<a class="el" href="dis_8h.html#a23068602f42552a4257462b2875d8c51">DISP2X_ARGS</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>(For internal use only.) </p>
</div>
</div>
<a id="ae438b6d2aaea0e6b97c3a3377d6904f3" name="ae438b6d2aaea0e6b97c3a3377d6904f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae438b6d2aaea0e6b97c3a3377d6904f3">◆ </a></span>disx2p</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(** disprm::disx2p)(<a class="el" href="dis_8h.html#ac593cd79fb7f89b1c7395d0ecf2f7876">DISX2P_ARGS</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>(For internal use only.) </p>
</div>
</div>
<a id="afb5079136a7ec5ae4effef9790e31439" name="afb5079136a7ec5ae4effef9790e31439"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb5079136a7ec5ae4effef9790e31439">◆ </a></span>m_flag</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int disprm::m_flag</td>
</tr>
</table>
</div><div class="memdoc">
<p>(For internal use only.) </p>
</div>
</div>
<a id="a6a8b2e3fc58d8f21668a82a93b199712" name="a6a8b2e3fc58d8f21668a82a93b199712"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a8b2e3fc58d8f21668a82a93b199712">◆ </a></span>m_naxis</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int disprm::m_naxis</td>
</tr>
</table>
</div><div class="memdoc">
<p>(For internal use only.) </p>
</div>
</div>
<a id="a9649d0399d35dbad2c90127f8c7eeb75" name="a9649d0399d35dbad2c90127f8c7eeb75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9649d0399d35dbad2c90127f8c7eeb75">◆ </a></span>m_dtype</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">disprm::m_dtype</td>
</tr>
</table>
</div><div class="memdoc">
<p>(For internal use only.) </p>
</div>
</div>
<a id="abea82d3433ef561c144dfe1f481e51b3" name="abea82d3433ef561c144dfe1f481e51b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abea82d3433ef561c144dfe1f481e51b3">◆ </a></span>m_dp</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double ** disprm::m_dp</td>
</tr>
</table>
</div><div class="memdoc">
<p>(For internal use only.) </p>
</div>
</div>
<a id="a4f692b3bb436ceab5861ec9566d127e4" name="a4f692b3bb436ceab5861ec9566d127e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f692b3bb436ceab5861ec9566d127e4">◆ </a></span>m_maxdis</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double * disprm::m_maxdis</td>
</tr>
</table>
</div><div class="memdoc">
<p>(For internal use only.) </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 <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>
Browse
Usage
Versions