qfits/qfits/html/struct_qfits_table.html

215 lines
6.0 KiB
HTML

<html>
<head>
<meta name="keywords" content="eso, FITS format, C library">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<title>qfits 4.3.3</title>
</head>
<body text="#000000" bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.5 on Wed Nov 5 16:04:35 2003 -->
<h1>qfits_table Struct Reference</h1>Table object.
<a href="#_details">More...</a>
<p>
<code>#include &lt;qfits.h&gt;</code>
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Data Fields</h2></td></tr>
<tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="struct_qfits_table.html#m0">filename</a> [FILENAMESZ]</td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="struct_qfits_table.html#m1">tab_t</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="struct_qfits_table.html#m2">tab_w</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="struct_qfits_table.html#m3">nc</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="struct_qfits_table.html#m4">nr</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="struct_qfits_col.html">qfits_col</a>*&nbsp;</td><td valign=bottom><a class="el" href="struct_qfits_table.html#m5">col</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Table object.
<p>
<p>
This structure contains all information needed to read a FITS table. These information come from the header. The object is created by qfits_open().
<p>
To read a FITS table, here is a code example: <div class="fragment"><pre> <font class="keywordtype">int</font> main(<font class="keywordtype">int</font> argc, <font class="keywordtype">char</font>* argv[])<font class="keyword"></font>
<font class="keyword"> </font>{
<a class="code" href="struct_qfits_table.html">qfits_table</a> * table ;
<font class="keywordtype">int</font> n_ext ;
<font class="keywordtype">int</font> i ;
<font class="comment">// Query the number of extensions</font>
n_ext = <a class="code" href="qfits_h.html#a78">qfits_query_n_ext</a>(argv[1]) ;
<font class="comment">// For each extension</font>
<font class="keywordflow">for</font> (i=0 ; i&lt;n_ext ; i++) {
<font class="comment">// Read all the infos about the current table </font>
table = <a class="code" href="qfits_h.html#a100">qfits_table_open</a>(argv[1], i+1) ;
<font class="comment">// Display the current table </font>
dump_extension(table, stdout, <font class="charliteral">'|'</font>, 1, 1) ;
}
<font class="keywordflow">return</font> ;
}</div></pre>
<p>
<hr><h2>Field Documentation</h2>
<a name="m5" doxytag="qfits_table::col"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="struct_qfits_col.html">qfits_col</a> * qfits_table::col
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Array of <a class="el" href="struct_qfits_col.html">qfits_col</a> objects </td>
</tr>
</table>
<a name="m0" doxytag="qfits_table::filename"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
char qfits_table::filename[FILENAMESZ]
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Name of the file the table comes from or it is intended to end to </td>
</tr>
</table>
<a name="m3" doxytag="qfits_table::nc"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int qfits_table::nc
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Number of columns </td>
</tr>
</table>
<a name="m4" doxytag="qfits_table::nr"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int qfits_table::nr
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Number of raws </td>
</tr>
</table>
<a name="m1" doxytag="qfits_table::tab_t"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int qfits_table::tab_t
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Table type. Possible values: QFITS_INVALIDTABLE, QFITS_BINTABLE, QFITS_ASCIITABLE </td>
</tr>
</table>
<a name="m2" doxytag="qfits_table::tab_w"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int qfits_table::tab_w
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Width in bytes of the table </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="qfits_h.html">qfits.h</a></ul>
</body>
</html>