Frame.h

Go to the documentation of this file.

// -*- LSST-C++ -*-
/*
 * This file is part of jointcal.
 *
 * 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_JOINTCAL_FRAME_H
#define LSST_JOINTCAL_FRAME_H
 
#include <iostream>
#include "lsst/jointcal/Point.h"
 
namespace lsst {
namespace jointcal {


 
class Frame {
public:
    double xMin{}, xMax{}, yMin{}, yMax{};

    Frame();

    Frame(double xMin, double yMin, double xMax, double yMax);

    Frame(const Point &lowerLeft, const Point &upperRight);

    double getWidth() const { return xMax - xMin; }

    double getHeight() const { return yMax - yMin; }

    Point getCenter() const { return Point((xMax + xMin) * 0.5, (yMax + yMin) * 0.5); }

    Frame operator*(const Frame &right) const; /* intersection : a = b n c */

    Frame &operator*=(const Frame &right); /* intersection : a = a n b */

    Frame operator+(const Frame &right) const; /* union : a = b u c */

    Frame &operator+=(const Frame &right); /* intersection : a = a u b */

    void cutMargin(double marginSize);

    void cutMargin(double marginX, double marginY);

    bool operator==(const Frame &right) const;

    bool operator!=(const Frame &right) const { return !(*this == right); }

    Frame rescale(double factor) const;
 
    // the area.
    double getArea() const;

    bool inFrame(double x, double y) const;

    bool inFrame(const Point &point) const { return inFrame(point.x, point.y); }

    double minDistToEdges(const Point &point) const;
 
    void print(std::ostream &out) const;

    friend std::ostream &operator<<(std::ostream &stream, const Frame &right) {
        right.print(stream);
        return stream;
    };
 
private:
    void order();
};
}  // namespace jointcal
}  // namespace lsst
 
#endif  // LSST_JOINTCAL_FRAME_H