PyramidTree Class Reference

#include <PyramidTree.hh>

Inheritance diagram for PyramidTree:

Collaboration diagram for PyramidTree:

List of all members.

Public Member Functions
	PyramidTree (PyramidTransform &t, int y, int x, int position=-1, PyramidTree *parent=NULL, int generations=1)
	~PyramidTree (void)
void	addGenerations (int depth)
void	moveTo (int y, int x, int position=-1, PyramidTree *parent=NULL)
int	depth (void)
Protected Member Functions
void	findChildPosition (int y, int x, int &resY, int &resX)
void	shiftBy (int shiftY, int shiftX)
Private Attributes
PyramidTransform *	m_transform

---

Detailed Description

A class for pyramid trees. Rather relaxed attitude towards position checking; crashes are avoided but errors not always flagged! Each node can have exactly 4 children. Child #0 is the upper left, the children are stored linewise from there.

Definition at line 26 of file PyramidTree.hh.

---

Constructor & Destructor Documentation

PyramidTree::PyramidTree	(	PyramidTransform &	t,
		int	y,
		int	x,
		int	position = -1,
		PyramidTree *	parent = NULL,
		int	generations = 1
	)

Constructor, creates a tree from a transformed image at a given position and over a depth of a given number of generations

Parameters:

t	the transform
y	the row in the image
x	the col in the image
position	the position in the parent node if applicable
parent	a pointer to the parent node or NULL if root
generations	the number of generations (including this node)

Exceptions:

invalid_argument

if the transform levels are insufficient or the start position in the image's LL

PyramidTree::~PyramidTree

(

void

)

Destructor, does nothing (destruction done by parent class)

---

Member Function Documentation

void PyramidTree::addGenerations

(

int

depth

)

Create/replace a number of generations to this node according to position and subband.

Exceptions:

invalid_argument

if the subband depth is insufficient

Parameters:

depth

the depth to recurse into (not counting this node)

int PyramidTree::depth

(

void

)

Return the current depth including this node

Returns:

the depth

void PyramidTree::findChildPosition	(	int	y,
		int	x,
		int &	resY,
		int &	resX
	)		[protected]

Find the upper left of the position for a new child

Parameters:

y	the row in the image
x	the col in the image
resY	the returned row
resX	the returned col

Exceptions:

invalid_argument

if (y,x) is in subband 1 or in LL

void PyramidTree::moveTo	(	int	y,
		int	x,
		int	position = -1,
		PyramidTree *	parent = NULL
	)

"Move" the tree to a different position in the image by replacing the positions stored in the leaves.

Parameters:

y	the new row
x	the new column
position	the new position in the parent node (or -1 if no change)
parent	the new parent node (or NULL if no change)

void PyramidTree::shiftBy	(	int	shiftY,
		int	shiftX
	)		[protected]

Shift the stored positions in the node and all children by a given amount.

Parameters:

shiftY	the number of rows by which to shift
shiftX	the number of columns by which to shift

---

Member Data Documentation

PyramidTransform* PyramidTree::m_transform [private]

The transform (contains a reference to the image)

Definition at line 76 of file PyramidTree.hh.

---

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

• PyramidTree.hh