ImageBaseFitsReader.h

Go to the documentation of this file.

/*
 * Developed for the LSST Data Management System.
 * This product includes software developed by the LSST Project
 * (https://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef LSST_AFW_IMAGE_IMAGEBASEFITSREADER_H
#define LSST_AFW_IMAGE_IMAGEBASEFITSREADER_H
 
#include <string>
#include <memory>
 
#include "lsst/geom/Box.h"
#include "lsst/daf/base/PropertyList.h"
#include "lsst/afw/fits.h"
 
namespace lsst { namespace afw { namespace image {

class ImageBaseFitsReader {
public:

    explicit ImageBaseFitsReader(std::string const& fileName, int hdu=fits::DEFAULT_HDU);

    explicit ImageBaseFitsReader(fits::MemFileManager& manager, int hdu=fits::DEFAULT_HDU);

    explicit ImageBaseFitsReader(fits::Fits * fitsFile);
 
    // FITS readers are not copyable, movable, or assignable.
    ImageBaseFitsReader(ImageBaseFitsReader const &) = delete;
    ImageBaseFitsReader(ImageBaseFitsReader &&) = delete;
    ImageBaseFitsReader & operator=(ImageBaseFitsReader const &) = delete;
    ImageBaseFitsReader & operator=(ImageBaseFitsReader &&) = delete;

    std::string readDType() const;

    lsst::geom::Box2I readBBox(ImageOrigin origin=PARENT);

    lsst::geom::Point2I readXY0(
        lsst::geom::Box2I const & bbox=lsst::geom::Box2I(),
        ImageOrigin origin=PARENT
    );

    std::shared_ptr<daf::base::PropertyList> readMetadata();

    template <typename T>
    ndarray::Array<T, 2, 2> readArray(
        lsst::geom::Box2I const & bbox,
        ImageOrigin origin=PARENT,
        bool allowUnsafe=false
    );

    int getHdu() const noexcept { return _hdu; }

    std::string getFileName() const { return _fitsFile->getFileName(); }
 
protected:
 
    // This class should never be directly instantiated, and should never
    // be deleted through a base-class pointer.
    ~ImageBaseFitsReader() noexcept;
 
private:
 
    friend class MaskedImageFitsReader;
 
    bool _ownsFitsFile;
    int _hdu;
    fits::Fits * _fitsFile;
    lsst::geom::Box2I _bbox;
    std::shared_ptr<daf::base::PropertyList> _metadata;
};
 
}}} // namespace lsst::afw::image
 
#endif // !LSST_AFW_IMAGE_IMAGEBASEFITSREADER_H