te::cl::ROI Class Reference

A region of interest (often abbreviated ROI), is a selected subset of samples within a dataset identified for a particular purpose. More...

#include <ROI.h>

Public Member Functions
void	addPolygon (te::gm::Polygon *p, std::string id)
	Add a new region into this ROI.
std::string	getColor ()
	Get the ROI color defined by a hexadecimal color name.
std::string	getLabel ()
	Get the ROI label.
std::map< std::string, te::gm::Polygon * > &	getPolygons ()
	Get all polygons belongs to this roi.
void	removePolygon (std::string id)
	Removes a region from this ROI.
	ROI (std::string label)
	Default constructor.
void	setColor (std::string color)
	Set the ROI color using the hexadecimal color name.
void	setLabel (std::string label)
	Set the ROI label.
virtual	~ROI ()
	Virtual destructor.

Private Attributes
std::string	m_color
	The hexa color associated with this ROI.
std::string	m_label
	ROI label.
std::map< std::string, te::gm::Polygon * >	m_roiMap
	The map of acquired regions.

Detailed Description

A region of interest (often abbreviated ROI), is a selected subset of samples within a dataset identified for a particular purpose.

An ROI can be taken literally as a polygonal selection from a 2D map. In computer vision and optical character recognition, the ROI defines the borders of an object under consideration. In many applications, symbolic (textual) labels are added to a ROI, to describe its content in a compact manner.

Within an ROI may lie individual points of interest (POIs).

In this first version, the region will be represented only by polygons.

Definition at line 60 of file ROI.h.

Constructor & Destructor Documentation

ROI()

te::cl::ROI::ROI

(

std::string

label

)

Default constructor.

~ROI()

virtual te::cl::ROI::~ROI ( )

virtual

Virtual destructor.

Member Function Documentation

addPolygon()

void te::cl::ROI::addPolygon	(	te::gm::Polygon *	p,
		std::string	id
	)

Add a new region into this ROI.

Parameters

p	The polygon that represents the region of interest.
id	The polygon unique identifier.

getColor()

std::string te::cl::ROI::getColor

(

)

Get the ROI color defined by a hexadecimal color name.

getLabel()

std::string te::cl::ROI::getLabel

(

)

Get the ROI label.

getPolygons()

std::map< std::string, te::gm::Polygon * > & te::cl::ROI::getPolygons

(

)

Get all polygons belongs to this roi.

removePolygon()

void te::cl::ROI::removePolygon

(

std::string

id

)

Removes a region from this ROI.

Parameters

id	The polygon ID that has to be removed.

setColor()

void te::cl::ROI::setColor

(

std::string

color

)

Set the ROI color using the hexadecimal color name.

setLabel()

void te::cl::ROI::setLabel

(

std::string

label

)

Set the ROI label.

Member Data Documentation

m_color

std::string te::cl::ROI::m_color

private

The hexa color associated with this ROI.

Definition at line 106 of file ROI.h.

m_label

std::string te::cl::ROI::m_label

private

ROI label.

Definition at line 105 of file ROI.h.

m_roiMap

std::map<std::string, te::gm::Polygon*> te::cl::ROI::m_roiMap

private

The map of acquired regions.

Definition at line 107 of file ROI.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/classification/ROI.h