User Documentation
RAVL, Recognition And Vision Library
DEVELOP HOME PAGE CLASS LIST CONTENTS
Ravl - Pattern Recognition - Functions - FunctionBodyC
 

  PUBLIC
FunctionBodyC::FunctionBodyC(void)
FunctionBodyC::FunctionBodyC(UIntT,UIntT)
FunctionBodyC::FunctionBodyC(istream &)
FunctionBodyC::FunctionBodyC(BinIStreamC &)
FunctionBodyC::Save(ostream &) const
FunctionBodyC::Save(BinOStreamC &) const
FunctionBodyC::Apply(const VectorC &) const
FunctionBodyC::Apply(const SampleC &)
FunctionBodyC::Jacobian(const VectorC &) const
FunctionBodyC::Evaluate(const VectorC &)
FunctionBodyC::InputSize(void) const
FunctionBodyC::OutputSize(void) const
FunctionBodyC::InputSize(UIntT)
FunctionBodyC::OutputSize(UIntT)
RCBodyVC::Save(ostream &) const
RCBodyVC::Save(BinOStreamC &) const
RCBodyVC::Copy(void) const
RCBodyVC::DeepCopy(UIntT) const
RCBodyC::References(void) const
RCBodyC::Copy(void) const
RCBodyC::DeepCopy(UIntT) const
RCBodyC::IncRefCounter(void)
RCBodyC::DecRefCounter(void)

   FunctionBodyC   
 
Map an input vector to an output vector.
 
include "Ravl/PatternRec/Function.hh"
User Level:Develop
Library:RavlPatternRec
In Scope:RavlN

Parent Classes: Derived Classes: Variables:
Methods:
FunctionBodyC()
Default constructor.

FunctionBodyC(UIntT inSize,UIntT outSize)
Create function with given number of inputs and outputs.

FunctionBodyC(istream & strm)
Load from stream.

FunctionBodyC(BinIStreamC & strm)
Load from binary stream.

bool Save(ostream & out) const
Writes object to stream, can be loaded using constructor

bool Save(BinOStreamC & out) const
Writes object to stream, can be loaded using constructor

VectorC Apply(const VectorC & data) const
Apply function to 'data'

SampleC<VectorC> Apply(const SampleC<VectorC> & data)
Apply transform to whole dataset.

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.

VectorMatrixC Evaluate(const VectorC & X)
Evalate the function and its jacobian at the same time.
This method defaults to calling 'Apply' and 'Jacobian' sperately.

UIntT InputSize() const
Size of input vectors

UIntT OutputSize() const
Size of output vectors

UIntT InputSize(UIntT inSize)
Set the input size.
This is for use of designer classes, changing the input size of an existing function has undefined effects.

UIntT OutputSize(UIntT outSize)
Set the output size.
This is for use of designer classes, changing the output size of an existing function has undefined effects.

#include "Ravl/RCHandleV.hh"
bool Save(ostream & out) const
Save to stream 'out'.

bool Save(BinOStreamC & out) const
Save to binary stream 'out'.

RCBodyVC & Copy() const
Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const
Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

#include "Ravl/RefCounter.hh"
UIntT References() const
Access count of handles open to this object.

RCBodyC & Copy() const
Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const
Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

void IncRefCounter()
Increment reference counter.

bool DecRefCounter()
Decrement reference counter.


Maintainer:Charles Galambos, based on code by Robert Crida, Documentation by CxxDoc: Tue Aug 13 09:59:02 2002