PCPixelLstC - List of PCPixels.

User Documentation

Centre for Vision, Speech & Signal Processing

Comments:
BIG OBJECT

Parent Classes:

DLIterC

Methods:

PCPixelLstC(): Default constructor.
NB. The list will be invalid!
PCPixelLstC(BooleanT withList): Construct with new list.
PCPixelLstC(DListC<PCPixelC> & iter): Constructor.
IntT TrimLine(RealT MaxDist,RealT & DistEst): Trim points that are too far appart to code effiecently and estimate average distance between points. Starting from the mid-point of the line. Return: Number of points left.
IntT TrimLine(RealT MaxDist): Trim points that are too far appart to code effiecently. Return: Number of points left. Starting from the mid-point of the line. Return: Number of points left.
IntT TrimLongest(RealT MaxDist,RealT & DistEst): Trim points that are too far appart to code effiecently and estimate average distance between points. But use the longest segment of pixels without a gap. Return: Number of pixels in segment.
IntT TrimLongest(RealT MaxDist): Trim points that are too far appart to code effiecently and estimate average distance between points. But use the longest segment of pixels without a gap. Return: Number of pixels in segment.
Point2dSArray1dC PointList() const: Convert PCPixelC list to an array of 2d measurment points for fitting.
BooleanT WriteGFHeader(ostream & out): Write out appropriate GF header.
BooleanT WriteGFPnts(ostream & out) const: Write points in GF format.
First number of points N, followed by N co-ordinate pairs.
BooleanT RemoveFromImage(ByteImageC & img): Remove points in list from the image.
Set the to zero.
IntT Size() const: Get number of points in list. (Slow)
BooleanT IsEmpty() const: Is list infact empty ?
void InsFirst(const PCPixelC & px): Insert new pixel at begining of list.
void InsLast(const PCPixelC & px): Insert new pixel at end of list.
DLIterC<PCPixelC> & Iter(): Access the list.
BooleanT IsOk(): Is list valid ?

#include "amma/DLIter.hh"

DLIterC<PCPixelC> Copy() const: Copy constructor.
const DLIterC<PCPixelC> & operator=(const DLIterC<PCPixelC> & it)
const DLIterC<PCPixelC> & DLIter() const: Self-identification. The function returns this object.
BooleanT IsValid() const: Returns TRUE if the iterator was not constructed by the default constructor.
DListC<PCPixelC> List() const: Returns the list whose element is pointed to by this iterator.
const DLIterC<PCPixelC> & MoveBef(DLIterC<PCPixelC> & iter): The element pointed to by 'iter' is moved before the element pointed to by this iterator. This iterator will point to the same element as before, the iterator 'iter' will point to the previous element in the original list.
const DLIterC<PCPixelC> & MoveAft(DLIterC<PCPixelC> & iter): The element pointed to by 'iter' is moved after the element pointed to by this iterator. This iterator will point to the same element as before, the iterator 'iter' will point to the previous element in the original list.
const DLIterC<PCPixelC> & MoveBef(DListC<PCPixelC> & list): All elements of the 'list' are moved before the element pointed to by this iterator. The 'list' will be empty after this operation. BaseBodyDLIterC
const DLIterC<PCPixelC> & MoveAft(DListC<PCPixelC> & list): All elements of the 'list' are moved before the element pointed to by this iterator. The 'list' will be empty after this operation.
const DLIterC<PCPixelC> & MoveBef(BaseBodyDLIterC<PCPixelC> & iter): The element pointed to by 'iter' is moved before the element pointed to by this iterator. This iterator will point to the same element as before, the iterator 'iter' will point to the previous element in the original list.
const DLIterC<PCPixelC> & MoveAft(BaseBodyDLIterC<PCPixelC> & iter): The element pointed to by 'iter' is moved after the element pointed to by this iterator. This iterator will point to the same element as before, the iterator 'iter' will point to the previous element in the original list
operator bool() const: Is iterator at a valid element ?
This is here to keep the SGI compiler happy.

#include "amma/BBDLIter.hh"

