fitsDataRecorder.hpp

Go to the documentation of this file.

#ifndef RTCTK_COMPONENTFRAMEWORK_FITSDATARECORDER_HPP
#define RTCTK_COMPONENTFRAMEWORK_FITSDATARECORDER_HPP
 
#include <rtctk/componentFramework/dataRecorder.hpp>
#include <rtctk/componentFramework/exceptions.hpp>
 
#include <filesystem>
#include <fitsio2.h>
#include <functional>
#include <gsl/span>
#include <map>
#include <memory>
#include <string_view>
 
namespace rtctk::componentFramework {
 
class FitsDataRecorderFitsError : public RtctkException {
public:
    using RtctkException::RtctkException;
    explicit FitsDataRecorderFitsError(const std::string& error)
        : RtctkException("FITS error: " + error) {
    }
};
 
struct FitsColumn {
    std::string_view name;
    std::string_view unit;
 
    constexpr FitsColumn(std::string_view new_name, std::string_view new_unit)
        : name(new_name), unit(new_unit) {
    }
};

template <class... T>
class FitsRecorder : public DataRecorder<T...> {
public:
    using typename DataRecorder<T...>::ColumnDescription;

    explicit FitsRecorder(const ColumnDescription& columns,
                          const std::array<bool, sizeof...(T)>& disable = {},
                          const std::string& extension_name = "recording");
    ~FitsRecorder() override = default;
    void Open(const std::filesystem::path& file) override;
    void Write(const std::tuple<T...>& data) override;
    void Close() override;
    void SetColumnLength(size_t column, size_t length);
    void SetColumnLength(const std::tuple<T...>& data);
 
    std::string DefaultFileExtension() override {
        return std::string{".fits"};
    }
 
private:
    static void CloseFits(fitsfile* pointer);
    std::unique_ptr<fitsfile, decltype(&CloseFits)> m_fits_handle;
    std::string m_extension_name;
    long int m_row_index{0};
    std::array<std::optional<size_t>, sizeof...(T)> m_column_length;
};
 
}  // namespace rtctk::componentFramework
 
#include <rtctk/componentFramework/fitsDataRecorder.ipp>
 
#endif  // RTCTK_COMPONENTFRAMEWORK_FITSDATARECORDER_HPP