Polygon.h

Go to the documentation of this file.

// -*- LSST-C++ -*-

/*
 * LSST Data Management System
 * Copyright 2008-2014 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/>.
 */

#if !defined(LSST_AFW_GEOM_POLYGON_POLYGON_H)
#define LSST_AFW_GEOM_POLYGON_POLYGON_H

#include <vector>
#include <utility>  // for std::pair

#include <memory>

#include "lsst/base.h"
#include "lsst/pex/exceptions.h"
#include "lsst/geom/Box.h"
#include "lsst/geom/Point.h"
#include "lsst/geom/AffineTransform.h"
#include "lsst/afw/geom/Transform.h"
#include "lsst/afw/image/Image.h"
#include "lsst/afw/image/MaskedImage.h"
#include "lsst/afw/typehandling/Storable.h"

namespace lsst {
namespace afw {
namespace geom {
namespace polygon {

LSST_EXCEPTION_TYPE(SinglePolygonException, lsst::pex::exceptions::RuntimeError,
                    lsst::afw::geom::polygon::SinglePolygonException);


class Polygon final : public afw::table::io::PersistableFacade<Polygon>, public afw::typehandling::Storable {
public:
    typedef lsst::geom::Box2D Box;
    typedef lsst::geom::Point2D Point;

    explicit Polygon(Box const& box);

    Polygon(Polygon const&);
    Polygon(Polygon&&);
    Polygon& operator=(Polygon const&);
    Polygon& operator=(Polygon&&);

    ~Polygon() override;

    Polygon(Box const& box, TransformPoint2ToPoint2 const& transform);

    Polygon(Box const& box, lsst::geom::AffineTransform const& transform);

    explicit Polygon(std::vector<Point> const& vertices);

    void swap(Polygon& other) noexcept { std::swap(this->_impl, other._impl); }

    size_t getNumEdges() const;

    Box getBBox() const;

    Point calculateCenter() const;
    double calculateArea() const;
    double calculatePerimeter() const;

    std::vector<Point> getVertices() const;

    std::vector<Point>::const_iterator begin() const;
    std::vector<Point>::const_iterator end() const;

    std::vector<std::pair<Point, Point>> getEdges() const;

    bool operator==(Polygon const& other) const;
    bool operator!=(Polygon const& other) const { return !(*this == other); }

    std::size_t hash_value() const noexcept override;

    bool contains(Point const& point) const;

    bool overlaps(Polygon const& other) const;
    bool overlaps(Box const& box) const;

    std::shared_ptr<Polygon> intersectionSingle(Polygon const& other) const;
    std::shared_ptr<Polygon> intersectionSingle(Box const& box) const;

    std::vector<std::shared_ptr<Polygon>> intersection(Polygon const& other) const;
    std::vector<std::shared_ptr<Polygon>> intersection(Box const& box) const;

    std::shared_ptr<Polygon> unionSingle(Polygon const& other) const;
    std::shared_ptr<Polygon> unionSingle(Box const& box) const;

    std::vector<std::shared_ptr<Polygon>> union_(Polygon const& other) const;
    std::vector<std::shared_ptr<Polygon>> union_(Box const& box) const;

    std::vector<std::shared_ptr<Polygon>> symDifference(Polygon const& other) const;
    std::vector<std::shared_ptr<Polygon>> symDifference(Box const& box) const;

    std::shared_ptr<Polygon> simplify(double const distance) const;

    std::vector<std::shared_ptr<Polygon>> operator&(Polygon const& rhs) const { return intersection(rhs); }
    std::vector<std::shared_ptr<Polygon>> operator&(Box const& rhs) const { return intersection(rhs); }
    std::vector<std::shared_ptr<Polygon>> operator|(Polygon const& rhs) const { return union_(rhs); }
    std::vector<std::shared_ptr<Polygon>> operator|(Box const& rhs) const { return union_(rhs); }
    std::vector<std::shared_ptr<Polygon>> operator^(Polygon const& rhs) const { return symDifference(rhs); }
    std::vector<std::shared_ptr<Polygon>> operator^(Box const& rhs) const { return symDifference(rhs); }

    std::shared_ptr<Polygon> convexHull() const;

    std::shared_ptr<Polygon> transform(
            TransformPoint2ToPoint2 const& transform  
            ) const;
    std::shared_ptr<Polygon> transform(
            lsst::geom::AffineTransform const& transform  
            ) const;

    std::shared_ptr<Polygon> subSample(size_t num) const;
    std::shared_ptr<Polygon> subSample(double maxLength) const;

    std::shared_ptr<afw::image::Image<float>> createImage(lsst::geom::Box2I const& bbox) const;
    std::shared_ptr<afw::image::Image<float>> createImage(lsst::geom::Extent2I const& extent) const {
        return createImage(lsst::geom::Box2I(lsst::geom::Point2I(0, 0), extent));
    }

    bool isPersistable() const noexcept override { return true; }

    std::shared_ptr<typehandling::Storable> cloneStorable() const override;

    std::string toString() const override;

    bool equals(typehandling::Storable const& other) const noexcept override;

protected:
    std::string getPersistenceName() const override;

    void write(OutputArchiveHandle& handle) const override;

private:
    struct Impl;
    std::shared_ptr<Impl> _impl;
    Polygon(std::shared_ptr<Impl> impl) : _impl(impl) {}
};

std::ostream& operator<<(std::ostream& os, Polygon const& poly);
}  // namespace polygon
}  // namespace geom
}  // namespace afw
}  // namespace lsst

namespace std {
template <>
struct hash<lsst::afw::geom::polygon::Polygon> {
    using argument_type = lsst::afw::geom::polygon::Polygon;
    using result_type = size_t;
    size_t operator()(argument_type const& obj) const noexcept { return obj.hash_value(); }
};
}  // namespace std

#endif