Developer Documentation
RAVL, Recognition And Vision Library
USER HOME PAGE CLASS LIST CONTENTS
Ravl - Pattern Recognition - Functions - Function1C
 

  PUBLIC
Function1C::Function1C(void)
Function1C::Function1C(istream &)
Function1C::Function1C(BinIStreamC &)
Function1C::Function1C(Function1BodyC &)
Function1C::Function1C(Function1BodyC *)
Function1C::Body(void)
Function1C::Body(void) const
Function1C::Apply1(const VectorC &) const
FunctionC::Body(void)
FunctionC::Body(void) const
FunctionC::Apply(const VectorC &) const
FunctionC::Apply(const SampleC &)
FunctionC::operator ()(const VectorC &) const
FunctionC::Jacobian(const VectorC &) const
FunctionC::Evaluate(const VectorC &)
FunctionC::InputSize(void) const
FunctionC::OutputSize(void) const
FunctionC::InputSize(UIntT)
FunctionC::OutputSize(UIntT)
RCHandleVC::Body(void) const
RCHandleVC::Body(void)
RCHandleVC::Save(ostream &) const
RCHandleVC::Save(BinOStreamC &) const
RCHandleVC::Abstract(void)
RCHandleVC::operator >>(istream &,RCHandleVC &)
RCHandleVC::operator >>(BinIStreamC &,RCHandleVC &)
RCHandleC::operator =(const RCHandleC &)
RCHandleC::DeepCopy(UIntT) const
RCHandleC::operator ==(const RCHandleC &) const
RCHandleC::operator !=(const RCHandleC &) const
RCHandleC::Hash(void) const
RCHandleC::IsValid(void) const
RCHandleC::Invalidate(void)
RCHandleC::IsHandleType(const DT &) const
RCHandleC::CheckHandleType(const DT &) const
RCHandleC::Body(void)
RCHandleC::Body(void) const
RCHandleC::References(void) const
RCHandleC::operator <<(ostream &,const RCHandleC &)
RCHandleC::operator >>(istream &,RCHandleC &)

   Function1C   
 
Map a vector to a single real value.
 
include "Ravl/PatternRec/Function1.hh"
Source file:Ravl/PatternRec/DataSet/Function1.hh
User Level:Normal
Library:RavlPatternRec
In Scope:RavlN

Parent Classes: Derived Classes: Methods:
Function1C()
Default constructor.
Creates an invalid handle.

Function1C(istream & strm)
Load from stream.

Function1C(BinIStreamC & strm)
Load from binary stream.

Function1C(Function1BodyC & bod)
Body constructor.

Function1C(Function1BodyC * bod)
Body ptr constructor.

Function1BodyC & Body()
Access body.

const Function1BodyC & Body() const
Access body.

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

#include "Ravl/PatternRec/Function.hh"
FunctionBodyC & Body()
Access body.

const FunctionBodyC & Body() const
Access body.

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

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

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.

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 vector

UIntT OutputSize() const
Size of output vector

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"
const FunctionBodyC & Body() const
Constant access to body of object.

FunctionBodyC & Body()
Constant access to body of object.

bool Save(ostream & out) const
Save to stream 'out'.

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

RCAbstractC Abstract()
Create an abstract handle.

istream & operator >>(istream & strm,RCHandleVC<FunctionBodyC> & obj)

BinIStreamC & operator >>(BinIStreamC & strm,RCHandleVC<FunctionBodyC> & obj)

#include "Ravl/RefCounter.hh"
const RCHandleC<FunctionBodyC> & operator =(const RCHandleC<FunctionBodyC> & oth)
Assign handle.

RCHandleC<FunctionBodyC> DeepCopy(UIntT levels = ((UIntT))) const
Do a deep copy of the object.

bool operator ==(const RCHandleC<FunctionBodyC> & oth) const
Are handles to the same object ?

bool operator !=(const RCHandleC<FunctionBodyC> & oth) const
Are handles to different objects ?

UIntT Hash() const
Default hash function.
This hashes on the address of the body.

bool IsValid() const
Test if this is a valid handle.

void Invalidate()
Invalidate this handle.
Unattaches the body from the handle.

bool IsHandleType(const DT &) const
Is handle of given type ?

void CheckHandleType(const DT & dummy) const
Check handle type. Throw an expception if not.

FunctionBodyC & Body()
Access body of object.

const FunctionBodyC & Body() const
Constant access to body of object.

UIntT References() const
Find the number of references to the body of this object.

ostream & operator <<(ostream & strm,const RCHandleC<FunctionBodyC> & obj)

istream & operator >>(istream & strm,RCHandleC<FunctionBodyC> & obj)


Maintainer:Charles Galambos, Documentation by CxxDoc: Tue Aug 13 09:59:30 2002