RobotsIO::Utils::Segmentation Class Reference

Inheritance diagram for RobotsIO::Utils::Segmentation:

Public Member Functions
virtual bool	reset ()
virtual bool	step_frame ()
virtual bool	is_stepping_required () const =0
virtual void	reset_data_loading_time ()
virtual double	get_data_loading_time () const
virtual int	get_frames_between_iterations () const
virtual std::pair< bool, cv::Mat >	segmentation (const bool &blocking)=0
virtual std::pair< bool, cv::Mat >	latest_segmentation ()
virtual double	get_time_stamp ()
virtual void	set_rgb_image (const cv::Mat &image, const double &timestamp)

Detailed Description

Definition at line 22 of file Segmentation.h.

Constructor & Destructor Documentation

~Segmentation()

Segmentation::~Segmentation ( )

virtual

Definition at line 13 of file Segmentation.cpp.

Member Function Documentation

get_data_loading_time()

double Segmentation::get_data_loading_time ( ) const

virtual

Definition at line 34 of file Segmentation.cpp.

get_frames_between_iterations()

int Segmentation::get_frames_between_iterations ( ) const

virtual

N > 1 indicates that the segmentation is available every N frames N = 1 indicates that the segmentation is available at all frames N < 1 indicates that this information is not available

By default, this method returns N = 1. User might override this setting by re-implementing this method.

Reimplemented in RobotsIO::Utils::SegmentationYarpPort.

Definition at line 40 of file Segmentation.cpp.

get_time_stamp()

double Segmentation::get_time_stamp ( )

virtual

Provide the timestamp of the latest valid segmentation that has been received.

By default, this return -1. User might override this method if required.

Reimplemented in RobotsIO::Utils::SegmentationYarpPort.

Definition at line 52 of file Segmentation.cpp.

latest_segmentation()

std::pair< bool, cv::Mat > Segmentation::latest_segmentation ( )

virtual

Provide the latest valid segmentation mask that has been received.

By default, this return (false, cv::Mat()). User might override this method if required.

Reimplemented in RobotsIO::Utils::SegmentationYarpPort.

Definition at line 46 of file Segmentation.cpp.

reset()

bool Segmentation::reset ( )

virtual

Definition at line 17 of file Segmentation.cpp.

reset_data_loading_time()

void Segmentation::reset_data_loading_time ( )

virtual

Definition at line 29 of file Segmentation.cpp.

segmentation()

virtual std::pair< bool, cv::Mat > RobotsIO::Utils::Segmentation::segmentation ( const bool &  blocking )

pure virtual

Provide a new segmentation mask.

Implemented in RobotsIO::Utils::SegmentationYarpPort.

set_rgb_image()

void Segmentation::set_rgb_image ( const cv::Mat &  image, const double &  timestamp  )

virtual

If required, the user might override this method to set the RGB image on which the segmentation has to be evaluated.

Reimplemented in RobotsIO::Utils::SegmentationYarpPort.

Definition at line 58 of file Segmentation.cpp.

step_frame()

bool Segmentation::step_frame ( )

virtual

Definition at line 23 of file Segmentation.cpp.