|
Developer Documentation |
|
Centre for Vision, Speech & Signal Processing |
Comments:
Put a more detailed description of your class here. You use embedded html
to make it clearer in the html documentation.
This documentation should be aimed at people who might what to extend
your class.
Parent Classes:
Variables:
- NumVPixDataSetC dset;
-
The vector/pixel dataset
| ind | Index of types of intererest. |
- RealT thres;
-
The threshold, this is set automatically according to data
| ind | Index of types of intererest. |
- DListC centres;
-
The current centres held by alg
| ind | Index of types of intererest. |
- NumMagnitudeEuclideanC dist;
-
distance metric
| ind | Index of types of intererest. |
- DListC hist;
-
this stores a list of stuff
| ind | Index of types of intererest. |
- ByteImageC done;
-
We keep an image of already assigned points
| ind | Index of types of intererest. |
- ImageRectangleC rec;
-
Just keep record of working rectangle
| ind | Index of types of intererest. |
- IntT xsearch;
-
| ind | Index of types of intererest. |
- IntT ysearch;
-
| ind | Index of types of intererest. |
Methods:
- MeanShiftAlgBodyC(const NumVPixDataSetC & dset,const ImageRectangleC & rec,RealT sdrange,RealT sdscale)
-
Constructor
| ind | Index of types of intererest. |
- MeanShiftAlgBodyC(istream & in)
-
Operators ---------
| ind | Index of types of intererest. |
- BodyRefCounterVC & Copy() const
-
Creat a copy of this object.
| ind | Index of types of intererest. |
- BooleanT Save(ostream & out) const
-
Methods -------
| ind | Index of types of intererest. |
- VectorC MeanShiftVector(const VectorC & centre)
-
Perform one iteration of mean shift algorithm on centre
| ind | Index of types of intererest. |
- void RemoveCentre(const VectorC & centre)
-
remove centre from data and all points that fall inside hper-sphere
| ind | Index of types of intererest. |
- VectorC GetMostDense()
-
return the most dense centre from randomnly chosen centres
| ind | Index of types of intererest. |
- IntT Apply()
-
Apply the algorithm until finish
| ind | Index of types of intererest. |
- ByteImageC RegionImage(const ImageRectangleC & image)
-
Return the labelled region image
| ind | Index of types of intererest. |
- IntImageC RegionMerge(const ImageRectangleC & rec)
-
Merge the close regions together Friends -------
| ind | Index of types of intererest. |
- ostream & operator<<(ostream & s,const MeanShiftAlgBodyC & out)
-
output stream operator
| ind | Index of types of intererest. |
- istream & operator>>(istream & s,MeanShiftAlgBodyC & in)
-
input stream operator
| ind | Index of types of intererest. |
- 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.
- 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.
- void SetUndeletable()
-
Make object undeletable.
Usefull to prevent recursive deleting in graph structures.
Only hackers need this function.
- void ReportInvalidObject(char * Msg = 0) const
-
Tell user about validation failure.
- 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:Kieron J Messer, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001
|