File: structwtbarr.html

package info (click to toggle)
python-pywcs 1.11-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 11,888 kB
  • sloc: ansic: 31,441; lex: 6,170; fortran: 6,080; sh: 3,478; python: 3,122; sed: 408; makefile: 76
file content (235 lines) | stat: -rw-r--r-- 11,406 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>WCSLIB 4.8.2: wtbarr Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>wtbarr Struct Reference</h1><!-- doxytag: class="wtbarr" -->Extraction of coordinate lookup tables from BINTABLE.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="getwcstab_8h-source.html">getwcstab.h</a>&gt;</code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#8743b84c99b4b5e7ab7bf0653507a180">i</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#1e88ad32570534a006e96cba721489b5">m</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#f8ea7b15992ab7a86be63ff83318be41">kind</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#9f1fcad814aa3da08dfa75ede2a07deb">extnam</a> [72]</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#24487eda7b17800f41bd4a452c6306d5">extver</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#10c8dba85b62e2794071dd50a41c4bb1">extlev</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#750832793167bbeebd1074e29844415d">ttype</a> [72]</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#2ff7c235353320c6dd98951484012ee7">row</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#f862b4f90b0406ed8dd0c240768d4bd3">ndim</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#901403d05f985d4a1fbd2fdc9585bd50">dimlen</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">double **&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwtbarr.html#41c30234dbdf18ac094872cf39562172">arrayp</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Function <a class="el" href="wcshdr_8h.html#6dd857f7b61a5b349cc8af5a4b6d8a1c" title="Tabular construction routine.">wcstab()</a>, which is invoked automatically by <a class="el" href="wcshdr_8h.html#c75623ee805ab7d43b0bba684c719a60" 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 <a class="el" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> structs stored in <a class="el" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a>. Refer to the usage notes for <a class="el" href="wcshdr_8h.html#c75623ee805ab7d43b0bba684c719a60" title="FITS WCS parser routine for image headers.">wcspih()</a> and <a class="el" href="wcshdr_8h.html#6dd857f7b61a5b349cc8af5a4b6d8a1c" 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>
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 <a class="el" href="wcs_8h.html">wcs.h</a> itself. <hr><h2>Field Documentation</h2>
<a class="anchor" name="8743b84c99b4b5e7ab7bf0653507a180"></a><!-- doxytag: member="wtbarr::i" ref="8743b84c99b4b5e7ab7bf0653507a180" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structwtbarr.html#8743b84c99b4b5e7ab7bf0653507a180">wtbarr::i</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
(<em>Given</em>) Image axis number. 
</div>
</div><p>
<a class="anchor" name="1e88ad32570534a006e96cba721489b5"></a><!-- doxytag: member="wtbarr::m" ref="1e88ad32570534a006e96cba721489b5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structwtbarr.html#1e88ad32570534a006e96cba721489b5">wtbarr::m</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
(<em>Given</em>) wcstab array axis number for index vectors. 
</div>
</div><p>
<a class="anchor" name="f8ea7b15992ab7a86be63ff83318be41"></a><!-- doxytag: member="wtbarr::kind" ref="f8ea7b15992ab7a86be63ff83318be41" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structwtbarr.html#f8ea7b15992ab7a86be63ff83318be41">wtbarr::kind</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
(<em>Given</em>) Character identifying the wcstab array type: <ul>
<li>
c: coordinate array, </li>
<li>
i: index vector. </li>
</ul>

</div>
</div><p>
<a class="anchor" name="9f1fcad814aa3da08dfa75ede2a07deb"></a><!-- doxytag: member="wtbarr::extnam" ref="9f1fcad814aa3da08dfa75ede2a07deb" args="[72]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char <a class="el" href="structwtbarr.html#9f1fcad814aa3da08dfa75ede2a07deb">wtbarr::extnam</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
(<em>Given</em>) <code><b>EXTNAME</b></code> identifying the binary table extension. 
</div>
</div><p>
<a class="anchor" name="24487eda7b17800f41bd4a452c6306d5"></a><!-- doxytag: member="wtbarr::extver" ref="24487eda7b17800f41bd4a452c6306d5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structwtbarr.html#24487eda7b17800f41bd4a452c6306d5">wtbarr::extver</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
(<em>Given</em>) <code><b>EXTVER</b></code> identifying the binary table extension. 
</div>
</div><p>
<a class="anchor" name="10c8dba85b62e2794071dd50a41c4bb1"></a><!-- doxytag: member="wtbarr::extlev" ref="10c8dba85b62e2794071dd50a41c4bb1" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structwtbarr.html#10c8dba85b62e2794071dd50a41c4bb1">wtbarr::extlev</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
(<em>Given</em>) <code><b>EXTLEV</b></code> identifying the binary table extension. 
</div>
</div><p>
<a class="anchor" name="750832793167bbeebd1074e29844415d"></a><!-- doxytag: member="wtbarr::ttype" ref="750832793167bbeebd1074e29844415d" args="[72]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char <a class="el" href="structwtbarr.html#750832793167bbeebd1074e29844415d">wtbarr::ttype</a>          </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. 
</div>
</div><p>
<a class="anchor" name="2ff7c235353320c6dd98951484012ee7"></a><!-- doxytag: member="wtbarr::row" ref="2ff7c235353320c6dd98951484012ee7" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">long <a class="el" href="structwtbarr.html#2ff7c235353320c6dd98951484012ee7">wtbarr::row</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
(<em>Given</em>) Table row number. 
</div>
</div><p>
<a class="anchor" name="f862b4f90b0406ed8dd0c240768d4bd3"></a><!-- doxytag: member="wtbarr::ndim" ref="f862b4f90b0406ed8dd0c240768d4bd3" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structwtbarr.html#f862b4f90b0406ed8dd0c240768d4bd3">wtbarr::ndim</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
(<em>Given</em>) Expected dimensionality of the wcstab array. 
</div>
</div><p>
<a class="anchor" name="901403d05f985d4a1fbd2fdc9585bd50"></a><!-- doxytag: member="wtbarr::dimlen" ref="901403d05f985d4a1fbd2fdc9585bd50" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int * <a class="el" href="structwtbarr.html#901403d05f985d4a1fbd2fdc9585bd50">wtbarr::dimlen</a>          </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. 
</div>
</div><p>
<a class="anchor" name="41c30234dbdf18ac094872cf39562172"></a><!-- doxytag: member="wtbarr::arrayp" ref="41c30234dbdf18ac094872cf39562172" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double ** <a class="el" href="structwtbarr.html#41c30234dbdf18ac094872cf39562172">wtbarr::arrayp</a>          </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. 
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Oct 4 19:02:31 2011 for WCSLIB 4.8.2 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>