Utils.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/*
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * 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 LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */

/*
 * A set of classes of general utility in connection with images
 *
 * We provide representations of points, bounding boxes, circles etc.
 */
#ifndef LSST_AFW_IMAGE_UTILS_H
#define LSST_AFW_IMAGE_UTILS_H

#include <climits>
#include <list>
#include <map>
#include <string>
#include <utility>

#include "boost/format.hpp"
#include "boost/mpl/bool.hpp"
#include <memory>

#include "lsst/afw/image/lsstGil.h"
#include "lsst/daf/base.h"
#include "lsst/pex/exceptions.h"
#include "lsst/afw/fits.h"

namespace lsst {
namespace afw {
namespace image {

[[deprecated("Use `afw::fits::readMetadata` instead. To be removed after 20.0.0.")]]  // DM-22276
        inline std::shared_ptr<daf::base::PropertyList>
        readMetadata(std::string const& fileName, int hdu = fits::DEFAULT_HDU, bool strip = false) {
    return afw::fits::readMetadata(fileName, hdu, strip);
}

template <typename ImageT>
typename ImageT::SinglePixel badPixel(
        typename ImageT::Pixel bad = 0  
) {
    typedef typename ImageT::SinglePixel SinglePixelT;
    return SinglePixelT(std::numeric_limits<SinglePixelT>::has_quiet_NaN
                                ? std::numeric_limits<SinglePixelT>::quiet_NaN()
                                : bad);
}
}  // namespace image
}  // namespace afw
}  // namespace lsst

#endif