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

#include <Hdu.h>

Class Description

Base class for ImageHdu and BintableHdu.

This class provides services common to all HDUs for reading and writing records. Services exclusively applicable to MEF files (e.g. HDU name or type) are directly provided as methods, while generic services are accessed through the header() method (refer to the documentation of the Header class).

Note
Hdus are written as Image HDUs with NAXIS = 0.
Examples
EleFitsTutorial.cpp.
Inheritance diagram for Euclid::Fits::Hdu:
[legend]

Public Member Functions

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...
 
virtual HduCategory readCategory () const
 Read the category 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...
 

Protected Member Functions

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

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:
Euclid::Fits::HduCategory::Image
static const HduCategory Image
Image HDU.
Definition: HduCategory.h:213