cfitsio.hpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup daq_ocm_libfits
 * @copyright 2021 ESO - European Southern Observatory
 *
 * @brief Contains functions and data structures related to cfitsio.
 */
#ifndef DAQ_OCM_DAQ_FITS_CFITSIO_HPP_
#define DAQ_OCM_DAQ_FITS_CFITSIO_HPP_
#include <cfitsio/fitsio.h>
#include <memory>
 
namespace daq::fits {
 
/**
 * Represents errors from cfitsio.
 *
 * @ingroup daq_ocm_libfits
 */
class CfitsioError : public std::runtime_error {
public:
    CfitsioError(int status, char const* message);
    CfitsioError(int status, std::string const& message);
 
    /**
     * @return cfitsio status code causing the exception.
     */
    int GetStatus() const noexcept;
 
private:
    int m_status;
};
 
/**
 * Default close function that is used by UniqueFitsFile as a deleter.
 *
 * @ingroup daq_ocm_libfits
 */
void DefaultClose(fitsfile* ptr) noexcept;
 
/**
 * Defines unique ownership type to cfitsio fitsfile.
 *
 * @ingroup daq_ocm_libfits
 */
using UniqueFitsFile = std::unique_ptr<fitsfile, void (*)(fitsfile*) noexcept>;
 
/**
 * Creates empty FITS file using @c fits_create_file and returns a pointer with a deleter that will
 * close the file.
 *
 * @ingroup daq_ocm_libfits
 */
UniqueFitsFile CreateEmpty(char const* filename);
 
/**
 * Initializes an empty FITS file with a primary HDU
 *
 * Mandatory keywords are set and primary HDU added if necessary.
 *
 * Mandatory keywords are initialized as:
 * - SIMPLE = T
 * - BITPIX = 8
 * - NAXIS = 0
 *
 * @pre ptr != nullptr
 *
 * @param ptr Valid FITS file.
 * @throw CfitsioError on error.
 */
void InitPrimaryHduNoImage(fitsfile* ptr);
 
}  // namespace daq::fits
 
#endif  // #define DAQ_OCM_DAQ_FITS_CFITSIO_HPP_