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	dump (std::ostream &stream=std::cout) 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.

{ xMin = xMax = yMin = yMax = 0; }

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.

                                                               {
    xMin = min(xmin, xmax);
    xMax = max(xmin, xmax);
    yMin = min(ymin, ymax);
    yMax = max(ymin, ymax);
}

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.

                                                            {
    *this = Frame(lowerLeft.x, lowerLeft.y, upperRight.x, upperRight.y);
}

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.

{ cutMargin(marginSize, marginSize); }

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.

                                                                {
    xMin += marginX;
    yMin += marginY;
    xMax -= marginX;
    yMax -= marginY;
}

dump()

void lsst::jointcal::Frame::dump

(

std::ostream &

stream = std::cout

)

const

Definition at line 124 of file Frame.cc.

                                      {
    stream << "xmin ymin " << xMin << ' ' << yMin << " xmax ymax " << xMax << ' ' << yMax << endl;
}

getArea()

double lsst::jointcal::Frame::getArea

(

)

const

Definition at line 118 of file Frame.cc.

{ return fabs((xMax - xMin) * (yMax - yMin)); }

getCenter()

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

inline

Center of the frame.

Definition at line 60 of file Frame.h.

{ 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.

{ return yMax - yMin; }

getWidth()

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

inline

size along x axis

Definition at line 54 of file Frame.h.

{ return xMax - xMin; }

inFrame() [1/2]

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

inside?

Definition at line 120 of file Frame.cc.

                                            {
    return ((x <= xMax) && (y <= yMax) && (x >= xMin) && (y >= yMin));
}

inFrame() [2/2]

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

inline

same as above

Definition at line 96 of file Frame.h.

{ return inFrame(point.x, point.y); }

minDistToEdges()

double lsst::jointcal::Frame::minDistToEdges

(

const Point &

point

)

const

distance to closest boundary.

Definition at line 49 of file Frame.cc.

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

operator!=()

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

inline

comparison

Definition at line 84 of file Frame.h.

{ return !(*this == right); }

operator*()

Frame lsst::jointcal::Frame::operator*

(

const Frame &

right

)

const

intersection of Frame's.

Definition at line 54 of file Frame.cc.

                                               {
    Frame result = *this;
    result *= right;
    return result;
}

operator*=()

Frame & lsst::jointcal::Frame::operator*=

(

const Frame &

right

)

intersection of Frame's

Definition at line 60 of file Frame.cc.

                                           {
    Frame rightCopy = right;
    // make sure that coordinates are properly ordered
    order();
    rightCopy.order();
    xMin = max(xMin, rightCopy.xMin);
    xMax = min(xMax, right.xMax);
    yMin = max(yMin, right.yMin);
    yMax = min(yMax, right.yMax);
    // check for an actual overlap. Why was this check added?
    if (xMin > xMax || yMin > yMax) *this = Frame();
    return *this;
}

operator+()

Frame lsst::jointcal::Frame::operator+

(

const Frame &

right

)

const

union of Frames

Definition at line 74 of file Frame.cc.

                                               {
    Frame result = *this;
    result += right;
    return result;
}

operator+=()

Frame & lsst::jointcal::Frame::operator+=

(

const Frame &

right

)

union of Frames

Definition at line 80 of file Frame.cc.

                                           {
    Frame rightCopy = right;
    // make sure that coordinates are properly ordered
    order();
    rightCopy.order();
    xMin = min(xMin, rightCopy.xMin);
    xMax = max(xMax, right.xMax);
    yMin = min(yMin, right.yMin);
    yMax = max(yMax, right.yMax);
    return *this;
}

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.

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

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.

                                              {
    double hxsize = fabs(factor * 0.5 * (xMax - xMin));
    double xcenter = 0.5 * (xMax + xMin);
    double hysize = fabs(factor * 0.5 * (yMax - yMin));
    double ycenter = 0.5 * (yMax + yMin);
    return Frame(xcenter - hxsize, ycenter - hysize, xcenter + hxsize, ycenter + hysize);
}

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.

                                                                          {
        right.dump(stream);
        return stream;
    };

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:

• /j/snowflake/release/lsstsw/stack/Linux64/jointcal/18.1.0-3-gfcaddf3+6/include/lsst/jointcal/Frame.h
• /j/snowflake/release/lsstsw/stack/Linux64/jointcal/18.1.0-3-gfcaddf3+6/src/Frame.cc