<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>WCSLIB 4.18: linprm 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="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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">WCSLIB 4.18
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">linprm Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Linear transformation parameters.
<a href="structlinprm.html#details">More...</a></p>
<p><code>#include <<a class="el" href="lin_8h_source.html">lin.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a5bb0b2b2ce1f160a8a70f6437a893eea"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#a5bb0b2b2ce1f160a8a70f6437a893eea">flag</a></td></tr>
<tr class="separator:a5bb0b2b2ce1f160a8a70f6437a893eea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae281f0f7ebeaf5038cc13c13946641b1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#ae281f0f7ebeaf5038cc13c13946641b1">naxis</a></td></tr>
<tr class="separator:ae281f0f7ebeaf5038cc13c13946641b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3691ff3f40a0ba087637d30ffc87e6d0"><td class="memItemLeft" align="right" valign="top">double * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#a3691ff3f40a0ba087637d30ffc87e6d0">crpix</a></td></tr>
<tr class="separator:a3691ff3f40a0ba087637d30ffc87e6d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c40bec32ec40035b8c1ef13db652270"><td class="memItemLeft" align="right" valign="top">double * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#a4c40bec32ec40035b8c1ef13db652270">pc</a></td></tr>
<tr class="separator:a4c40bec32ec40035b8c1ef13db652270"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a162762d02eaade6a53d63d70b8827caa"><td class="memItemLeft" align="right" valign="top">double * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#a162762d02eaade6a53d63d70b8827caa">cdelt</a></td></tr>
<tr class="separator:a162762d02eaade6a53d63d70b8827caa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeaaf26fd243da58fee173b075bed1de7"><td class="memItemLeft" align="right" valign="top">double * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#aeaaf26fd243da58fee173b075bed1de7">piximg</a></td></tr>
<tr class="separator:aeaaf26fd243da58fee173b075bed1de7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a28a705f744a32cd05dd3aa86ca58998b"><td class="memItemLeft" align="right" valign="top">double * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#a28a705f744a32cd05dd3aa86ca58998b">imgpix</a></td></tr>
<tr class="separator:a28a705f744a32cd05dd3aa86ca58998b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0a5cac7b1d2d3a0feb6905c05b122c2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#af0a5cac7b1d2d3a0feb6905c05b122c2">unity</a></td></tr>
<tr class="separator:af0a5cac7b1d2d3a0feb6905c05b122c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7f40c88135117b07a7767082ef24aba9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#a7f40c88135117b07a7767082ef24aba9">padding</a></td></tr>
<tr class="separator:a7f40c88135117b07a7767082ef24aba9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2975830d4214bb6b35cb1ca922875057"><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="structlinprm.html#a2975830d4214bb6b35cb1ca922875057">err</a></td></tr>
<tr class="separator:a2975830d4214bb6b35cb1ca922875057"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a596f68ff17fce142f36530d72dd838c4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#a596f68ff17fce142f36530d72dd838c4">i_naxis</a></td></tr>
<tr class="separator:a596f68ff17fce142f36530d72dd838c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ef7cce6307f640aca1080d0d5ad9ba1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#a5ef7cce6307f640aca1080d0d5ad9ba1">m_flag</a></td></tr>
<tr class="separator:a5ef7cce6307f640aca1080d0d5ad9ba1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeefcacedf2989970f0df2c246d84bfb7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#aeefcacedf2989970f0df2c246d84bfb7">m_naxis</a></td></tr>
<tr class="separator:aeefcacedf2989970f0df2c246d84bfb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab73e780d0792b3570fcf2cf55651f22c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#ab73e780d0792b3570fcf2cf55651f22c">m_padding</a></td></tr>
<tr class="separator:ab73e780d0792b3570fcf2cf55651f22c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a091103ceb860eeed1a280effa0df28df"><td class="memItemLeft" align="right" valign="top">double * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#a091103ceb860eeed1a280effa0df28df">m_crpix</a></td></tr>
<tr class="separator:a091103ceb860eeed1a280effa0df28df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7036b8527bc8b220ad8a863442631f48"><td class="memItemLeft" align="right" valign="top">double * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#a7036b8527bc8b220ad8a863442631f48">m_pc</a></td></tr>
<tr class="separator:a7036b8527bc8b220ad8a863442631f48"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ac85757a7a46247e353a089374eb128"><td class="memItemLeft" align="right" valign="top">double * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#a5ac85757a7a46247e353a089374eb128">m_cdelt</a></td></tr>
<tr class="separator:a5ac85757a7a46247e353a089374eb128"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba4a6d5c87b53b6f3a4399276ac13a2c"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlinprm.html#aba4a6d5c87b53b6f3a4399276ac13a2c">padding2</a></td></tr>
<tr class="separator:aba4a6d5c87b53b6f3a4399276ac13a2c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <b>linprm</b> struct contains all of the information required to perform a linear transformation. 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>). </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a5bb0b2b2ce1f160a8a70f6437a893eea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linprm::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>linprm</b> struct are set or modified:</p>
<ul>
<li>
<a class="el" href="structlinprm.html#ae281f0f7ebeaf5038cc13c13946641b1">linprm::naxis</a> (q.v., not normally set by the user), </li>
<li>
<a class="el" href="structlinprm.html#a4c40bec32ec40035b8c1ef13db652270">linprm::pc</a>, </li>
<li>
<a class="el" href="structlinprm.html#a162762d02eaade6a53d63d70b8827caa">linprm::cdelt</a>. </li>
</ul>
<p>This signals the initialization routine, <a class="el" href="lin_8h.html#a5c01c0991c8d0c4437581a7c1453b09a" title="Setup routine for the linprm struct. ">linset()</a>, to recompute the returned members of the <b>linprm</b> struct. <a class="el" href="lin_8h.html#a5c01c0991c8d0c4437581a7c1453b09a" title="Setup routine for the linprm struct. ">linset()</a> will reset flag to indicate that this has been done.</p>
<p><b>PLEASE NOTE:</b> flag should be set to -1 when <a class="el" href="lin_8h.html#a7ddea28768d99f01c6be1c71a4d8fe58" title="Default constructor for the linprm struct. ">linini()</a> is called for the first time for a particular <b>linprm</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 class="anchor" id="ae281f0f7ebeaf5038cc13c13946641b1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linprm::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="lin_8h.html#a7ddea28768d99f01c6be1c71a4d8fe58" title="Default constructor for the linprm struct. ">linini()</a> is used to initialize the <b>linprm</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 class="anchor" id="a3691ff3f40a0ba087637d30ffc87e6d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double * linprm::crpix</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) Pointer to the first element of an array of double containing the coordinate reference pixel, <code><b>CRPIX</b>ja</code>. </p>
</div>
</div>
<a class="anchor" id="a4c40bec32ec40035b8c1ef13db652270"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double * linprm::pc</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) Pointer to the first element of the <code><b>PC</b>i<b>_</b>ja</code> (pixel coordinate) transformation matrix. The expected order is </p>
<div class="fragment"><div class="line"><span class="keyword">struct </span><a class="code" href="structlinprm.html" title="Linear transformation parameters. ">linprm</a> lin;</div>
<div class="line">lin.<a class="code" href="structlinprm.html#a4c40bec32ec40035b8c1ef13db652270">pc</a> = {PC1_1, PC1_2, PC2_1, PC2_2};</div>
</div><!-- fragment --><p>This may be constructed conveniently from a 2-D array via </p>
<div class="fragment"><div class="line"><span class="keywordtype">double</span> m[2][2] = {{PC1_1, PC1_2},</div>
<div class="line"> {PC2_1, PC2_2}};</div>
</div><!-- fragment --><p>which is equivalent to </p>
<div class="fragment"><div class="line"><span class="keywordtype">double</span> m[2][2];</div>
<div class="line">m[0][0] = PC1_1;</div>
<div class="line">m[0][1] = PC1_2;</div>
<div class="line">m[1][0] = PC2_1;</div>
<div class="line">m[1][1] = PC2_2;</div>
</div><!-- fragment --><p>The storage order for this 2-D array is the same as for the 1-D array, whence </p>
<div class="fragment"><div class="line">lin.pc = *m;</div>
</div><!-- fragment --><p>would be legitimate. </p>
</div>
</div>
<a class="anchor" id="a162762d02eaade6a53d63d70b8827caa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double * linprm::cdelt</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) Pointer to the first element of an array of double containing the coordinate increments, <code><b>CDELT</b>ia</code>. </p>
</div>
</div>
<a class="anchor" id="aeaaf26fd243da58fee173b075bed1de7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double * linprm::piximg</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Pointer to the first element of the matrix containing the product of the <code><b>CDELT</b>ia</code> diagonal matrix and the <code><b>PC</b>i<b>_</b>ja</code> matrix. </p>
</div>
</div>
<a class="anchor" id="a28a705f744a32cd05dd3aa86ca58998b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double * linprm::imgpix</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Returned</em>) Pointer to the first element of the inverse of the <a class="el" href="structlinprm.html#aeaaf26fd243da58fee173b075bed1de7">linprm::piximg</a> matrix. </p>
</div>
</div>
<a class="anchor" id="af0a5cac7b1d2d3a0feb6905c05b122c2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linprm::unity</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Returned</em>) True if the linear transformation matrix is unity. </p>
</div>
</div>
<a class="anchor" id="a7f40c88135117b07a7767082ef24aba9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linprm::padding</td>
</tr>
</table>
</div><div class="memdoc">
<p>(An unused variable inserted for alignment purposes only.) </p>
</div>
</div>
<a class="anchor" id="a2975830d4214bb6b35cb1ca922875057"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structwcserr.html">wcserr</a> * linprm::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 class="anchor" id="a596f68ff17fce142f36530d72dd838c4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linprm::i_naxis</td>
</tr>
</table>
</div><div class="memdoc">
<p>(For internal use only.) </p>
</div>
</div>
<a class="anchor" id="a5ef7cce6307f640aca1080d0d5ad9ba1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linprm::m_flag</td>
</tr>
</table>
</div><div class="memdoc">
<p>(For internal use only.) </p>
</div>
</div>
<a class="anchor" id="aeefcacedf2989970f0df2c246d84bfb7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linprm::m_naxis</td>
</tr>
</table>
</div><div class="memdoc">
<p>(For internal use only.) </p>
</div>
</div>
<a class="anchor" id="ab73e780d0792b3570fcf2cf55651f22c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int linprm::m_padding</td>
</tr>
</table>
</div><div class="memdoc">
<p>(For internal use only.) </p>
</div>
</div>
<a class="anchor" id="a091103ceb860eeed1a280effa0df28df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double * linprm::m_crpix</td>
</tr>
</table>
</div><div class="memdoc">
<p>(For internal use only.) </p>
</div>
</div>
<a class="anchor" id="a7036b8527bc8b220ad8a863442631f48"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double * linprm::m_pc</td>
</tr>
</table>
</div><div class="memdoc">
<p>(For internal use only.) </p>
</div>
</div>
<a class="anchor" id="a5ac85757a7a46247e353a089374eb128"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double * linprm::m_cdelt</td>
</tr>
</table>
</div><div class="memdoc">
<p>(For internal use only.) </p>
</div>
</div>
<a class="anchor" id="aba4a6d5c87b53b6f3a4399276ac13a2c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * linprm::padding2</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 Sat Jul 13 2013 20:00:27 for WCSLIB 4.18 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>
