Frame.h

Go to the documentation of this file.

// -*- LSST-C++ -*-
#ifndef LSST_JOINTCAL_FRAME_H
#define LSST_JOINTCAL_FRAME_H

#include <iostream>
#include "lsst/jointcal/Point.h"

namespace lsst {
namespace jointcal {

typedef enum { WholeSizeFrame, ClippedSizeFrame } WhichFrame;

typedef enum { LargeFrame, SmallFrame } WhichTransformed;


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(const double marginSize);

    void cutMargin(const double marginX, const double marginY);

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

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

    Frame rescale(const 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 dump(std::ostream &stream = std::cout) const;

    friend std::ostream &operator<<(std::ostream &stream, const Frame &right) {
        right.dump(stream);
        return stream;
    };

private:
    void order();
};
}  // namespace jointcal
}  // namespace lsst

#endif  // LSST_JOINTCAL_FRAME_H