Region.h

Go to the documentation of this file.

/*
 * This file is part of sphgeom.
 *
 * Developed for the LSST Data Management System.
 * This product includes software developed by the LSST Project
 * (http://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * This software is dual licensed under the GNU General Public License and also
 * under a 3-clause BSD license. Recipients may choose which of these licenses
 * to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
 * respectively.  If you choose the GPL option then the following text applies
 * (but note that there is still no warranty even if you opt for BSD instead):
 *
 * 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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef LSST_SPHGEOM_REGION_H_
#define LSST_SPHGEOM_REGION_H_

 
#include <memory>
#include <stdexcept>
#include <vector>
#include <cstdint>
#include <string>
 
#include "Relationship.h"
#include "TriState.h"
 
 
namespace lsst {
namespace sphgeom {
 
// Forward declarations
class Box;
class Box3d;
class Circle;
class ConvexPolygon;
class Ellipse;
class UnitVector3d;

class
#if defined(__GNUC__) || defined(__clang__)
__attribute__((visibility("default")))
#endif
IvoaStcsNotImplemented : public std::runtime_error {
public:
    using std::runtime_error::runtime_error;
};

class Region {
public:
    virtual ~Region() = default;

    virtual std::unique_ptr<Region> clone() const = 0;

    virtual Box getBoundingBox() const = 0;

    virtual Box3d getBoundingBox3d() const = 0;

    virtual Circle getBoundingCircle() const = 0;

    virtual bool isEmpty() const = 0;

    virtual bool contains(UnitVector3d const &) const = 0;

    bool contains(double x, double y, double z) const;

    bool contains(double lon, double lat) const;

    virtual bool contains(Region const &) const;

    virtual Relationship relate(Region const &) const = 0;
    virtual Relationship relate(Box const &) const = 0;
    virtual Relationship relate(Circle const &) const = 0;
    virtual Relationship relate(ConvexPolygon const &) const = 0;
    virtual Relationship relate(Ellipse const &) const = 0;

    virtual TriState overlaps(Region const& other) const = 0;
    virtual TriState overlaps(Box const &) const = 0;
    virtual TriState overlaps(Circle const &) const = 0;
    virtual TriState overlaps(ConvexPolygon const &) const = 0;
    virtual TriState overlaps(Ellipse const &) const = 0;

    virtual std::vector<std::uint8_t> encode() const = 0;

    static std::unique_ptr<Region> decode(std::vector<std::uint8_t> const & s) {
        return decode(s.data(), s.size());
    }
 
    static std::unique_ptr<Region> decode(std::uint8_t const * buffer, size_t n);

    static std::unique_ptr<Region> decodeBase64(std::string const & s) {
        return decodeBase64(std::string_view(s));
    }
 
    static std::unique_ptr<Region> decodeBase64(std::string_view const & s);

    static TriState decodeOverlapsBase64(std::string const & s) {
        return decodeOverlapsBase64(std::string_view(s));
    }
 
    static TriState decodeOverlapsBase64(std::string_view const & s);

    static std::vector<std::unique_ptr<Region>> getRegions(Region const &region);

    std::string toIvoaStcs(std::string const & frame = "ICRS") const {
        return toIvoaStcsBody(frame);
    }
 
protected:
 
    // Default transformation of the region Relationship as returned from
    // `relate` to TriState. Can be used when specific region class cannot
    // compute more precise overlap relation.
    static TriState _relationship_to_overlaps(Relationship r) {
        // `relate` returns exact relation when specific bit is set, if it is
        // not then relation may be true or not.
        if ((r & DISJOINT) == DISJOINT) {
            return TriState(false);
        }
        if ((r & (WITHIN | CONTAINS)).any()) {
            return TriState(true);
        }
        return TriState();
    }
 
private:
    virtual std::string toIvoaStcsBody(std::string const & frame = "") const {
        throw IvoaStcsNotImplemented(
            "This region can not be converted to an IVOA STC-S string."
        );
    }
};
 
}} // namespace lsst::sphgeom
 
#endif // LSST_SPHGEOM_REGION_H_