ev::AbstractRepresentation_< T, Options, E > Class Template Reference

This is an auxiliary class. This class cannot be instanced. More...

#include <abstract-representation.hpp>

Inheritance diagram for ev::AbstractRepresentation_< T, Options, E >:

Public Types
using	Type = typename TypeHelper<T>::Type

Public Member Functions
std::size_t	count () const
	Number of events integrated in the representation.
double	duration () const
	Time difference between the oldest and the newest event integrated in the representation.
double	midTime () const
	Calculate the midpoint time between the oldest and the newest event.
void	clear ()
	Remove all events from the representation.
void	clear (const cv::Mat &background)
	Remove all events from the representation and add a background image.
bool	insert (const Event_< E > &e)
	Insert one event in the representation.
template<std::size_t N>
bool	insert (const Array_< E, N > &array)
	Insert an array of events in the representation.
bool	insert (const Vector_< E > &vector)
	Insert a vector of events in the representation.
bool	insert (Queue_< E > &queue, const bool keep_events_in_queue=false)
	Insert a queue of events in the representation.
void	setTimeOffset (const Event_< E > &e)
	Set time offset.
void	setValue (const bool polarity, const Type &value)
	Set values for ON and OFF pixels.
void	setValue (const Type &value)
	Set value for non-activated pixels (background).
void	setValues (const Type &positive, const Type &negative, const Type &reset)
	Set values for ON, OFF, and non-activated pixels.
void	setColor (const bool polarity, const cv::viz::Color &color)
	Set colors for ON and OFF pixels. For more information, please refer here.
void	setColor (const cv::viz::Color &color)
	Set colors for non-activated pixels (background). For more information, please refer here.
void	setColors (const cv::viz::Color &positive, const cv::viz::Color &negative, const cv::viz::Color &reset)
	Set colors for ON, OFF, and non-activated pixels. For more information, please refer here.
void	setColormap (const cv::ColormapTypes cm)
	Set colormap for the representation.

Detailed Description

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>
class ev::AbstractRepresentation_< T, Options, E >

This is an auxiliary class. This class cannot be instanced.

Member Typedef Documentation

Type

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

using ev::AbstractRepresentation_< T, Options, E >::Type = typename TypeHelper<T>::Type

Type

Member Function Documentation

clear() [1/2]

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

void ev::AbstractRepresentation_< T, Options, E >::clear

(

)

Remove all events from the representation.

Note

The way in which the events are removed should be implemented in the derived classes.

clear() [2/2]

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

void ev::AbstractRepresentation_< T, Options, E >::clear

(

const cv::Mat &

background

)

Remove all events from the representation and add a background image.

Note

The way in which the events are removed should be implemented in the derived classes.

count()

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

std::size_t ev::AbstractRepresentation_< T, Options, E >::count ( ) const

inlinenodiscard

Number of events integrated in the representation.

Returns

Number of events

duration()

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

double ev::AbstractRepresentation_< T, Options, E >::duration ( ) const

inlinenodiscard

Time difference between the oldest and the newest event integrated in the representation.

Returns

Time difference. Returns -1 if time limits are not properly set.

insert() [1/4]

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

template<std::size_t N>

bool ev::AbstractRepresentation_< T, Options, E >::insert

(

const Array_< E, N > &

array

)

Insert an array of events in the representation.

Parameters

array

Event array to insert

Returns

True if all the events have been inserted

insert() [2/4]

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

bool ev::AbstractRepresentation_< T, Options, E >::insert

(

const Event_< E > &

e

)

Insert one event in the representation.

Parameters

e	Event to insert

Returns

True if the event has been inserted

Note

The way in which the event is inserted should be implemented in the derived classes.

Examples

example-point-cloud.cpp.

insert() [3/4]

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

bool ev::AbstractRepresentation_< T, Options, E >::insert

(

const Vector_< E > &

vector

)

Insert a vector of events in the representation.

Parameters

vector

Event vector to insert

Returns

True if all the events have been inserted

insert() [4/4]

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

bool ev::AbstractRepresentation_< T, Options, E >::insert	(	Queue_< E > &	queue,
		const bool	keep_events_in_queue = false )

Insert a queue of events in the representation.

Parameters

queue	Event queue to insert
keep_events_in_queue	If true, events are reinserted in the queue

Returns

True if all the events have been inserted

midTime()

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

double ev::AbstractRepresentation_< T, Options, E >::midTime ( ) const

inlinenodiscard

Calculate the midpoint time between the oldest and the newest event.

Returns

Midpoint time. Returns -1 if time limits are not properly set.

setColor() [1/2]

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

void ev::AbstractRepresentation_< T, Options, E >::setColor ( const bool polarity, const cv::viz::Color & color )

inline

Set colors for ON and OFF pixels. For more information, please refer here.

Parameters

polarity	Positive (ON) or negative (OFF)
color	Color for ON/OFF pixels

Note

cv::viz::Color inherits from cv::Scalar_<double>. Color are defined as BGR with values between 0 and 255.

setColor() [2/2]

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

void ev::AbstractRepresentation_< T, Options, E >::setColor ( const cv::viz::Color & color )

inline

Set colors for non-activated pixels (background). For more information, please refer here.

Parameters

color

Color for non-activated pixels

Note

cv::viz::Color inherits from cv::Scalar_<double>. Color are defined as BGR with values between 0 and 255.

setColormap()

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

void ev::AbstractRepresentation_< T, Options, E >::setColormap ( const cv::ColormapTypes cm )

inline

Set colormap for the representation.

Parameters

cm	Colormap type

Note

Colormap can only be used with 3-channel representations.

setColors()

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

void ev::AbstractRepresentation_< T, Options, E >::setColors ( const cv::viz::Color & positive, const cv::viz::Color & negative, const cv::viz::Color & reset )

inline

Set colors for ON, OFF, and non-activated pixels. For more information, please refer here.

Parameters

positive	Color for ON pixels
negative	Color for OFF pixels
reset	Color for non-activated pixels

Note

cv::viz::Color inherits from cv::Scalar_<double>. Color are defined as BGR with values between 0 and 255.

setTimeOffset()

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

void ev::AbstractRepresentation_< T, Options, E >::setTimeOffset ( const Event_< E > & e )

inline

Set time offset.

Parameters

e

Event

Warning

Offset is set to match the event timestamp, i.e., \(\tau + t = 0\) (where \( \tau \) is the offset and \( t \) is the timestamp of the event).

setValue() [1/2]

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

void ev::AbstractRepresentation_< T, Options, E >::setValue ( const bool polarity, const Type & value )

inline

Set values for ON and OFF pixels.

Parameters

polarity	Positive (ON) or negative (OFF)
value	Value for ON/OFF pixels

setValue() [2/2]

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

void ev::AbstractRepresentation_< T, Options, E >::setValue ( const Type & value )

inline

Set value for non-activated pixels (background).

Parameters

value

Value for non-activated pixels

setValues()

template<typename T, const RepresentationOptions Options = RepresentationOptions::NONE, typename E = int>

void ev::AbstractRepresentation_< T, Options, E >::setValues ( const Type & positive, const Type & negative, const Type & reset )

inline

Set values for ON, OFF, and non-activated pixels.

Parameters

positive	Value for ON pixels
negative	Value for OFF pixels
reset	Value for non-activated pixels

---

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

• modules/representations/include/openev/representations/abstract-representation.hpp