LSST Applications  21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
LSST Data Management Base Package
Public Member Functions | Public Attributes | Friends | List of all members
lsst::jointcal::Frame Class Reference

rectangle with sides parallel to axes. More...

#include <Frame.h>

Public Member Functions

 Frame ()
 Default constructor. More...
 
 Frame (double xMin, double yMin, double xMax, double yMax)
 this one is dangerous: you may swap the 2 middle arguments. More...
 
 Frame (const Point &lowerLeft, const Point &upperRight)
 typical use: Frame(Point(xmin,ymin),Point(xmax,ymax)) More...
 
double getWidth () const
 size along x axis More...
 
double getHeight () const
 size along y axis More...
 
Point getCenter () const
 Center of the frame. More...
 
Frame operator* (const Frame &right) const
 intersection of Frame's. More...
 
Frame & operator*= (const Frame &right)
 intersection of Frame's More...
 
Frame operator+ (const Frame &right) const
 union of Frames More...
 
Frame & operator+= (const Frame &right)
 union of Frames More...
 
void cutMargin (const double marginSize)
 shrinks the frame (if marginSize>0), enlarges it (if marginSize<0). More...
 
void cutMargin (const double marginX, const double marginY)
 shrinks the frame (if marginSize>0), enlarges it (if marginSize<0). More...
 
bool operator== (const Frame &right) const
 necessary for comparisons (!= is defined from this one implicitely) More...
 
bool operator!= (const Frame &right) const
 comparison More...
 
Frame rescale (const double factor) const
 rescale it. The center does not move. More...
 
double getArea () const
 
bool inFrame (double x, double y) const
 inside? More...
 
bool inFrame (const Point &point) const
 same as above More...
 
double minDistToEdges (const Point &point) const
 distance to closest boundary. More...
 
void print (std::ostream &out) const
 

Public Attributes

double xMin
 coordinate of boundary. More...
 
double xMax
 
double yMin
 
double yMax
 

Friends

std::ostream & operator<< (std::ostream &stream, const Frame &right)
 allows More...
 

Detailed Description

rectangle with sides parallel to axes.

when Frame's are used to define subparts of images, xMin and xMax refer to the first and last pixels in the subimage

Definition at line 38 of file Frame.h.

Constructor & Destructor Documentation

◆ Frame() [1/3]

lsst::jointcal::Frame::Frame ( )

Default constructor.

Definition at line 46 of file Frame.cc.

46 { xMin = xMax = yMin = yMax = 0; }
lsst::jointcal::Frame::xMin
double xMin
coordinate of boundary.
Definition: Frame.h:41

◆ Frame() [2/3]

lsst::jointcal::Frame::Frame ( double  xMin,
double  yMin,
double  xMax,
double  yMax 
)

this one is dangerous: you may swap the 2 middle arguments.

Prefer next one

Definition at line 39 of file Frame.cc.

39  {
40  xMin = min(xmin, xmax);
41  xMax = max(xmin, xmax);
42  yMin = min(ymin, ymax);
43  yMax = max(ymin, ymax);
44 }
min
int min
Definition: BoundedField.cc:103
max
int max
Definition: BoundedField.cc:104
xmax
int xmax
Definition: SpanSet.cc:49
xmin
int xmin
Definition: SpanSet.cc:49

◆ Frame() [3/3]

lsst::jointcal::Frame::Frame ( const Point &  lowerLeft,
const Point &  upperRight 
)

typical use: Frame(Point(xmin,ymin),Point(xmax,ymax))

Definition at line 35 of file Frame.cc.

35  {
36  *this = Frame(lowerLeft.x, lowerLeft.y, upperRight.x, upperRight.y);
37 }
lsst::jointcal::Frame::Frame
Frame()
Default constructor.
Definition: Frame.cc:46

Member Function Documentation

◆ cutMargin() [1/2]

void lsst::jointcal::Frame::cutMargin ( const double  marginSize)

shrinks the frame (if marginSize>0), enlarges it (if marginSize<0).

Definition at line 108 of file Frame.cc.

108 { cutMargin(marginSize, marginSize); }
lsst::jointcal::Frame::cutMargin
void cutMargin(const double marginSize)
shrinks the frame (if marginSize>0), enlarges it (if marginSize<0).
Definition: Frame.cc:108

◆ cutMargin() [2/2]

void lsst::jointcal::Frame::cutMargin ( const double  marginX,
const double  marginY 
)

shrinks the frame (if marginSize>0), enlarges it (if marginSize<0).

Definition at line 101 of file Frame.cc.

101  {
102  xMin += marginX;
103  yMin += marginY;
104  xMax -= marginX;
105  yMax -= marginY;
106 }

◆ getArea()

double lsst::jointcal::Frame::getArea ( ) const

Definition at line 118 of file Frame.cc.

118 { return fabs((xMax - xMin) * (yMax - yMin)); }
std::fabs
T fabs(T... args)

◆ getCenter()

Point lsst::jointcal::Frame::getCenter ( ) const
inline

Center of the frame.

Definition at line 60 of file Frame.h.

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

◆ getHeight()

double lsst::jointcal::Frame::getHeight ( ) const
inline

size along y axis

Definition at line 57 of file Frame.h.

57 { return yMax - yMin; }

◆ getWidth()

