cvr::ioPoints Class Reference
[Aggregate Data Types, Shape Analysis]

Input-Output discrete contour representation. More...

#include <cvrIoPoints.h>

Inheritance diagram for cvr::ioPoints:

[legend]

Collaboration diagram for cvr::ioPoints:

[legend]

List of all members.

Public Member Functions
	ioPoints ()
	ioPoints (const ioPoints &other)
virtual	~ioPoints ()
ioPoints &	castFrom (const borderPoints &theBorderPoints)
ioPoints &	castFrom (const areaPoints &theAreaPoints)
ioPoints &	copy (const ioPoints &other)
ioPoints &	operator= (const ioPoints &other)
virtual const std::string &	name () const
virtual ioPoints *	clone () const
virtual ioPoints *	newInstance () const
bool	extractFromMask (const matrix< ubyte > &mask)
bool	generateMask (matrix< ubyte > &mask, const bool computeBoundary=true, const bool exactBoundaryDimensions=false, const bool keepMaskData=false) const

---

Detailed Description

Input-Output discrete contour representation.

ioPoints is a ipointList that contains all points that belong to a specified io.

For the explanation of the contour description in this class, see following image:

   -- 00000000001111111111222222222233
   -- 01234567890123456789012345678901
   00 --------------------------------
   01 --------------------------------
   02 --------------------------------
   03 --------BBBB------BBBB----------
   04 -------B****BBB----B**B---------
   05 -------B*******B---B***B--------
   06 ------B*******B-----B*B---------
   07 -------B*******BBBBB**B---------
   08 ---------B*************B--------
   09 --------B**----*********B-------
   10 --------B**-----********B-------
   11 -------B**-----*******BB--------
   12 ------B**-----*******B----------
   13 ------B**-------******BB--------
   14 -----B**---------*******B-------
   15 -----B**--------*********B------
   16 ----B**-------**********BB------
   17 ---B***----*******----BB--------
   18 ----BBBBBBBBB***  --*B----------
   19 -------------BBBBBBBB-----------
   20 --------------------------------
   21 --------------------------------
   22 --------------------------------
   23 --------------------------------

  "-" means background and the rest is part of the object.
  "B" indicates a borderpoint.

This contour class allows three representations of a contour:

• ioPoints. It contains all input and output points for each line. For example, for the previous image: (8,3)(11,3)(18,3)(21,3)(7,4)(14,4)(19,4)(22,4)... Note that every IO-point is a border point, but not all border points are IO-points.
• borderPoints. It contains a list of the points at the border. Beginning with the point at (8,3) the chain code for our example image is: (8,3)(9,3)(10,3)(11,3)(12,4)(13,4)(14,4)(15,5)(14,6)...
• areaPoints. It contains all points in the object.

See also:

cvr::areaPoints, cvr::borderPoints

---

Constructor & Destructor Documentation

cvr::ioPoints::ioPoints

(

)

Default constructor.

empty ioPoints

cvr::ioPoints::ioPoints

(

const ioPoints &

other

)

Copy constructor.

virtual cvr::ioPoints::~ioPoints

(

)

[virtual]

Destructor.

---

Member Function Documentation

ioPoints& cvr::ioPoints::castFrom

(

const areaPoints &

theAreaPoints

)

Extracts ioPoints from areaPoints.

ioPoints& cvr::ioPoints::castFrom

(

const borderPoints &

theBorderPoints

)

Extracts ioPoints from borderPoints.

virtual ioPoints* cvr::ioPoints::clone

(

)

const [virtual]

Create a clone of the ioPoints.

Returns:

a pointer to a copy of the ioPoints.

Reimplemented from cvr::pointList< int >.

ioPoints& cvr::ioPoints::copy

(

const ioPoints &

other

)

Extracts ioPoints from the given polygonPoints.

Copy other ioPoints into these.

bool cvr::ioPoints::extractFromMask

(

const matrix< ubyte > &

mask

)

Extract ioPoints from the given mask image.

This function assumes that the mask contains JUST ONE connected object. To get the biggest object on the mask see cvr::objectsFromMask or cvr::fastRelabeling.

bool cvr::ioPoints::generateMask	(	matrix< ubyte > &	mask,
		const bool	computeBoundary = true,
		const bool	exactBoundaryDimensions = false,
		const bool	keepMaskData = false
	)			const

Generate mask from the ioPoints.

The dimensions of the resulting mask are the smallest rectangle to contain the point (0,0) (optional) and all points in this list, plus 1 pixel in both width and heigth. If the given mask is bigger than this size, its dimensions will be kept.

If the boundary of the point list is not up to date, it can be calculated if specified by the arguments:

Parameters:

	mask	The calculated mask will be stored here
	computeBoundary	If false, the internal boundary of the point list will be used, otherwise the boundary will be calculated (but NOT updated!!!).
	exactBoundaryDimensions	If true, the dimensions of the resulting mask will be the smallest rectangle to contain only the points in this list. The origin (0,0) may not be included, therefore a 1:1 correspondence of coordinates will generally not be given.
	keepMaskData	if false, the mask will be initialized with zero before getting the area mask. If true, the previous mask data is not deleted, but the mask will be resized if necessary.

Returns:

true if successful, false otherwise.

virtual const std::string& cvr::ioPoints::name

(

)

const [virtual]

Returns the name of this class.

Reimplemented from cvr::pointList< int >.

virtual ioPoints* cvr::ioPoints::newInstance

(

)

const [virtual]

Create a new instance of ioPoints.

Returns:

a pointer to a new instance of ioPoints

Reimplemented from cvr::pointList< int >.

ioPoints& cvr::ioPoints::operator=

(

const ioPoints &

other

)

[inline]

Assigment operator (alias for copy(other)).

Parameters:

other

the pointList to be copied

Returns:

a reference to the actual pointList

---

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

• cvrIoPoints.h