FitsReader.h

Go to the documentation of this file.

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

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

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

class FitsReader : public Reader {
public:

    typedef afw::fits::Fits Fits;
    
    class Factory {
    public:

        virtual PTR(FitsReader) operator()(Fits * fits, PTR(InputArchive) archive, int flags) const = 0;

        virtual ~Factory() {}

        explicit Factory(std::string const & name);

    };

    template <typename ReaderT>
    class FactoryT : public Factory {
    public:

        virtual PTR(FitsReader) operator()(Fits * fits, PTR(InputArchive) archive, int flags) const {
            return boost::make_shared<ReaderT>(fits, archive, flags);
        }

        explicit FactoryT(std::string const & name) : Factory(name) {}

    };

    static PTR(FitsReader) make(Fits * fits, PTR(io::InputArchive) archive, int flags);

    template <typename ContainerT, typename SourceT>
    static ContainerT apply(SourceT & source, int hdu, int flags) {
        Fits fits(source, "r", Fits::AUTO_CLOSE | Fits::AUTO_CHECK);
        fits.setHdu(hdu);
        return apply<ContainerT>(fits, flags);
    }

    template <typename ContainerT>
    static ContainerT apply(Fits & fits, PTR(io::InputArchive) archive=PTR(io::InputArchive)(), int flags=0) {
        PTR(FitsReader) reader = make(&fits, archive, flags);
        return reader->template read<ContainerT>();
    }

    template <typename ContainerT>
    static ContainerT apply(Fits & fits, int flags=0) {
        PTR(FitsReader) reader = make(&fits, PTR(io::InputArchive)(), flags);
        return reader->template read<ContainerT>();
    }

    explicit FitsReader(Fits * fits, PTR(InputArchive), int flags) : _fits(fits), _flags(flags) {}

protected:

    virtual PTR(BaseTable) _readTable();

    virtual PTR(BaseRecord) _readRecord(PTR(BaseTable) const & table);

    void _startRecords(BaseTable & table);

    struct ProcessRecords;

    Fits * _fits;         // cfitsio pointer in a conveniencer wrapper
    int _flags;           // subclass-defined flags to control FITS reading
    std::size_t _row;     // which row we're currently reading
private:

    friend class afw::table::Schema;

    // Implementation for Schema's constructors that take PropertyLists;
    // it's here to keep FITS-related code a little more centralized.
    static void _readSchema(
        Schema & schema,
        daf::base::PropertyList & metadata,
        bool stripMetadata
    );

    std::size_t _nRows;   // how many total records there are in the FITS table
    boost::shared_ptr<ProcessRecords> _processor; // a private Schema::forEach functor that reads records
};

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

#endif // !AFW_TABLE_IO_FitsReader_h_INCLUDED