LSST Applications g0265f82a02+093ff98f47,g02d81e74bb+3975d4ac1c,g2079a07aa2+14824f138e,g2bbee38e9b+093ff98f47,g337abbeb29+093ff98f47,g3ddfee87b4+626790451e,g3e7165581c+1687b54203,g487adcacf7+018f045a06,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g568d43a26c+02eca3db7e,g591dd9f2cf+3cba9d5141,g858d7b2824+3975d4ac1c,g8a8a8dda67+a6fc98d2e7,g8cdfe0ae6a+66d966b544,g99cad8db69+948283481e,g9ddcbc5298+d4bad12328,ga1e77700b3+246acaaf9c,ga2e4dd1c03+626790451e,ga8c6da7877+c38891e457,gae46bcf261+093ff98f47,gb0e22166c9+3863383f4c,gba4ed39666+9664299f35,gbb8dafda3b+dce3423368,gbeb006f7da+65b42827f3,gbf5cecdb8a+3975d4ac1c,gc0f3af6251+39f4c7265c,gc120e1dc64+1d31f3ee8b,gc28159a63d+093ff98f47,gcf0d15dbbd+626790451e,gd2a12a3803+bbf96b9899,gdaeeff99f8+a38ce5ea23,ge79ae78c31+093ff98f47,gee10cc3b42+a6fc98d2e7,gf1cff7945b+3975d4ac1c,v24.1.5.rc1
LSST Data Management Base Package
Loading...
Searching...
No Matches
Frame.h
Go to the documentation of this file.
1// -*- LSST-C++ -*-
2/*
3 * This file is part of jointcal.
4 *
5 * Developed for the LSST Data Management System.
6 * This product includes software developed by the LSST Project
7 * (https://www.lsst.org).
8 * See the COPYRIGHT file at the top-level directory of this distribution
9 * for details of code ownership.
10 *
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <https://www.gnu.org/licenses/>.
23 */
24
25#ifndef LSST_JOINTCAL_FRAME_H
26#define LSST_JOINTCAL_FRAME_H
27
28#include <iostream>
29#include "lsst/jointcal/Point.h"
30
31namespace lsst {
32namespace jointcal {
33
35
38class Frame {
39public:
41 double xMin{}, xMax{}, yMin{}, yMax{};
42
44 Frame();
45
48 Frame(double xMin, double yMin, double xMax, double yMax);
49
51 Frame(const Point &lowerLeft, const Point &upperRight);
52
54 double getWidth() const { return xMax - xMin; }
55
57 double getHeight() const { return yMax - yMin; }
58
60 Point getCenter() const { return Point((xMax + xMin) * 0.5, (yMax + yMin) * 0.5); }
61
63 Frame operator*(const Frame &right) const; /* intersection : a = b n c */
64
66 Frame &operator*=(const Frame &right); /* intersection : a = a n b */
67
69 Frame operator+(const Frame &right) const; /* union : a = b u c */
70
72 Frame &operator+=(const Frame &right); /* intersection : a = a u b */
73
75 void cutMargin(double marginSize);
76
78 void cutMargin(double marginX, double marginY);
79
81 bool operator==(const Frame &right) const;
82
84 bool operator!=(const Frame &right) const { return !(*this == right); }
85
87 Frame rescale(double factor) const;
88
89 // the area.
90 double getArea() const;
91
93 bool inFrame(double x, double y) const;
94
96 bool inFrame(const Point &point) const { return inFrame(point.x, point.y); }
97
99 double minDistToEdges(const Point &point) const;
100
101 void print(std::ostream &out) const;
102
104 friend std::ostream &operator<<(std::ostream &stream, const Frame &right) {
105 right.print(stream);
106 return stream;
107 };
108
109private:
110 void order();
111};
112} // namespace jointcal
113} // namespace lsst
114
115#endif // LSST_JOINTCAL_FRAME_H
int y
Definition SpanSet.cc:48
rectangle with sides parallel to axes.
Definition Frame.h:38
Point getCenter() const
Center of the frame.
Definition Frame.h:60
double getHeight() const
size along y axis
Definition Frame.h:57
friend std::ostream & operator<<(std::ostream &stream, const Frame &right)
allows
Definition Frame.h:104
void print(std::ostream &out) const
Definition Frame.cc:124
void cutMargin(double marginSize)
shrinks the frame (if marginSize>0), enlarges it (if marginSize<0).
Definition Frame.cc:108
bool inFrame(double x, double y) const
inside?
Definition Frame.cc:120
Frame operator*(const Frame &right) const
intersection of Frame's.
Definition Frame.cc:54
double minDistToEdges(const Point &point) const
distance to closest boundary.
Definition Frame.cc:49
double xMin
coordinate of boundary.
Definition Frame.h:41
Frame()
Default constructor.
Definition Frame.cc:46
bool operator==(const Frame &right) const
necessary for comparisons (!= is defined from this one implicitely)
Definition Frame.cc:97
Frame rescale(double factor) const
rescale it. The center does not move.
Definition Frame.cc:110
bool operator!=(const Frame &right) const
comparison
Definition Frame.h:84
double getArea() const
Definition Frame.cc:118
Frame & operator*=(const Frame &right)
intersection of Frame's
Definition Frame.cc:60
Frame & operator+=(const Frame &right)
union of Frames
Definition Frame.cc:80
double getWidth() const
size along x axis
Definition Frame.h:54
Frame operator+(const Frame &right) const
union of Frames
Definition Frame.cc:74
bool inFrame(const Point &point) const
same as above
Definition Frame.h:96
A point in a plane.
Definition Point.h:37
double x
coordinate
Definition Point.h:42
T right(T... args)