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: wtbarr 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">wtbarr Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Extraction of coordinate lookup tables from BINTABLE.
<a href="structwtbarr.html#details">More...</a></p>
<p><code>#include <<a class="el" href="getwcstab_8h_source.html">getwcstab.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:a8743b84c99b4b5e7ab7bf0653507a180" id="r_a8743b84c99b4b5e7ab7bf0653507a180"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#a8743b84c99b4b5e7ab7bf0653507a180">i</a></td></tr>
<tr class="separator:a8743b84c99b4b5e7ab7bf0653507a180"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e88ad32570534a006e96cba721489b5" id="r_a1e88ad32570534a006e96cba721489b5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#a1e88ad32570534a006e96cba721489b5">m</a></td></tr>
<tr class="separator:a1e88ad32570534a006e96cba721489b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8ea7b15992ab7a86be63ff83318be41" id="r_af8ea7b15992ab7a86be63ff83318be41"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#af8ea7b15992ab7a86be63ff83318be41">kind</a></td></tr>
<tr class="separator:af8ea7b15992ab7a86be63ff83318be41"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f1fcad814aa3da08dfa75ede2a07deb" id="r_a9f1fcad814aa3da08dfa75ede2a07deb"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#a9f1fcad814aa3da08dfa75ede2a07deb">extnam</a> [72]</td></tr>
<tr class="separator:a9f1fcad814aa3da08dfa75ede2a07deb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24487eda7b17800f41bd4a452c6306d5" id="r_a24487eda7b17800f41bd4a452c6306d5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#a24487eda7b17800f41bd4a452c6306d5">extver</a></td></tr>
<tr class="separator:a24487eda7b17800f41bd4a452c6306d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10c8dba85b62e2794071dd50a41c4bb1" id="r_a10c8dba85b62e2794071dd50a41c4bb1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#a10c8dba85b62e2794071dd50a41c4bb1">extlev</a></td></tr>
<tr class="separator:a10c8dba85b62e2794071dd50a41c4bb1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a750832793167bbeebd1074e29844415d" id="r_a750832793167bbeebd1074e29844415d"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#a750832793167bbeebd1074e29844415d">ttype</a> [72]</td></tr>
<tr class="separator:a750832793167bbeebd1074e29844415d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ff7c235353320c6dd98951484012ee7" id="r_a2ff7c235353320c6dd98951484012ee7"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#a2ff7c235353320c6dd98951484012ee7">row</a></td></tr>
<tr class="separator:a2ff7c235353320c6dd98951484012ee7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af862b4f90b0406ed8dd0c240768d4bd3" id="r_af862b4f90b0406ed8dd0c240768d4bd3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#af862b4f90b0406ed8dd0c240768d4bd3">ndim</a></td></tr>
<tr class="separator:af862b4f90b0406ed8dd0c240768d4bd3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a901403d05f985d4a1fbd2fdc9585bd50" id="r_a901403d05f985d4a1fbd2fdc9585bd50"><td class="memItemLeft" align="right" valign="top">int * </td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#a901403d05f985d4a1fbd2fdc9585bd50">dimlen</a></td></tr>
<tr class="separator:a901403d05f985d4a1fbd2fdc9585bd50"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a41c30234dbdf18ac094872cf39562172" id="r_a41c30234dbdf18ac094872cf39562172"><td class="memItemLeft" align="right" valign="top">double ** </td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#a41c30234dbdf18ac094872cf39562172">arrayp</a></td></tr>
<tr class="separator:a41c30234dbdf18ac094872cf39562172"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Extraction of coordinate lookup tables from BINTABLE. </p>
<p>Function <a class="el" href="wcshdr_8h.html#a6dd857f7b61a5b349cc8af5a4b6d8a1c" title="Tabular construction routine.">wcstab()</a>, which is invoked automatically by <a class="el" href="wcshdr_8h.html#ac75623ee805ab7d43b0bba684c719a60" title="FITS WCS parser routine for image headers.">wcspih()</a>, sets up an array of <b>wtbarr</b> structs to assist in extracting coordinate lookup tables from a binary table extension (BINTABLE) and copying them into the tabprm structs stored in wcsprm. Refer to the usage notes for <a class="el" href="wcshdr_8h.html#ac75623ee805ab7d43b0bba684c719a60" title="FITS WCS parser routine for image headers.">wcspih()</a> and <a class="el" href="wcshdr_8h.html#a6dd857f7b61a5b349cc8af5a4b6d8a1c" title="Tabular construction routine.">wcstab()</a> in <a class="el" href="wcshdr_8h.html">wcshdr.h</a>, and also the prologue to <a class="el" href="tab_8h.html">tab.h</a>.</p>
<p>For C++ usage, because of a name space conflict with the <b>wtbarr</b> typedef defined in CFITSIO header fitsio.h, the <b>wtbarr</b> struct is renamed to <b>wtbarr_s</b> by preprocessor macro substitution with scope limited to <b>wtbarr.h</b> itself, and similarly in <a class="el" href="wcs_8h.html">wcs.h</a>. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a8743b84c99b4b5e7ab7bf0653507a180" name="a8743b84c99b4b5e7ab7bf0653507a180"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8743b84c99b4b5e7ab7bf0653507a180">◆ </a></span>i</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wtbarr::i</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) Image axis number. </p>
</div>
</div>
<a id="a1e88ad32570534a006e96cba721489b5" name="a1e88ad32570534a006e96cba721489b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e88ad32570534a006e96cba721489b5">◆ </a></span>m</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wtbarr::m</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) wcstab array axis number for index vectors. </p>
</div>
</div>
<a id="af8ea7b15992ab7a86be63ff83318be41" name="af8ea7b15992ab7a86be63ff83318be41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8ea7b15992ab7a86be63ff83318be41">◆ </a></span>kind</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wtbarr::kind</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) Character identifying the wcstab array type: </p><ul>
<li>
c: coordinate array, </li>
<li>
i: index vector. </li>
</ul>
</div>
</div>
<a id="a9f1fcad814aa3da08dfa75ede2a07deb" name="a9f1fcad814aa3da08dfa75ede2a07deb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f1fcad814aa3da08dfa75ede2a07deb">◆ </a></span>extnam</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char wtbarr::extnam</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) <code><b>EXTNAME</b></code> identifying the binary table extension. </p>
</div>
</div>
<a id="a24487eda7b17800f41bd4a452c6306d5" name="a24487eda7b17800f41bd4a452c6306d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24487eda7b17800f41bd4a452c6306d5">◆ </a></span>extver</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wtbarr::extver</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) <code><b>EXTVER</b></code> identifying the binary table extension. </p>
</div>
</div>
<a id="a10c8dba85b62e2794071dd50a41c4bb1" name="a10c8dba85b62e2794071dd50a41c4bb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10c8dba85b62e2794071dd50a41c4bb1">◆ </a></span>extlev</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wtbarr::extlev</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) <code><b>EXTLEV</b></code> identifying the binary table extension. </p>
</div>
</div>
<a id="a750832793167bbeebd1074e29844415d" name="a750832793167bbeebd1074e29844415d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a750832793167bbeebd1074e29844415d">◆ </a></span>ttype</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char wtbarr::ttype</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) <code><b>TTYPE</b>n</code> identifying the column of the binary table that contains the wcstab array. </p>
</div>
</div>
<a id="a2ff7c235353320c6dd98951484012ee7" name="a2ff7c235353320c6dd98951484012ee7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ff7c235353320c6dd98951484012ee7">◆ </a></span>row</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long wtbarr::row</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) Table row number. </p>
</div>
</div>
<a id="af862b4f90b0406ed8dd0c240768d4bd3" name="af862b4f90b0406ed8dd0c240768d4bd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af862b4f90b0406ed8dd0c240768d4bd3">◆ </a></span>ndim</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wtbarr::ndim</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) Expected dimensionality of the wcstab array. </p>
</div>
</div>
<a id="a901403d05f985d4a1fbd2fdc9585bd50" name="a901403d05f985d4a1fbd2fdc9585bd50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a901403d05f985d4a1fbd2fdc9585bd50">◆ </a></span>dimlen</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int * wtbarr::dimlen</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) Address of the first element of an array of int of length ndim into which the wcstab array axis lengths are to be written. </p>
</div>
</div>
<a id="a41c30234dbdf18ac094872cf39562172" name="a41c30234dbdf18ac094872cf39562172"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41c30234dbdf18ac094872cf39562172">◆ </a></span>arrayp</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double ** wtbarr::arrayp</td>
</tr>
</table>
</div><div class="memdoc">
<p>(<em>Given</em>) Pointer to an array of double which is to be allocated by the user and into which the wcstab array is to be written. </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