PixelAreaBoundedField.h

Go to the documentation of this file.

// -*- LSST-C++ -*-
/*
 * This file is part of afw.
 *
 * 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_MATH_PixelAreaBoundedField_h_INCLUDED
#define LSST_AFW_MATH_PixelAreaBoundedField_h_INCLUDED
 
 
#include "lsst/geom/Angle.h"
#include "lsst/afw/geom/SkyWcs.h"
#include "lsst/afw/math/BoundedField.h"
#include "lsst/pex/exceptions.h"
 
namespace lsst {
namespace afw {
namespace math {

class PixelAreaBoundedField : public BoundedField {
public:

    PixelAreaBoundedField(
        lsst::geom::Box2I const &bbox,
        std::shared_ptr<geom::SkyWcs const> skyWcs,
        lsst::geom::AngleUnit const & unit = lsst::geom::radians,
        double scaling = 1.0
    );
 
    ~PixelAreaBoundedField() override = default;
 
    PixelAreaBoundedField(PixelAreaBoundedField const &) = default;
    PixelAreaBoundedField(PixelAreaBoundedField &&) = default;
    PixelAreaBoundedField &operator=(PixelAreaBoundedField const &) = delete;
    PixelAreaBoundedField &operator=(PixelAreaBoundedField &&) = delete;

    double evaluate(lsst::geom::Point2D const &position) const override;

    ndarray::Array<double, 1, 1> evaluate(ndarray::Array<double const, 1> const & x,
                                          ndarray::Array<double const, 1> const & y) const override;

    bool isPersistable() const noexcept override;

    std::shared_ptr<BoundedField> operator*(double const scale) const override;

    bool operator==(BoundedField const &rhs) const override;

    std::shared_ptr<geom::SkyWcs const> getSkyWcs() const { return _skyWcs; }

    double getScaling() const { return _scaling; }
 
 
protected:
 
    std::string getPersistenceName() const override;
    std::string getPythonModule() const override;
    void write(OutputArchiveHandle &handle) const override;
 
private:
 
    std::string toString() const override;
 
    std::shared_ptr<geom::SkyWcs const> _skyWcs;
    double _scaling;
};
 
}  // namespace math
}  // namespace afw
}  // namespace lsst
 
#endif  // !LSST_AFW_MATH_PixelAreaBoundedField_h_INCLUDED