double lsst::jointcal::Frame::getWidth ( ) const
inline

size along x axis

Definition at line 54 of file Frame.h.

54 { return xMax - xMin; }

◆ inFrame() [1/2]

bool lsst::jointcal::Frame::inFrame ( const Point &  point) const
inline

same as above

Definition at line 96 of file Frame.h.

96 { return inFrame(point.x, point.y); }
lsst::jointcal::Frame::inFrame
bool inFrame(double x, double y) const
inside?
Definition: Frame.cc:120

◆ inFrame() [2/2]

bool lsst::jointcal::Frame::inFrame ( double  x,
double  y 
) const

inside?

Definition at line 120 of file Frame.cc.

120  {
121  return ((x <= xMax) && (y <= yMax) && (x >= xMin) && (y >= yMin));
122 }
x
double x
Definition: ChebyshevBoundedField.cc:277
y
int y
Definition: SpanSet.cc:49

◆ minDistToEdges()

double lsst::jointcal::Frame::minDistToEdges ( const Point &  point) const

distance to closest boundary.

Definition at line 49 of file Frame.cc.

49  {
50  return min(min(point.x - xMin, xMax - point.x) /* minx */,
51  min(point.y - yMin, yMax - point.y) /* miny */);
52 }

◆ operator!=()

bool lsst::jointcal::Frame::operator!= ( const Frame &  right) const
inline

comparison

Definition at line 84 of file Frame.h.

84 { return !(*this == right); }
std::right
T right(T... args)

◆ operator*()

Frame lsst::jointcal::Frame::operator* ( const Frame &  right) const

intersection of Frame's.

Definition at line 54 of file Frame.cc.

54  {
55  Frame result = *this;
56  result *= right;
57  return result;
58 }
result
py::object result
Definition: _schema.cc:430

◆ operator*=()

Frame & lsst::jointcal::Frame::operator*= ( const Frame &  right)

intersection of Frame's

Definition at line 60 of file Frame.cc.

60  {
61  Frame rightCopy = right;
62  // make sure that coordinates are properly ordered
63  order();
64  rightCopy.order();
65  xMin = max(xMin, rightCopy.xMin);
66  xMax = min(xMax, right.xMax);
67  yMin = max(yMin, right.yMin);
68  yMax = min(yMax, right.yMax);
69  // check for an actual overlap. Why was this check added?
70  if (xMin > xMax || yMin > yMax) *this = Frame();
71  return *this;
72 }

◆ operator+()

Frame lsst::jointcal::Frame::operator+ ( const Frame &  right) const

union of Frames

Definition at line 74 of file Frame.cc.

74  {
75  Frame result = *this;
76  result += right;
77  return result;
78 }

◆ operator+=()

Frame & lsst::jointcal::Frame::operator+= ( const Frame &  right)

union of Frames

Definition at line 80 of file Frame.cc.

80  {
81  Frame rightCopy = right;
82  // make sure that coordinates are properly ordered
83  order();
84  rightCopy.order();
85  xMin = min(xMin, rightCopy.xMin);
86  xMax = max(xMax, right.xMax);
87  yMin = min(yMin, right.yMin);
88  yMax = max(yMax, right.yMax);
89  return *this;
90 }

◆ operator==()

bool lsst::jointcal::Frame::operator== ( const Frame &  right) const

necessary for comparisons (!= is defined from this one implicitely)

Definition at line 97 of file Frame.cc.

97  {
98  return ((xMin == right.xMin) && (xMax == right.xMax) && (yMin == right.yMin) && (yMax == right.yMax));
99 }

◆ print()

void lsst::jointcal::Frame::print ( std::ostream &  out) const

Definition at line 124 of file Frame.cc.

124  {
125  stream << "xmin ymin " << xMin << ' ' << yMin << " xmax ymax " << xMax << ' ' << yMax << endl;
126 }
std::endl
T endl(T... args)

◆ rescale()

Frame lsst::jointcal::Frame::rescale ( const double  factor) const

rescale it. The center does not move.

Definition at line 110 of file Frame.cc.

110  {
111  double hxsize = fabs(factor * 0.5 * (xMax - xMin));
112  double xcenter = 0.5 * (xMax + xMin);
113  double hysize = fabs(factor * 0.5 * (yMax - yMin));
114  double ycenter = 0.5 * (yMax + yMin);
115  return Frame(xcenter - hxsize, ycenter - hysize, xcenter + hxsize, ycenter + hysize);
116 }

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  stream,
const Frame &  right 
)
friend

allows 

std::cout << frame;

.

Definition at line 104 of file Frame.h.

104  {
105  right.print(stream);
106  return stream;
107  };

Member Data Documentation

◆ xMax

double lsst::jointcal::Frame::xMax

Definition at line 41 of file Frame.h.

◆ xMin

double lsst::jointcal::Frame::xMin

coordinate of boundary.

Definition at line 41 of file Frame.h.

◆ yMax

double lsst::jointcal::Frame::yMax

Definition at line 41 of file Frame.h.

◆ yMin

double lsst::jointcal::Frame::yMin

Definition at line 41 of file Frame.h.

The documentation for this class was generated from the following files:
Generated on Thu Apr 1 2021 08:32:16 for LSST Applications by doxygen 1.9.1