Detailed Description

Definition at line 46 of file CDetectableObject.h.

#include <mrpt/detectors/CDetectableObject.h>

Inheritance diagram for mrpt::detectors::CDetectable2D:

Public Member Functions
void *	operator new (size_t size)

void *	operator new[] (size_t size)

void	operator delete (void *ptr) noexcept

void	operator delete[] (void *ptr) noexcept

void	operator delete (void memory, void ptr) noexcept

void *	operator new (size_t size, const std::nothrow_t &) noexcept

void	operator delete (void *ptr, const std::nothrow_t &) noexcept

	CDetectable2D (const int &x=0, const int &y=0, const int &height=0, const int &width=0)
	Extra constructor. More...

	CDetectable2D (const CDetectable2D *d)
	Copy pointer content constructor. More...

double	distanceTo (const CDetectable2D &d2)
	Compute distance between centers of two detectable 2D objects. More...

void	setObservation (mrpt::obs::CObservation::Ptr newObs)

virtual mxArray *	writeToMatlab () const
	Introduces a pure virtual method responsible for writing to a `mxArray` Matlab object, typically a MATLAB `struct` whose contents are documented in each derived class. More...

RTTI classes and functions
mrpt::utils::CObject::Ptr	duplicateGetSmartPtr () const
	Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer). More...

Static Public Member Functions
static void *	operator new (size_t size, void *ptr)

Public Attributes
float	m_x
	2D Coordinates of detected object More...

float	m_y

float	m_height
	Size of detected object. More...

float	m_width

std::string	m_id
	Must be an unique id for each detectable object. More...

mrpt::obs::CObservation::Ptr	obs
	Observation wich contain the deteted object. More...

Protected Member Functions
CSerializable virtual methods
void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const override
	Introduces a pure virtual method responsible for writing to a CStream. More...

void	readFromStream (mrpt::utils::CStream &in, int version) override
	Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori. More...

RTTI stuff
using	Ptr = std::shared_ptr< CDetectable2D >

using	ConstPtr = std::shared_ptr< const CDetectable2D >

static mrpt::utils::CLASSINIT	_init_CDetectable2D

static const mrpt::utils::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "CDetectable2D"

static const mrpt::utils::TRuntimeClassId *	_GetBaseClass ()

static const mrpt::utils::TRuntimeClassId &	GetRuntimeClassIdStatic ()

static mrpt::utils::CObject *	CreateObject ()

template<typename... Args>
static Ptr	Create (Args &&... args)

virtual const mrpt::utils::TRuntimeClassId *	GetRuntimeClass () const override
	Returns information about the class of an object in runtime. More...

virtual mrpt::utils::CObject *	clone () const override
	Returns a deep copy (clone) of the object, indepently of its class. More...

Member Typedef Documentation

◆ ConstPtr

using mrpt::detectors::CDetectable2D::ConstPtr = std::shared_ptr<const CDetectable2D >

Definition at line 48 of file CDetectableObject.h.

◆ Ptr

using mrpt::detectors::CDetectable2D::Ptr = std::shared_ptr< CDetectable2D >

A typedef for the associated smart pointer

Definition at line 48 of file CDetectableObject.h.

Constructor & Destructor Documentation

◆ CDetectable2D() [1/2]

mrpt::detectors::CDetectable2D::CDetectable2D	(	const int &	x = `0`,
		const int &	y = `0`,
		const int &	height = `0`,
		const int &	width = `0`
	)

inline

Extra constructor.

Definition at line 57 of file CDetectableObject.h.

◆ CDetectable2D() [2/2]

mrpt::detectors::CDetectable2D::CDetectable2D ( const CDetectable2D * d )

inline

Copy pointer content constructor.

Definition at line 63 of file CDetectableObject.h.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::utils::TRuntimeClassId* mrpt::detectors::CDetectable2D::_GetBaseClass ( )

staticprotected

◆ clone()

virtual mrpt::utils::CObject* mrpt::detectors::CDetectable2D::clone ( ) const

overridevirtual

Returns a deep copy (clone) of the object, indepently of its class.

Implements mrpt::utils::CObject.

Reimplemented in mrpt::detectors::CDetectable3D.

◆ Create()

template<typename... Args>

static Ptr mrpt::detectors::CDetectable2D::Create ( Args &&... args )

inlinestatic

Definition at line 48 of file CDetectableObject.h.

◆ CreateObject()

static mrpt::utils::CObject* mrpt::detectors::CDetectable2D::CreateObject ( )

static

◆ distanceTo()

double mrpt::detectors::CDetectable2D::distanceTo ( const CDetectable2D & d2 )

inline

Compute distance between centers of two detectable 2D objects.

Returns: calculated distance.

Definition at line 67 of file CDetectableObject.h.

References m_height, m_width, m_x, and m_y.

◆ GetRuntimeClass()

virtual const mrpt::utils::TRuntimeClassId* mrpt::detectors::CDetectable2D::GetRuntimeClass ( ) const

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::detectors::CDetectableObject.

Reimplemented in mrpt::detectors::CDetectable3D.

◆ GetRuntimeClassIdStatic()

static const mrpt::utils::TRuntimeClassId& mrpt::detectors::CDetectable2D::GetRuntimeClassIdStatic ( )

