PUBLIC

NumCostRegionBC::NumCostRegionBC(const NumParametersC &,const ByteImageC &,const ByteImageC &,const IndexNeigh2dC &,const NumMagnitudeC &) NumCostRegionBC::NumCostRegionBC(istream &) NumCostRegionBC::NumCostRegionBC(const NumCostRegionBC &) NumCostRegionBC::Copy(void) const NumCostRegionBC::Cost(const VectorC &) const NumCostRegionBC::GetInfo(void) const NumCostRegionBC::Save(ostream &) const NumCostBC::TransP2X(void) const NumCostBC::TransX2P(void) const NumCostBC::ConstP(void) const NumCostBC::Evaluate(const VectorC &) const NumCostBC::Cost(const VectorC &) const NumCostBC::SetMask(const IntSArray1dC &) NumCostBC::SetConstP(const VectorC &) NumCostBC::MinX(void) const NumCostBC::MaxX(void) const NumCostBC::StartX(void) const NumCostBC::ConvertX2P(const VectorC &) const NumCostBC::Steps(void) const NumCostBC::GetParameters(void) const NumCostBC::GetInfo(void) const NumCostBC::Save(ostream &) const NumFuncBC::Copy(void) const NumFuncBC::SetSizeX(UIntT) NumFuncBC::SetSizeY(UIntT) NumFuncBC::Apply(const VectorC &) NumFuncBC::Evaluate(const VectorC &) const NumFuncBC::Evaluate(const DListC &) const NumFuncBC::operator()(const VectorC &) const NumFuncBC::Jacobian(const VectorC &) const NumFuncBC::GetInfo(void) const NumFuncBC::GetName(void) const NumFuncBC::SizeX(void) const NumFuncBC::SizeY(void) const NumFuncBC::Save(ostream &) const DPProcessBodyC::Apply(const InT &) DPProcessBodyC::ApplyArray(const SArray1dC &,SArray1dC &) DPProcessBodyC::Save(ostream &) const DPProcessBodyC::InputType(void) const DPProcessBodyC::OutputType(void) const DPProcessBaseBodyC::Save(ostream &) const DPProcessBaseBodyC::InputType(void) const DPProcessBaseBodyC::OutputType(void) const DPProcessBaseBodyC::OpType(void) const DPProcessBaseBodyC::IsStateless(void) const DPEntityBodyC::Save(ostream &) const DPEntityBodyC::Copy(void) const BodyRefCounterVC::Copy(void) const BodyRefCounterVC::operator==(const BodyRefCounterVC &) const BodyRefCounterVC::operator!=(const BodyRefCounterVC &) const BodyRefCounterVC::Save(ostream &) const BodyRefCounterC::AddReference(void) BodyRefCounterC::RemoveReference(void) BodyRefCounterC::SetConst(void) const BodyRefCounterC::SetConst(void) BodyRefCounterC::IsConst(void) const BodyRefCounterC::IsNotConst(void) const BodyRefCounterC::ToBeDeleted(void) const BodyRefCounterC::ToBeDeletedRemoveIgnoreNoRemove(void) BodyRefCounterC::ToBeDeletedRemove(void) BodyRefCounterC::BodyMightBeDeleted(void) const BodyRefCounterC::IsCountZero(void) const BodyRefCounterC::BRCPtrCanDeleteObject(void) const BodyRefCounterC::Count(void) const BodyRefCounterC::operator=(const BodyRefCounterC &) BodyRefCounterC::IsValidObject(void) const BodyRefCounterC::UserBitTest(IntT) const BodyRefCounterC::UserBitSet(IntT,BooleanT) BodyRefCounterC::UserBitZero(IntT) BodyRefCounterC::ReportBRCError(char *) BodyRefCounterC::Hash(void) const BodyRefCounterC::SetUndeletable(void) BodyRefCounterC::ReportInvalidObject(char *) const RefCounterBaseC::Label(void) const

NumCostRegionBC
Implementation class for cost function used for comparing image regions.
include	"amma/DERA/NumCostRegionB.hh"
User Level:	Default
Library:	DERARegTrack
Example:	exIndex.cc
Section:	Optimisation.Cost Functions.Implementation Numerical Methods.Optimisation.Cost Functions.Implementation Applications.Image Processing.DERA Small Target Detection
In Scope:	std

Comments:
This is the implementation class for a cost function which compares two image regions The NumCostRegionC handle class should be used.

