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

#include <type.h>

Public Types
typedef T	value_type

Public Member Functions
T	area () const
	area (width_*height_) of the rectangle More...

Point< T >	br () const
	the bottom-right corner More...

bool	contains (const Point< T > &pt) const
	checks whether the rectangle contains the point More...

bool	empty () const
	true if empty More...

template<typename Tp2 >
	operator Rect< Tp2 > () const
	conversion to another data type More...

Rect &	operator= (const Rect &r)=default

Rect &	operator= (Rect &&r)=default

	Rect ()
	default constructor More...

	Rect (const Point< T > &org, const Size< T > &sz)

	Rect (const Point< T > &pt1, const Point< T > &pt2)

	Rect (const Rect &r)=default

	Rect (Rect &&r)=default

	Rect (T x, T y, T width, T height)

Size< T >	size () const
	size (width_, height_) of the rectangle More...

Point< T >	tl () const
	the top-left corner More...

Public Attributes
T	height_
	height_ of the rectangle More...

T	width_
	width_ of the rectangle More...

T	x_
	x_ coordinate of the top-left corner More...

T	y_
	y_ coordinate of the top-left corner More...

Detailed Description

template<typename T>
class nndeploy::base::Rect< T >

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_ \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:

for(int y_ = roi.y_; y_ < roi.y_ + roi.height_; y_++)
    for(int x_ = roi.x_; x_ < roi.x_ + roi.width_; x_++)
    {
        // ...
    }

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

$\texttt{rect} = \texttt{rect} \pm \texttt{point}$ (shifting a rectangle by a certain offset)
$\texttt{rect} = \texttt{rect} \pm \texttt{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 rect1 and rect2 )
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 (rect1 $\subseteq$ rect2):

template<typename T> inline bool
operator <= (const Rect<T>& r1, const Rect<T>& r2)
{
    return (r1 & r2) == r1;
}

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

Definition at line 335 of file type.h.

Member Typedef Documentation

◆ value_type

template<typename T >

typedef T nndeploy::base::Rect< T >::value_type

Definition at line 337 of file type.h.

Constructor & Destructor Documentation

◆ Rect() [1/6]

template<typename T >

nndeploy::base::Rect< T >::Rect

inline

default constructor

Definition at line 957 of file type.h.

◆ Rect() [2/6]

template<typename T >

nndeploy::base::Rect< T >::Rect	(	T	x,
		T	y,
		T	width,
		T	height
	)

inline

Definition at line 960 of file type.h.

◆ Rect() [3/6]

template<typename T >

nndeploy::base::Rect< T >::Rect ( const Rect< T > & r )

default

◆ Rect() [4/6]

template<typename T >

nndeploy::base::Rect< T >::Rect ( Rect< T > && r )

default

◆ Rect() [5/6]

template<typename T >

nndeploy::base::Rect< T >::Rect	(	const Point< T > &	org,
		const Size< T > &	sz
	)

inline

Definition at line 964 of file type.h.

◆ Rect() [6/6]

template<typename T >

nndeploy::base::Rect< T >::Rect	(	const Point< T > &	pt1,
		const Point< T > &	pt2
	)

nndeploy::base::Rect< T >::operator Rect< Tp2 >

inline

conversion to another data type

Definition at line 1003 of file type.h.

◆ operator=() [1/2]

template<typename T >

Rect& nndeploy::base::Rect< T >::operator= ( const Rect< T > & r )

◆ height_

template<typename T >

T nndeploy::base::Rect< T >::height_

height_ of the rectangle

Definition at line 371 of file type.h.

◆ width_

template<typename T >

T nndeploy::base::Rect< T >::width_

width_ of the rectangle

Definition at line 370 of file type.h.

◆ x_

template<typename T >

T nndeploy::base::Rect< T >::x_

x_ coordinate of the top-left corner

Definition at line 368 of file type.h.

◆ y_

template<typename T >

T nndeploy::base::Rect< T >::y_

y_ coordinate of the top-left corner

Definition at line 369 of file type.h.

The documentation for this class was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/nndeploy-zh/checkouts/latest/framework/include/nndeploy/base/type.h

Public Types

Public Member Functions

Public Attributes

Detailed Description

template<typename T> class nndeploy::base::Rect< T >

Member Typedef Documentation

◆ value_type

Constructor & Destructor Documentation

◆ Rect() [1/6]

◆ Rect() [2/6]

◆ Rect() [3/6]

◆ Rect() [4/6]

◆ Rect() [5/6]

◆ Rect() [6/6]

Member Function Documentation

◆ area()

◆ br()

◆ contains()

◆ empty()

◆ operator Rect< Tp2 >()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ size()

◆ tl()

Member Data Documentation

◆ height_

◆ width_

◆ x_

◆ y_

template<typename T>
class nndeploy::base::Rect< T >