static

◆ operator delete() [1/3]

void mrpt::detectors::CDetectable2D::operator delete ( void * ptr )

inlinenoexcept

Definition at line 48 of file CDetectableObject.h.

◆ operator delete() [2/3]

void mrpt::detectors::CDetectable2D::operator delete	(	void *	memory,
		void *	ptr
	)

inlinenoexcept

Definition at line 48 of file CDetectableObject.h.

◆ operator delete() [3/3]

void mrpt::detectors::CDetectable2D::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 48 of file CDetectableObject.h.

◆ operator delete[]()

void mrpt::detectors::CDetectable2D::operator delete[] ( void * ptr )

inlinenoexcept

Definition at line 48 of file CDetectableObject.h.

◆ operator new() [1/3]

void* mrpt::detectors::CDetectable2D::operator new ( size_t size )

inline

Definition at line 48 of file CDetectableObject.h.

◆ operator new() [2/3]

static void* mrpt::detectors::CDetectable2D::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 48 of file CDetectableObject.h.

◆ operator new() [3/3]

void* mrpt::detectors::CDetectable2D::operator new	(	size_t	size,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 48 of file CDetectableObject.h.

◆ operator new[]()

void* mrpt::detectors::CDetectable2D::operator new[] ( size_t size )

inline

Definition at line 48 of file CDetectableObject.h.

◆ readFromStream()

void mrpt::detectors::CDetectable2D::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)

overrideprotectedvirtual

Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.

Parameters

in	The input binary stream where the object data must read from.
version	The version of the object stored in the stream: use this version number in your code to know how to read the incoming data.

Exceptions

std::exception On any error, see CStream::ReadBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Reimplemented in mrpt::detectors::CDetectable3D.

◆ setObservation()

void mrpt::detectors::CDetectableObject::setObservation ( mrpt::obs::CObservation::Ptr newObs )

inlineinherited

Definition at line 39 of file CDetectableObject.h.

References mrpt::detectors::CDetectableObject::obs.

◆ writeToMatlab()

virtual mxArray* mrpt::utils::CSerializable::writeToMatlab ( ) const

inlinevirtualinherited

Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class.

Returns: A new mxArray (caller is responsible of memory freeing) or nullptr is class does not support conversion to MATLAB.

Definition at line 89 of file CSerializable.h.

◆ writeToStream()

void CDetectable2D::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const

overrideprotectedvirtual

Introduces a pure virtual method responsible for writing to a CStream.

This can not be used directly be users, instead use "stream << object;" for writing it to a stream.

Parameters

out	The output binary stream where object must be dumped.
getVersion	If nullptr, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data.

Exceptions

std::exception On any error, see CStream::WriteBuffer

See also: CStream

Implements mrpt::utils::CSerializable.

Reimplemented in mrpt::detectors::CDetectable3D.

Definition at line 25 of file CDetectableObject.cpp.

Member Data Documentation

◆ _init_CDetectable2D

mrpt::utils::CLASSINIT mrpt::detectors::CDetectable2D::_init_CDetectable2D

staticprotected

Definition at line 48 of file CDetectableObject.h.

◆ className

constexpr const char* mrpt::detectors::CDetectable2D::className = "CDetectable2D"

static

Definition at line 48 of file CDetectableObject.h.

◆ m_height

float mrpt::detectors::CDetectable2D::m_height

Size of detected object.

Definition at line 54 of file CDetectableObject.h.

Referenced by distanceTo().

◆ m_id

std::string mrpt::detectors::CDetectableObject::m_id

inherited

Must be an unique id for each detectable object.

Definition at line 34 of file CDetectableObject.h.

◆ m_width

float mrpt::detectors::CDetectable2D::m_width

Definition at line 54 of file CDetectableObject.h.

Referenced by distanceTo().

◆ m_x

float mrpt::detectors::CDetectable2D::m_x

2D Coordinates of detected object

Definition at line 52 of file CDetectableObject.h.

Referenced by distanceTo().

◆ m_y

float mrpt::detectors::CDetectable2D::m_y

Definition at line 52 of file CDetectableObject.h.

Referenced by mrpt::detectors::CFaceDetection::detectObjects_Impl(), and distanceTo().

◆ obs

mrpt::obs::CObservation::Ptr mrpt::detectors::CDetectableObject::obs

inherited

Observation wich contain the deteted object.

Definition at line 37 of file CDetectableObject.h.

Referenced by mrpt::detectors::CDetectableObject::setObservation().

◆ runtimeClassId

const mrpt::utils::TRuntimeClassId mrpt::detectors::CDetectable2D::runtimeClassId

staticprotected

Definition at line 48 of file CDetectableObject.h.

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

RTTI stuff

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ CDetectable2D() [1/2]

◆ CDetectable2D() [2/2]

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ Create()

◆ CreateObject()

◆ distanceTo()

◆ GetRuntimeClass()

◆ GetRuntimeClassIdStatic()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]()

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]()

◆ readFromStream()

◆ setObservation()

◆ writeToMatlab()

◆ writeToStream()

Member Data Documentation

◆ _init_CDetectable2D

◆ className

◆ m_height

◆ m_id

◆ m_width

◆ m_x

◆ m_y

◆ obs

◆ runtimeClassId