PCPixelC & Data(): Access to the object contained in the list element.
PCPixelC & operator*(): Access to the object contained in the list element.
PCPixelC * operator->(): Access to the object contained in the list element.
const PCPixelC & Data() const: Access to the object contained in the list element.
const PCPixelC & operator*() const: Access to the object contained in the list element.
const PCPixelC * operator->() const: Access to the object contained in the list element. ----------- Positioning the iterator -----------------------------
BaseBodyDLIterC<PCPixelC> & First(): Sets the iterator to point to the first element of the list.
BaseBodyDLIterC<PCPixelC> & Last(): Sets the iterator to point to the last element of the list.
BaseBodyDLIterC<PCPixelC> & Next(): Moves the iterator to the successor of the element.
void operator++(int): Moves the iterator to the successor of the element.
BaseBodyDLIterC<PCPixelC> & Prev(): Moves the iterator to the predecessor of the element.
void operator--(int): Moves the iterator to the predecessor of the element.
BaseBodyDLIterC<PCPixelC> & NextCrc(): Moves the iterator to the successor of the element. If the result element is not a proper element of the list the iterator is moved to the first element.
BaseBodyDLIterC<PCPixelC> & PrevCrc(): Moves the iterator to the predecessor of the element. If the result element is not a proper element of the list the iterator is moved to the last element.
BaseBodyDLIterC<PCPixelC> & Nth(LongIntT n): Sets to the n-th element of the list. The index 'n' can be negative. The first element of the list has the index 0, the last element has the index -1. It does not skip the head of the list.
BaseBodyDLIterC<PCPixelC> & RelNth(LongIntT n): Moves to the n-th element from the current element. The index 'n' can be positive, zero, or negative. Particularly, the n = 0 means no move, n = 1 means the move to the next element, and n = -1 means the move to the previous element. Modification of the list item -----------------------------
const BaseBodyDLIterC<PCPixelC> & InsBef(const PCPixelC & data): Inserts the new element containing 'data' before the element pointed to by this iterator. This iterator is returned.
const BaseBodyDLIterC<PCPixelC> & InsAft(const PCPixelC & data): Inserts the new element containing 'data' after the element pointed to by this iterator. This iterator is returned.
const BaseBodyDLIterC<PCPixelC> & MoveBef(BaseBodyDLIterC<PCPixelC> & iter): The element pointed to by 'iter' is moved before the element pointed to by this iterator. This iterator will point to the same element as before, the iterator 'iter' will point to the previous element in the original list.
const BaseBodyDLIterC<PCPixelC> & MoveAft(BaseBodyDLIterC<PCPixelC> & iter): The element pointed to by 'iter' is moved after the element pointed to by this iterator. This iterator will point to the same element as before, the iterator 'iter' will point to the previous element in the original list.
const BaseBodyDLIterC<PCPixelC> & MoveBef(BodyDListC<PCPixelC> & list): All elements of the 'list' are moved before the element pointed to by this iterator. The 'list' will be empty after this operation.
const BaseBodyDLIterC<PCPixelC> & MoveAft(BodyDListC<PCPixelC> & list): All elements of the 'list' are moved before the element pointed to by this iterator. The 'list' will be empty after this operation.
const BaseBodyDLIterC<PCPixelC> & DelMoveNext(): Deletes the element pointed to by this iterator and moves iterator to the next element.
const BaseBodyDLIterC<PCPixelC> & Del(): Deletes the element pointed to by this iterator and moves iterator to the previous element.

#include "amma/BBCDLIte.hh"

const PCPixelC & Data() const: Access to the constant object contained in the list element.
const PCPixelC & operator*() const: Access to the constant object contained in the list element.
const PCPixelC * operator->() const: Access to the constant object contained in the list element.
const PCPixelC & NextData() const: Access to the constant object contained in the list element.
const PCPixelC & PrevData() const: Access to the constant object contained in the list element.
const PCPixelC & NextCrcData() const: Access to the constant object contained in the list element.
const PCPixelC & PrevCrcData() const: Access to the constant object contained in the list element.
const PCPixelC & NextData(int offset) const: Access to the constant object contained in the list element.
const PCPixelC & PrevData(int offset) const: Access to the constant object contained in the list element.
const PCPixelC & NextCrcData(int offset) const: Access to the constant object contained in the list element.
const PCPixelC & PrevCrcData(int offset) const: Access to the constant object contained in the list element.
const BodyDListC<PCPixelC> & List() const: Returns the list whose element is pointed to by this iterator. ------------ Predicates -------------------------------------
BooleanT operator==(const BaseBodyConstDLIterC<PCPixelC> & it) const: Returns TRUE if both iterators point to the same list element.
BooleanT operator!=(const BaseBodyConstDLIterC<PCPixelC> & it) const: Returns TRUE if this iterators points to a different list element than the iterator 'it'.
BooleanT IsFirst() const: Returns TRUE if the pointed element is the first in a list.
BooleanT IsLast() const: Returns TRUE if the pointed element is the last one in a list.
BooleanT IsElm() const: Returns TRUE if the pointed an proper element (not a head) of a list. ----------- Positioning the iterator -----------------------------
BaseBodyConstDLIterC<PCPixelC> & First(): Sets the iterator to point to the first element of the list.
BaseBodyConstDLIterC<PCPixelC> & Last(): Sets the iterator to point to the last element of the list.
BaseBodyConstDLIterC<PCPixelC> & Next(): Moves the iterator to the successor of the element.
void operator++(int): Moves the iterator to the successor of the element.
BaseBodyConstDLIterC<PCPixelC> & Prev(): Moves the iterator to the predecessor of the element.
BaseBodyConstDLIterC<PCPixelC> & NextCrc(): Moves the iterator to the successor of the element. If the result element is not a proper element of the list the iterator is moved to the first element.
BaseBodyConstDLIterC<PCPixelC> & PrevCrc(): Moves the iterator to the predecessor of the element. If the result element is not a proper element of the list the iterator is moved to the last element.
BaseBodyConstDLIterC<PCPixelC> & Nth(LongIntT n): Sets to the n-th element of the list. The index 'n' can be negative. The first element of the list has the index 0, the last element has the index -1. It does not skip the head of the list.
BaseBodyConstDLIterC<PCPixelC> & RelNth(LongIntT n): Moves to the n-th element from the current element. The index 'n' can be positive, zero, or negative. Particularly, the n = 0 means no move, n = 1 means the move to the next element, and n = -1 means the move to the previous element.
LongIntT Index() const: Returns the offset of an element from the first element. Particularly, it returns 0 if the iterator points to the first element, it returns -1 if element is the head of the list, and it returns -2 if the element is not contained in the list. The function does not check counter overflow.

Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001

PCPixelLstC

List of PCPixels.

include	"amma/Image/PCPixelLst.hh"
User Level:	Default
Library:	Lines
Example:	DoGradEst.cc
Section:	Image.Image Processing.Lines
In Scope:	std