ev::Rect3_< T > Class Template Reference

This class extends cv::Rect_<T> for event data. For more information, please refer here. More...

#include <types.hpp>

Inheritance diagram for ev::Rect3_< T >:

Public Member Functions
	Rect3_ ()
	Rect3_ (const T x, const T y, const T t, const T w, const T h, const T l)
	Rect3_ (const Rect2_< T > &rect, const T t, const T l)
	Rect3_ (const cv::Point3_< T > &pt, const Size3_< T > sz)
	Rect3_ (const cv::Point3_< T > &pt1, const cv::Point3_< T > &pt2)
bool	empty () const
	Check if empty.
template<typename Te >
bool	contains (const Event_< Te > &e) const
	Check if the rectangular cuboid contains an event.
Size3_< T >	size () const
	Size of the rectangular cuboid.
T	volume () const
	Compute the volume.

Public Attributes
T	t
T	length

Detailed Description

template<typename T>
class ev::Rect3_< T >

This class extends cv::Rect_<T> for event data. For more information, please refer here.

Analogously to OpenCV library, the following aliases are defined for convenience:

using Rect3i = Rect3_<int>;
using Rect3l = Rect3_<long>;
using Rect3f = Rect3_<float>;
using Rect3d = Rect3_<double>;
using Rect3 = Rect3i;

Constructor & Destructor Documentation

Rect3_() [1/5]

template<typename T >

ev::Rect3_< T >::Rect3_ ( )

inline

Default constructor.

Rect3_() [2/5]

template<typename T >

ev::Rect3_< T >::Rect3_ ( const T x, const T y, const T t, const T w, const T h, const T l )

inline

Contructor using x, y, t, width, height, and length.

Parameters

x	Origin spatial coordinate x
y	Origin spatial coordinate y
t	Origin temporal coordinate t
w	Width
h	Height
l	Length (time)

Rect3_() [3/5]

template<typename T >

ev::Rect3_< T >::Rect3_ ( const Rect2_< T > & rect, const T t, const T l )

inline

Contructor using rectangle, t, and length.

Parameters

rect	Spatial position as a rectangle
t	Origin temporal coordinate t
l	Length (time)

Rect3_() [4/5]

template<typename T >

ev::Rect3_< T >::Rect3_ ( const cv::Point3_< T > & pt, const Size3_< T > sz )

inline

Contructor using 3D point and 3D size.

Parameters

pt	Origin point
sz	Size

Rect3_() [5/5]

template<typename T >

ev::Rect3_< T >::Rect3_ ( const cv::Point3_< T > & pt1, const cv::Point3_< T > & pt2 )

inline

Contructor using two 3D points.

Parameters

pt1	Origin point
pt2	Farthest point

Member Function Documentation

contains()

template<typename T >

template<typename Te >

bool ev::Rect3_< T >::contains ( const Event_< Te > & e ) const

inlinenodiscard

Check if the rectangular cuboid contains an event.

Parameters

e	Event to check

Returns

True if the event is inside

Warning

OpenCV typically assumes that the top and left boundary of the rectangle are inclusive, while the right and bottom are not.

empty()

template<typename T >

bool ev::Rect3_< T >::empty ( ) const

inlinenodiscard

Check if empty.

Returns

True if empty

size()

template<typename T >

Size3_< T > ev::Rect3_< T >::size ( ) const

inlinenodiscard

Size of the rectangular cuboid.

Returns

Size

volume()

template<typename T >

T ev::Rect3_< T >::volume ( ) const

inlinenodiscard

Compute the volume.

Volume is computed as \( w \cdot h \cdot l \).

Returns

Volume

Member Data Documentation

length

template<typename T >

T ev::Rect3_< T >::length

Temporal length

t

template<typename T >

T ev::Rect3_< T >::t

Temporal origin

---

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

• modules/core/include/openev/core/types.hpp