OpenCV
4.10.0-dev
Open Source Computer Vision
|
Template class for 2D rectangles. More...
#include <opencv2/core/types.hpp>
Public Types | |
typedef _Tp | value_type |
Public Member Functions | |
Rect_ () | |
default constructor | |
Rect_ (_Tp _x, _Tp _y, _Tp _width, _Tp _height) | |
Rect_ (const Point_< _Tp > &org, const Size_< _Tp > &sz) | |
Rect_ (const Point_< _Tp > &pt1, const Point_< _Tp > &pt2) | |
Rect_ (const Rect_ &r)=default | |
Rect_ (Rect_ &&r) CV_NOEXCEPT=default | |
_Tp | area () const |
area (width*height) of the rectangle | |
Point_< _Tp > | br () const |
the bottom-right corner | |
template<typename _Tp2 > | |
bool | contains (const Point_< _Tp2 > &pt) const |
checks whether the rectangle contains the point | |
bool | empty () const |
true if empty | |
template<typename _Tp2 > | |
operator Rect_< _Tp2 > () const | |
conversion to another data type | |
Rect_ & | operator= (const Rect_ &r)=default |
Rect_ & | operator= (Rect_ &&r) CV_NOEXCEPT=default |
Size_< _Tp > | size () const |
size (width, height) of the rectangle | |
Point_< _Tp > | tl () const |
the top-left corner | |
Public Attributes | |
_Tp | height |
height of the rectangle | |
_Tp | width |
width of the rectangle | |
_Tp | x |
x coordinate of the top-left corner | |
_Tp | y |
y coordinate of the top-left corner | |
Template class for 2D rectangles.
described by the following parameters:
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 \leq pt.x < x+width, y \leq pt.y < y+height\]
Virtually every loop over an image ROI in OpenCV (where ROI is specified by Rect_<int> ) is implemented as:
In addition to the class members, the following operations on rectangles are implemented:
This is an example how the partial ordering on rectangles can be established (rect1 \(\subseteq\) rect2):
For your convenience, the Rect_<> alias is available: cv::Rect
cv::Rect_< _Tp >::Rect_ | ( | const Point_< _Tp > & | org, |
const Size_< _Tp > & | sz ) |
cv::Rect_< _Tp >::Rect_ | ( | const Point_< _Tp > & | pt1, |
const Point_< _Tp > & | pt2 ) |
area (width*height) of the rectangle
the bottom-right corner
|
inline |
checks whether the rectangle contains the point
conversion to another data type
size (width, height) of the rectangle
the top-left corner
height of the rectangle
width of the rectangle
x coordinate of the top-left corner
y coordinate of the top-left corner