org.opencv.core

Class Rect

java.lang.Object

org.opencv.core.Rect

public class Rect
extends Object

template class CV_EXPORTS Rect_

// C++ code:

public:

typedef _Tp value_type;

//! various constructors

Rect_();

Rect_(_Tp _x, _Tp _y, _Tp _width, _Tp _height);

Rect_(const Rect_& r);

Rect_(const CvRect& r);

Rect_(const Point_<_Tp>& org, const Size_<_Tp>& sz);

Rect_(const Point_<_Tp>& pt1, const Point_<_Tp>& pt2);

Rect_& operator = (const Rect_& r);

//! the top-left corner

Point_<_Tp> tl() const;

//! the bottom-right corner

Point_<_Tp> br() const;

//! size (width, height) of the rectangle

Size_<_Tp> size() const;

//! area (width*height) of the rectangle

_Tp area() const;

//! conversion to another data type

template operator Rect_<_Tp2>() const;

//! conversion to the old-style CvRect

operator CvRect() const;

//! checks whether the rectangle contains the point

bool contains(const Point_<_Tp>& pt) const;

_Tp x, y, width, height; //< the top-left corner, as well as width and height of the rectangle

};

Template class for 2D rectangles, described by the following parameters:

• Coordinates of the top-left corner. This is a default interpretation of Rect_.x and Rect_.y in OpenCV. Though, in your algorithms you may count x and y from the bottom-left corner.
• Rectangle width and height.

OpenCV typically assumes that the top and left boundary of the rectangle are inclusive, while the right and bottom boundaries are not. For example, the method Rect_.contains returns true if

x <= pt.x < x+width,<BR>y <= pt.y < y+height

Virtually every loop over an imageROI in OpenCV (where ROI is specified by Rect_) is implemented as:

// C++ code:

for(int y = roi.y; y < roi.y + rect.height; y++)

for(int x = roi.x; x < roi.x + rect.width; x++)

//...

In addition to the class members, the following operations on rectangles are implemented:

• rect = rect +- point (shifting a rectangle by a certain offset)
• rect = rect +- size (expanding or shrinking a rectangle by a certain amount)
• rect += point, rect -= point, rect += size, rect -= size (augmenting operations)
• rect = rect1 & rect2 (rectangle intersection)
• rect = rect1 | rect2 (minimum area rectangle containing rect2 and rect3)
• rect &= rect1, rect |= rect1 (and the corresponding augmenting operations)
• rect == rect1, rect != rect1 (rectangle comparison)

This is an example how the partial ordering on rectangles can be established (rect1subseteq rect2):

// C++ code:

template inline bool

operator <= (const Rect_<_Tp>& r1, const Rect_<_Tp>& r2)

return (r1 & r2) == r1;

For your convenience, the Rect_<> alias is available:

typedef Rect_ Rect;

See Also:

org.opencv.core.Rect_

Field Summary

Fields

Modifier and Type	Field and Description
int	height
int	width
int	x
int	y

Constructor Summary

Constructors

Constructor and Description
Rect()
Rect(double[] vals)
Rect(int x, int y, int width, int height)
Rect(Point p1, Point p2)
Rect(Point p, Size s)

Method Summary

Modifier and Type	Method and Description
double	area()
Point	br()
Rect	clone()
boolean	contains(Point p)
boolean	equals(Object obj)
int	hashCode()
void	set(double[] vals)
Size	size()
Point	tl()
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

x

public int x

y

public int y

width

public int width

height

public int height

Constructor Detail

Rect

public Rect(int x,
            int y,
            int width,
            int height)

Rect

public Rect()

Rect

public Rect(Point p1,
            Point p2)

Rect

public Rect(Point p,
            Size s)

Rect

public Rect(double[] vals)

Method Detail

set

public void set(double[] vals)

clone

public Rect clone()

Overrides:

clone in class Object

tl

public Point tl()

br

public Point br()

size

public Size size()

area

public double area()

contains

public boolean contains(Point p)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object