EleFits  4.0.0
A modern C++ API on top of CFitsIO
Public Member Functions | List of all members
Euclid::Fits::BintableHdu Class Reference

#include <BintableHdu.h>

Class Description

Binary table HDU reader-writer.

Examples
EleFitsTutorial.cpp.
Inheritance diagram for Euclid::Fits::BintableHdu:
[legend]

Public Member Functions

virtual ~BintableHdu ()=default
 Destructor.
 
const BintableColumnscolumns () const
 Access the data unit column-wise. More...
 
long readColumnCount () const
 Read the number of columns.
 
long readRowCount () const
 Read the number of rows.
 
HduCategory readCategory () const override
 Read the category of the HDU. More...
 
template<typename T >
VecColumn< T > readColumn (long index) const
 Read a column with given index.
 
template<typename T >
VecColumn< T > readColumn (const std::string &name) const
 Read a column with given name.
 
template<typename T >
void writeColumn (const Column< T > &column) const
 Write a column.
 
- Public Member Functions inherited from Euclid::Fits::Hdu
virtual ~Hdu ()=default
 Destructor.
 
long index () const
 Get the 0-based index of the HDU.
 
HduCategory type () const
 Get the type of the HDU. More...
 
bool matches (HduFilter filter) const
 Check whether the HDU matches a given filter. More...
 
template<typename T >
const T & as () const
 Cast to an ImageHdu or BintableHdu (if possible).
 
const Headerheader () const
 Access the header unit to read and write records. More...
 
std::string readName () const
 Read the extension name.
 
long readVersion () const
 Read the extension version.
 
void updateName (const std::string &name) const
 Write or update the extension name.
 
void updateVersion (long version) const
 Write or update the extension version.
 
void verifyChecksums () const
 Compute the HDU and data checksums and compare them to the values in the header. More...
 
void updateChecksums () const
 Compute and write (or update) the HDU and data checksums. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Euclid::Fits::Hdu
void touchThisHdu () const
 Set the current HDU to this one. More...
 
void editThisHdu () const
 Set the current HDU to this one for writing. More...
 
- Protected Attributes inherited from Euclid::Fits::Hdu
fitsfile *& m_fptr
 The parent file handler. More...
 
long m_cfitsioIndex
 The 1-based CFitsIO HDU index. More...
 
HduCategory m_type
 The HDU type.
 
Header m_header
 The header unit handler.
 
HduCategory m_status
 The HDU status. More...
 
fitsfile * m_dummyFptr = nullptr
 Dummy file handler dedicated to dummy constructor.
 

The documentation for this class was generated from the following file: