384 lines
13 KiB
HTML
384 lines
13 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_col Struct Reference</h1>Column 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">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__col.html#o0">atom_nb</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__col.html#o1">atom_dec_nb</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__col.html#o2">atom_size</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="qfits_8h.html#a4">tfits_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__col.html#o3">atom_type</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__col.html#o4">tlabel</a> [FITSVALSZ]</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__col.html#o5">tunit</a> [FITSVALSZ]</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__col.html#o6">nullval</a> [FITSVALSZ]</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__col.html#o7">tdisp</a> [FITSVALSZ]</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__col.html#o8">zero_present</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__col.html#o9">zero</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__col.html#o10">scale_present</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__col.html#o11">scale</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__col.html#o12">off_beg</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structqfits__col.html#o13">readable</a></td></tr>
|
|
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
Column object.
|
|
<p>
|
|
This structure contains all information needed to read a column in a table. These informations come from the header. The <a class="el" href="structqfits__table.html">qfits_table</a> object contains a list of qfits_col objects.<p>
|
|
This structure has to be created from scratch and filled if one want to generate a FITS table.
|
|
<p>
|
|
<hr><h2>Field Documentation</h2>
|
|
<a class="anchor" name="o1" doxytag="qfits_col::atom_dec_nb"></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__col.html#o1">qfits_col::atom_dec_nb</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Number of decimals in a ASCII field. This value is always 0 for BIN tables </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="o0" doxytag="qfits_col::atom_nb"></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__col.html#o0">qfits_col::atom_nb</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Number of atoms in one field. In ASCII tables, it is the number of characters in the field as defined in TFORM%d keyword. In BIN tables, it is the number of atoms in each field. For type 'A', it is the number of characters. A field with two complex object will have atom_nb = 4. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="o2" doxytag="qfits_col::atom_size"></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__col.html#o2">qfits_col::atom_size</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Size of one element in bytes. In ASCII tables, atom_size is the size of the element once it has been converted in its 'destination' type. For example, if "123" is contained in an ASCII table in a column defined as I type, atom_nb=3, atom_size=4. In ASCII tables:<ul>
|
|
<li>type 'A' : atom_size = atom_nb = number of chars</li><li>type 'I', 'F' or 'E' : atom_size = 4</li><li>type 'D' : atom_size = 8 In BIN tables :</li><li>type 'A', 'L', 'X', 'B': atom_size = 1</li><li>type 'I' : atom_size = 2</li><li>type 'E', 'J', 'C', 'P' : atom_size = 4</li><li>type 'D', 'M' : atom_size = 8 In ASCII table, there is one element per field. The size in bytes and in number of characters is atom_nb, and the size in bytes after conversion of the field is atom_size. In BIN tables, the size in bytes of a field is always atom_nb*atom_size.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="o3" doxytag="qfits_col::atom_type"></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="qfits_8h.html#a4">tfits_type</a> <a class="el" href="structqfits__col.html#o3">qfits_col::atom_type</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Type of data in the column as specified in TFORM keyword In ASCII tables : TFITS_ASCII_TYPE_* with *=A, I, F, E or D In BIN tables : TFITS_BIN_TYPE_* with *=L, X, B, I, J, A, E, D, C, M or P </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="o6" doxytag="qfits_col::nullval"></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__col.html#o6">qfits_col::nullval</a>[FITSVALSZ] </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Null value </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="o12" doxytag="qfits_col::off_beg"></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__col.html#o12">qfits_col::off_beg</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Offset between the beg. of the table and the beg. of the column. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="o13" doxytag="qfits_col::readable"></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__col.html#o13">qfits_col::readable</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Flag to know if the column is readable. An empty col is not readable </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="o11" doxytag="qfits_col::scale"></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">float <a class="el" href="structqfits__col.html#o11">qfits_col::scale</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="o10" doxytag="qfits_col::scale_present"></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__col.html#o10">qfits_col::scale_present</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="o7" doxytag="qfits_col::tdisp"></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__col.html#o7">qfits_col::tdisp</a>[FITSVALSZ] </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Display format </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="o4" doxytag="qfits_col::tlabel"></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__col.html#o4">qfits_col::tlabel</a>[FITSVALSZ] </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Label of the column </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="o5" doxytag="qfits_col::tunit"></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__col.html#o5">qfits_col::tunit</a>[FITSVALSZ] </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Unit of the data </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="o9" doxytag="qfits_col::zero"></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">float <a class="el" href="structqfits__col.html#o9">qfits_col::zero</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="o8" doxytag="qfits_col::zero_present"></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__col.html#o8">qfits_col::zero_present</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
zero and scale are used when the quantity in the field does not represent a true physical quantity. Basically, thez should be used when they are present: physical_value = zero + scale * field_value They are read from TZERO and TSCAL in the header </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>
|