RegionSetBodyC<class StatT> - Class for describing the result of a segmentation; include a segmentation map and statistics associated to each region

User Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

BodyRefCounterVC

Variables:

Methods:

RegionSetBodyC(): default constructor
RegionSetBodyC(const ImageC<NumLabelC> & map,const NumDataSetC<NumLabelC,StatT> & stats): Constructor from the segmentation map and the associated statistics for each region
ImageC<NumLabelC> Image() const: Returns the segmentation map
NumDataSetC<NumLabelC,StatT> Stats() const: Returns the statistics associated to each region in the segmentation map
NumDataSetC<NumLabelC,StatT> & Stats(): Returns the statistics associated to each region in the segmentation map
ByteImageC ByteImage() const: Returns the segmentation map in the form of a ByteImageC
IntImageC IntImage() const: Returns the segmentation map in the form of a IntImageC
RGBImageC RandomImage() const: Returns the segmentation map in the form of a colour random image; this means that segmentation maps with more than 255 labels can be saved to disk
YUVImageC RandomTaintImage(ByteGreyValueT max = 100) const: Returns the segmentation map in the form of a colour random image. The Y channel is left blank (e.g., for displaying the original data). The labels in the U and V channels are in the range 0 to 'max'.
void SetMap(const IntImageC & map): The segmentation map for this is changed to map; UpdateStats should be performed after this operation
void UpdateStats(const ImageC<PValueT> & img): Calculates the statistics of the regions in the segmentation map from scratch
void MakeConnectedComponents(): Connected component labelling is performed on the segmentation map; Each new component is given the same statistic as the coreesponding previous region
void MakeConnectedComponents(const ByteImageC & roi): Connected component labelling is performed on the segmentation map; Each new component is given the same statistic as the coreesponding previous region. The whole operation is performed on the region of interest "roi". The region of interest should be labelled 0 and all other pixels in the image should be labelled 1. In the output segmentation map, the pixels outside the region of interest are undefined.

#include "amma/BRefCntV.hh"

BodyRefCounterVC & Copy() const: Creat a copy of this object.
BooleanT operator==(const BodyRefCounterVC & oth) const: Compair identitys.
BooleanT operator!=(const BodyRefCounterVC & oth) const: Compair identitys.
BooleanT Save(ostream & out) const: Save to ostream.

#include "amma/BRefCnt.hh"

void AddReference(): Another reference to the object has been created.
void RemoveReference(): One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.
void SetConst(void) const: This locks the object.
Often objects you wish to lock are already const.
void SetConst(void): This locks the object.
BooleanT IsConst(void) const: Returns TRUE if the object is locked, ie. it is assumed to be constant.
BooleanT IsNotConst(void) const: Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------
BooleanT ToBeDeleted() const: Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.
BooleanT ToBeDeletedRemoveIgnoreNoRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object.
BooleanT ToBeDeletedRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.
BooleanT BodyMightBeDeleted() const: Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .
BooleanT IsCountZero() const: Are there any refrences left ?
BooleanT BRCPtrCanDeleteObject() const: Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.
IntT Count() const: Returns the current state of the counter, ie. how many references to this object exist.
const BodyRefCounterC & operator=(const BodyRefCounterC & b): It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.
BooleanT IsValidObject() const: Test if object is valid.
When amma check is disabled this always returns true.
BooleanT UserBitTest(IntT x) const: Test user flag.
void UserBitSet(IntT x,BooleanT setit = TRUE): Test user flag.
void UserBitZero(IntT x): Set bit to zero.
void ReportBRCError(char * Msg): Report error, used in BRCPtrC.
UIntT Hash() const: Hash on address of object.

#include "amma/RefCBase.hh"

LabelT Label() const: Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.

Programmer:Roshano Roberts, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001

RegionSetBodyC<class StatT>

Class for describing the result of a segmentation; include a segmentation map and statistics associated to each region

include	"amma/Region/RegionSetB.hh"
User Level:	Default
Library:	IPRegion
Example:	exSeg.cc
Section:	default.Roshano Roberts
In Scope:	std