Pixelization.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_PIXELIZATION_H_
#define LSST_SPHGEOM_PIXELIZATION_H_
 
 
#include <string>
 
#include "RangeSet.h"
 
 
namespace lsst {
namespace sphgeom {
 
class Region;
class UnitVector3d;
 
 
class Pixelization {
public:
    virtual ~Pixelization() {}
 
    virtual RangeSet universe() const = 0;
 
    virtual std::unique_ptr<Region> pixel(std::uint64_t i) const = 0;
 
    virtual std::uint64_t index(UnitVector3d const & v) const = 0;
 
    virtual std::string toString(std::uint64_t i) const = 0;
 
    RangeSet envelope(Region const & r, size_t maxRanges = 0) const {
        return _envelope(r, maxRanges);
    }
 
    RangeSet interior(Region const & r, size_t maxRanges = 0) const {
        return _interior(r, maxRanges);
    }
 
private:
    virtual RangeSet _envelope(Region const & r, size_t maxRanges) const = 0;
    virtual RangeSet _interior(Region const & r, size_t maxRanges) const = 0;
};
 
}} // namespace lsst::sphgeom
 
#endif // LSST_SPHGEOM_PIXELIZATION_H_