MatchMotEstBaseC - Put a brief description of your class here

Developer Documentation

Centre for Vision, Speech & Signal Processing

Comments:
Put a more detailed description of your class handle here. You use embedded html to make it clearer in the html documentation

Parent Classes:

RCHandleAC

Derived Classes:

MatchMotEstC

Methods:

MatchMotEstBaseC(): Default constructor
This creates an invalid handle. You can remove this if you always want to create a full object.
MatchMotEstBaseC(istream & in): Constructor
This creates an invalid handle. userArg should be changed to the real arguments.
MatchMotEstBaseC(MatchMotEstBaseBodyC & bod): Body Constructor
This creates a new handle to a body class, it can be usefull if you wish to return handles to the class from within a body function.
MatchMotEstBaseBodyC & Body(): Access body.
This isn't really needed, they're just to ensure all derived classes work properly.
const MatchMotEstBaseBodyC & Body() const: Constant access body.
This isn't really needed, they're just to ensure all derived classes work properly.
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): 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): 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 MatchMotEstBaseC & out): output stream operator
istream & operator>>(istream & s,MatchMotEstBaseC & in): input stream operator

#include "amma/RCHandleA.hh"

RCAbstractC Abstract(): Create an abstract handle to this object.
BooleanT IsHandleType(const DT &) const: Is handle of given type ?
void CheckHandleType(const DT & dummy) const: Check handle type. Throw an expception if not.
BooleanT Save(ostream & out) const: Save to ostream.
RCHandleAC<MatchMotEstBaseBodyC> Copy() const: Creat a deep copy of this object.
protected:

#include "amma/RCHandle.hh"

BooleanT IsValid() const: Check its a valid handle.
BooleanT IsValidObject() const: Check its a valid handle, and that the object is pointed to is also valid.
RCHandleC<MatchMotEstBaseBodyC> & operator=(const RCHandleC<MatchMotEstBaseBodyC> & oth): Assignment.
BooleanT operator==(const RCHandleC<MatchMotEstBaseBodyC> & oth) const: Comparison operator.
BooleanT operator!=(const RCHandleC<MatchMotEstBaseBodyC> & oth) const: Comparison operator.
UIntT Hash() const: Hash function.x
BooleanT IsConst() const: Is object constant ?
BooleanT IsNotConst() const: Is object not constant ?
void SetConst(void) const: Lock the object.
This is const as a convience though it actual modified the object, often object you wish to ensure are constant already have const set. protected:
void Invalidate(): Turn this into an invalid handle.
MatchMotEstBaseBodyC & Body(): Direct access to body.
const MatchMotEstBaseBodyC & Body() const: Constant access to body.

Programmer:Ratna Rambaruth, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001

MatchMotEstBaseC

Put a brief description of your class here

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