MatchMotEstBC<class MotModelT,class OptimiserT> -

Developer Documentation

Centre for Vision, Speech & Signal Processing

Comments:
--------------------------------------------------------------------------- ********** MatchMotEstBC ****************************************** ---------------------------------------------------------------------------

Parent Classes:

MatchMotEstBaseBodyC

Variables:

DoubleImageC frame0;
DoubleImageC frame1;
MotModelT motmodel;
VectorC minP;: search window in 'mm' dimensions
VectorC maxP;: search window in 'mm' dimensions
VectorC constP;
IntSArray1dC precision_steps;: step resolution; no of steps in a unit vector in each dimension; step_size = 1/steps in each dimension
NumMagnitudeRobustC metric;

Methods:

MatchMotEstBC(): Default constructor.
MatchMotEstBC(const DoubleImageC & filtered_reference_frame,const DoubleImageC & filtered_other_frame,const ImageRectangleC & search_window,const NumMagnitudeRobustC & match_measure,const VectorC & start_motion_vector): Constructor
VectorC Estimate(const IntImageC & mask,int in_label,const PixelC & origin): Performs motion estimation
VectorC Estimate(const IntImageC & mask,int in_label,const PixelC & origin,MultiLevelC multilevel): Performs motion estimation
ByteImageC GetMCError(const VectorC & dP,const IntImageC & mask,int in_label,const PixelC & origin): Returns the motion compensated error
ByteImageC GetMCError(const VectorC & dP,const IntImageC & mask,int in_label,const PixelC & origin,const DoubleImageC & orig_frame0,const DoubleImageC & orig_frame1): Returns the motion compensated error using user-supplied images
ByteImageC GetMCImage(const DoubleImageC & scene0,const VectorC & dP,const IntImageC & mask,int in_label,const PixelC & origin): Returns the motion compensated image
ByteImageC GetMCMask(const VectorC & dP,const IntImageC & mask,int in_label,const PixelC & origin): Returns the motion compensated mask
Affine2dC ConstructAffineVector(const VectorC & dP)
VectorC ConstructVector(const Affine2dC & motion_vector)

#include "amma/Motion/MatchMotEstBase.hh"

BodyRefCounterVC & Copy() const: Creat a copy of this object.
BooleanT Save(ostream & out) const: Methods -------
IntT Dummy() const: Dummy function.
VectorC Estimate(const IntImageC & mask,int in_label,const PixelC & origin): Estimate the motion vector
VectorC Estimate(const IntImageC & mask,int in_label,const PixelC & origin,MultiLevelC multilevel): Estimate the motion vector
ByteImageC GetMCError(const VectorC & dP,const IntImageC & mask,int in_label,const PixelC & origin)
ByteImageC GetMCError(const VectorC & dP,const IntImageC & mask,int in_label,const PixelC & origin,const DoubleImageC & orig_frame0,const DoubleImageC & orig_frame1)
ByteImageC GetMCImage(const DoubleImageC & scene0,const VectorC & dP,const IntImageC & mask,int in_label,const PixelC & origin): Returns the motion compensated image
ByteImageC GetMCMask(const VectorC & dP,const IntImageC & mask,int in_label,const PixelC & origin): Returns the motion compensated mask
Affine2dC ConstructAffineVector(const VectorC & dP): Returns the affine motion vector
VectorC ConstructNormalVector(const Affine2dC & motion_vector): Returns the motion vector in AMMA VectorC form Friends -------
ostream & operator<<(ostream & s,const MatchMotEstBaseBodyC & out): output stream operator
istream & operator>>(istream & s,MatchMotEstBaseBodyC & in): input stream operator

#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.
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.

#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:Ratna Rambaruth, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001

MatchMotEstBC<class MotModelT,class OptimiserT>

include	"amma/Motion/MatchMotEstB.hh"
User Level:	Default
Library:	GDMotion
Example:	exMatchEst.cc
Section:	Image.Motion.Estimation.Model-based
In Scope:	std