qfits/qfits/html/structqfits__table.html

200 lines
6.6 KiB
HTML

<html>
<head>
<meta name="keywords" content="eso, FITS format, C library">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<title>qfits 5.1.1</title>
</head>
<body text="#000000" bgcolor="#ffffff">
<!-- Generated by Doxygen 1.4.1 -->
<h1>qfits_table Struct Reference</h1>Table object.
<a href="#_details">More...</a>
<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">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__table.html#o0">filename</a> [FILENAMESZ]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__table.html#o1">tab_t</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__table.html#o2">tab_w</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__table.html#o3">nc</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__table.html#o4">nr</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structqfits__col.html">qfits_col</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__table.html#o5">col</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Table object.
<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 class="fragment"> <span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>* argv[])
{
<a class="code" href="structqfits__table.html">qfits_table</a> * table ;
<span class="keywordtype">int</span> n_ext ;
<span class="keywordtype">int</span> i ;
<span class="comment">// Query the number of extensions</span>
n_ext = <a class="code" href="qfits_8h.html#a87">qfits_query_n_ext</a>(argv[1]) ;
<span class="comment">// For each extension</span>
<span class="keywordflow">for</span> (i=0 ; i&lt;n_ext ; i++) {
<span class="comment">// Read all the infos about the current table </span>
table = <a class="code" href="qfits_8h.html#a109">qfits_table_open</a>(argv[1], i+1) ;
<span class="comment">// Display the current table </span>
dump_extension(table, stdout, <span class="charliteral">'|'</span>, 1, 1) ;
}
return ;
}
</pre></div>
<p>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="o5" doxytag="qfits_table::col"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="structqfits__col.html">qfits_col</a>* <a class="el" href="structqfits__table.html#o5">qfits_table::col</a> </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="structqfits__col.html">qfits_col</a> objects </td>
</tr>
</table>
<a class="anchor" name="o0" doxytag="qfits_table::filename"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">char <a class="el" href="structqfits__table.html#o0">qfits_table::filename</a>[FILENAMESZ] </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 class="anchor" name="o3" doxytag="qfits_table::nc"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="structqfits__table.html#o3">qfits_table::nc</a> </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 class="anchor" name="o4" doxytag="qfits_table::nr"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="structqfits__table.html#o4">qfits_table::nr</a> </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 class="anchor" name="o1" doxytag="qfits_table::tab_t"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="structqfits__table.html#o1">qfits_table::tab_t</a> </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 class="anchor" name="o2" doxytag="qfits_table::tab_w"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="structqfits__table.html#o2">qfits_table::tab_w</a> </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_8h.html">qfits.h</a></ul>
</body>
</html>