FitsSchemaInputMapper.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
#ifndef AFW_TABLE_IO_FitsSchemaInputMapper_h_INCLUDED
#define AFW_TABLE_IO_FitsSchemaInputMapper_h_INCLUDED

#include "lsst/afw/fits.h"
#include "lsst/afw/table/Schema.h"
#include "lsst/afw/table/io/InputArchive.h"
#include "lsst/afw/table/BaseRecord.h"

namespace lsst { namespace afw { namespace table { namespace io {

class FitsColumnReader {
public:

    FitsColumnReader() {}

    // Neither copyable nor moveable.
    FitsColumnReader(FitsColumnReader const &) = delete;
    FitsColumnReader(FitsColumnReader &&) = delete;
    FitsColumnReader & operator=(FitsColumnReader const &) = delete;
    FitsColumnReader & operator=(FitsColumnReader &&) = delete;

    virtual void readCell(
        BaseRecord & record,
        std::size_t row,
        fits::Fits & fits,
        PTR(InputArchive) const & archive
    ) const = 0;

    virtual ~FitsColumnReader() {}

};

struct FitsSchemaItem {
    int column;          // column number (0-indexed); -1 for Flag fields
    int bit;             // flag bit number (0-indexed); -1 for non-Flag fields
    std::string ttype;   // name of the field (from TTYPE keys)
    std::string tform;   // FITS column format code (from TFORM keys)
    std::string tccls;   // which field class to use (from our own TCCLS keys)
    std::string tunit;   // field units (from TUNIT keys)
    std::string doc;     // field docs (from comments on TTYPE keys)

    explicit FitsSchemaItem(int column_, int bit_) : column(column_), bit(bit_) {}
};


class FitsSchemaInputMapper {
public:

    typedef FitsSchemaItem Item;

    FitsSchemaInputMapper(daf::base::PropertyList & metadata, bool stripMetadata);

    void setArchive(PTR(InputArchive) archive);

    bool readArchive(afw::fits::Fits & fits);

    bool hasArchive() const;

    Item const * find(std::string const & ttype) const;

    Item const * find(int column) const;

    void erase(Item const * item);

    void erase(std::string const & ttype);

    void erase(int column);

    void customize(std::unique_ptr<FitsColumnReader> reader);

    Schema finalize();

    void readRecord(
        BaseRecord & record,
        afw::fits::Fits & fits,
        std::size_t row
    );

private:
    class Impl;
    PTR(Impl) _impl;
};

}}}} // namespace lsst::afw::table::io

#endif // !AFW_TABLE_IO_FitsSchemaInputMapper_h_INCLUDED