public NumCostBC

VectorC _Yd;

ind	Index of types of intererest.

ByteImageC _scene;

ind	Index of types of intererest.

IndexNeigh2dC _neigh;

ind	Index of types of intererest.

NumMagnitudeC _metric;

ind	Index of types of intererest.

NumCostRegionBC(const NumParametersC & parameters,const ByteImageC & scene0,const ByteImageC & scene1,const IndexNeigh2dC & neigh,const NumMagnitudeC & metric)

Constructor

ind	Index of types of intererest.

NumCostRegionBC(istream & in)

Contructs from stream

ind	Index of types of intererest.

NumCostRegionBC(const NumCostRegionBC & oth)

Copy Constructor

ind	Index of types of intererest.

BodyRefCounterVC & Copy() const

Makes a deep copy and is virtual

ind	Index of types of intererest.

RealT Cost(const VectorC & X) const

Evaluate cost function at X

ind	Index of types of intererest.

const StringC GetInfo() const

Prints derived class information

ind	Index of types of intererest.

BooleanT Save(ostream & out) const

Writes object to stream, can be loaded using constructor

ind	Index of types of intererest.

const MatrixC TransP2X() const

Convert variable parameters to X vector

const MatrixC TransX2P() const

Convert X vector to variable parameters

const VectorC ConstP() const

Constant componant of X vector

VectorC Evaluate(const VectorC & X) const

Evaluate Y=f(X) where Yc=1

RealT Cost(const VectorC & X) const

Determines cost of X

void SetMask(const IntSArray1dC & mask)

Used to specify which elements are fixed

void SetConstP(const VectorC & constP)

Used to specify the vector of fixed constant parameters

const VectorC MinX() const

Lower bound on variable parameters

const VectorC MaxX() const

Upper bound on variable parameters

const VectorC StartX() const

Returns the initial point for X as non-const part of constP

VectorC ConvertX2P(const VectorC & X) const

Expands X to P using TransX2P * X + Const P

const IntSArray1dC Steps() const

Number of steps for each parameter

const NumParametersC & GetParameters() const

Access to the parameter storage structure

const StringC GetInfo() const

Prints derived class information

BooleanT Save(ostream & out) const

Writes object to stream, can be loaded using constructor

BodyRefCounterVC & Copy() const

Makes a deep copy and is virtual
As the copy constructor but is virtual so can be called from a base class reference.

void SetSizeX(UIntT X)

Sets size of input vector

void SetSizeY(UIntT Y)

Sets size of output vector

VectorC Apply(const VectorC & X)

Evaluate Y=f(X) as a process

VectorC Evaluate(const VectorC & X) const

Evaluate Y=f(X)
This is the main function that does all the work and must be overloaded in derived classes.

DListC<VectorC> Evaluate(const DListC<VectorC> & listX) const

Evaluate Y=f(X) for a list of X
This is achieved by iterating through the list of X and using the Evaluate member function that takes a single X. For sophisticated applications where speed is important, this function can be overloaded to do batch processing.

VectorC operator()(const VectorC & X) const

Evaluate Y=f(X)

MatrixC Jacobian(const VectorC & X) const

Calculate Jacobian matrix at X
Performs numerical estimation of the Jacobian using differences. This function has and should be overloaded for all cases where the Jacobian can be calculated analytically.

const StringC GetInfo() const

Derived class information

const StringC & GetName() const

Derived class type

UIntT SizeX() const

Size of input vectors

UIntT SizeY() const

Size of output vectors

BooleanT Save(ostream & out) const

Writes object to stream, can be loaded using constructor

VectorC Apply(const VectorC &)

Apply operation.

IntT ApplyArray(const SArray1dC<VectorC> & in,SArray1dC<VectorC> & out)

Apply operation to an array of elements.
returns the number of elements processed.

BooleanT Save(ostream & out) const

Save to ostream.

const type_info & InputType() const

Get input type.

const type_info & OutputType() const

Get input type.

BooleanT Save(ostream & out) const

Save to ostream.

const type_info & InputType() const

Get input type.

const type_info & OutputType() const

Get input type.

ProcTypeT OpType() const

Operation type lossy/lossless.

BooleanT IsStateless() const

Is operation stateless ?

BooleanT Save(ostream & out) const

Save to ostream.

BodyRefCounterVC & Copy() const

Creat a copy of this object.

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.