Traversals::ImageTraversal Class Reference

A base class for traversal algorithms on images. More...

#include <ImageTraversal.h>

Classes
class	Iterator
	A forward iterator through an ImageTraversal. More...

Public Member Functions
	ImageTraversal (const PNG &png, const Point &start, double tolerance, add_function traversal_add, pop_function traversal_pop)
	Constructor for the given traversal. More...
Iterator	begin ()
	Returns an iterator for the traversal starting at the first point (specified in the constructor). More...
Iterator	end ()
	Returns an iterator for the traversal one past the end of the traversal. More...

Detailed Description

A base class for traversal algorithms on images.

This class provides a traversal of the image by returning instances of ImageTraversal::Iterator.

Constructor & Destructor Documentation

ImageTraversal()

Traversals::ImageTraversal::ImageTraversal	(	const PNG &	png,
		const Point &	start,
		double	tolerance,
		add_function	traversal_add,
		pop_function	traversal_pop
	)

Constructor for the given traversal.

Initializes a ImageTraversal on a given png image, starting at start, and with a given tolerance.

Parameters

png	The image this traversal is going to traverse
start	The start point of this traversal
tolerance	If the current point is too different (difference larger than tolerance) with the start point, it will not be included in this traversal
traversal_add	a function pointer to an implemented function which takes in a reference to the work list and the point to be added
traversal_pop	a function pointer to an implemented function which takes in a reference to the work list and returns the next point to be processed in the traversal

Todo:

[Part 1]

Member Function Documentation

begin()

ImageTraversal::Iterator Traversals::ImageTraversal::begin

(

)

Returns an iterator for the traversal starting at the first point (specified in the constructor).

Returns an iterator for the traversal starting at the first point.

Todo:

[Part 1]

end()

ImageTraversal::Iterator Traversals::ImageTraversal::end

(

)

Returns an iterator for the traversal one past the end of the traversal.

Todo:

[Part 1]

---

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

• src/ImageTraversal.h
• src/ImageTraversal.cpp