iCub-main
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
iCub::learningmachine::FixedRangeScaler Class Reference

#include <FixedRangeScaler.h>

+ Inheritance diagram for iCub::learningmachine::FixedRangeScaler:

Public Member Functions

 FixedRangeScaler (double li=-1., double ui=1., double lo=-1., double uo=1.)
 Constructor. More...
 
virtual std::string getInfo ()
 Asks the learning machine to return a string containing statistics on its operation so far. More...
 
virtual bool configure (yarp::os::Searchable &config)
 
FixedRangeScalerclone ()
 Asks the scaler to return a new object of its type. More...
 
virtual double getLowerBoundOut ()
 Accessor for the desired lower bound. More...
 
virtual void setLowerBoundOut (double lo)
 Mutator for the desired lower bound. More...
 
virtual double getUpperBoundOut ()
 Accessor for the desired upper bound. More...
 
virtual void setUpperBoundOut (double uo)
 Mutator for the desired upper bound. More...
 
virtual double getLowerBoundIn ()
 Accessor for the expected lower bound. More...
 
virtual void setLowerBoundIn (double li)
 Mutator for the expected lower bound. More...
 
virtual double getUpperBoundIn ()
 Accessor for the expected upper bound. More...
 
virtual void setUpperBoundIn (double ui)
 Mutator for the expected upper bound. More...
 
- Public Member Functions inherited from iCub::learningmachine::IScaler
 IScaler (double s=1., double o=0.)
 Constructor. More...
 
virtual ~IScaler ()
 Destructor (empty). More...
 
virtual void update (double val)
 Feeds a single sample into the scaler, so that it can use this sample to update the offset and scale. More...
 
virtual double transform (double val)
 Transforms a single sample value according to the state of the scaler. More...
 
virtual double unTransform (double val)
 Untransforms a single sample value according to the state of the scaler. More...
 
std::string getName () const
 Retrieve the name of this scaler. More...
 
void setName (std::string name)
 Set the name of this machine learning technique. More...
 
virtual void setUpdateEnabled (bool u)
 Mutator for the update state. More...
 
virtual bool getUpdateEnabled ()
 Accessor for the update state. More...
 
virtual std::string toString ()
 Asks the scaler to return a string serialization. More...
 
virtual bool fromString (const std::string &str)
 Asks the scaler to initialize from a string serialization. More...
 

Protected Member Functions

void updateScales ()
 Updates the scale and offset according to the specified expected and desired ranges. More...
 
virtual void writeBottle (yarp::os::Bottle &bot)
 Writes a serialization of the scaler into a bottle. More...
 
virtual void readBottle (yarp::os::Bottle &bot)
 Unserializes a scaler from a bottle. More...
 

Protected Attributes

double lowerBoundIn
 The expected lower bound in the sample values. More...
 
double upperBoundIn
 The expected upper bound in the sample values. More...
 
double lowerBoundOut
 The desired lower bound for the output range. More...
 
double upperBoundOut
 The desired upper bound for the output range. More...
 
- Protected Attributes inherited from iCub::learningmachine::IScaler
double offset
 The offset for the linear transformation. More...
 
double scale
 The scale for the linear transformation. More...
 
std::string name
 The name of this type of scaler. More...
 
bool updateEnabled
 Boolean indicating whether the scaler has to update each sample. More...
 

Detailed Description

A class that implements preprocessing based on a fixed range of outputs to a fixed range of outputs.

See also
iCub::learningmachine::IScaler
Author
Arjan Gijsberts

Definition at line 39 of file FixedRangeScaler.h.

Constructor & Destructor Documentation

◆ FixedRangeScaler()

iCub::learningmachine::FixedRangeScaler::FixedRangeScaler ( double  li = -1.,
double  ui = 1.,
double  lo = -1.,
double  uo = 1. 
)

Constructor.

Parameters
lithe initial lower input bound
uithe initial upper input bound
lothe initial lower output bound
uothe initial upper output bound

Definition at line 32 of file FixedRangeScaler.cpp.

Member Function Documentation

◆ clone()

FixedRangeScaler* iCub::learningmachine::FixedRangeScaler::clone ( )
inlinevirtual

Asks the scaler to return a new object of its type.

Returns
a fresh instance of the specified type

Implements iCub::learningmachine::IScaler.

Definition at line 101 of file FixedRangeScaler.h.

◆ configure()

bool iCub::learningmachine::FixedRangeScaler::configure ( yarp::os::Searchable &  config)
virtual

Reimplemented from iCub::learningmachine::IScaler.

Definition at line 70 of file FixedRangeScaler.cpp.

◆ getInfo()

std::string iCub::learningmachine::FixedRangeScaler::getInfo ( )
virtual

Asks the learning machine to return a string containing statistics on its operation so far.

Returns
the statistics of the machine

Reimplemented from iCub::learningmachine::IScaler.

Definition at line 44 of file FixedRangeScaler.cpp.

◆ getLowerBoundIn()

virtual double iCub::learningmachine::FixedRangeScaler::getLowerBoundIn ( )
inlinevirtual

Accessor for the expected lower bound.

Definition at line 138 of file FixedRangeScaler.h.

◆ getLowerBoundOut()

virtual double iCub::learningmachine::FixedRangeScaler::getLowerBoundOut ( )
inlinevirtual

Accessor for the desired lower bound.

Definition at line 108 of file FixedRangeScaler.h.

◆ getUpperBoundIn()

virtual double iCub::learningmachine::FixedRangeScaler::getUpperBoundIn ( )
inlinevirtual

Accessor for the expected upper bound.

Definition at line 153 of file FixedRangeScaler.h.

◆ getUpperBoundOut()

virtual double iCub::learningmachine::FixedRangeScaler::getUpperBoundOut ( )
inlinevirtual

Accessor for the desired upper bound.

Definition at line 123 of file FixedRangeScaler.h.

◆ readBottle()

void iCub::learningmachine::FixedRangeScaler::readBottle ( yarp::os::Bottle &  bot)
protectedvirtual

Unserializes a scaler from a bottle.

Parameters
botthe bottle

Reimplemented from iCub::learningmachine::IScaler.

Definition at line 61 of file FixedRangeScaler.cpp.

◆ setLowerBoundIn()

virtual void iCub::learningmachine::FixedRangeScaler::setLowerBoundIn ( double  li)
inlinevirtual

Mutator for the expected lower bound.

Parameters
lthe new lower bound

Definition at line 145 of file FixedRangeScaler.h.

◆ setLowerBoundOut()

virtual void iCub::learningmachine::FixedRangeScaler::setLowerBoundOut ( double  lo)
inlinevirtual

Mutator for the desired lower bound.

Parameters
lthe new lower bound

Definition at line 115 of file FixedRangeScaler.h.

◆ setUpperBoundIn()

virtual void iCub::learningmachine::FixedRangeScaler::setUpperBoundIn ( double  ui)
inlinevirtual

Mutator for the expected upper bound.

Parameters
uthe new upper bound

Definition at line 160 of file FixedRangeScaler.h.

◆ setUpperBoundOut()

virtual void iCub::learningmachine::FixedRangeScaler::setUpperBoundOut ( double  uo)
inlinevirtual

Mutator for the desired upper bound.

Parameters
uthe new upper bound

Definition at line 130 of file FixedRangeScaler.h.

◆ updateScales()

void iCub::learningmachine::FixedRangeScaler::updateScales ( )
protected

Updates the scale and offset according to the specified expected and desired ranges.

Definition at line 38 of file FixedRangeScaler.cpp.

◆ writeBottle()

void iCub::learningmachine::FixedRangeScaler::writeBottle ( yarp::os::Bottle &  bot)
protectedvirtual

Writes a serialization of the scaler into a bottle.

Parameters
botthe bottle

Reimplemented from iCub::learningmachine::IScaler.

Definition at line 54 of file FixedRangeScaler.cpp.

Member Data Documentation

◆ lowerBoundIn

double iCub::learningmachine::FixedRangeScaler::lowerBoundIn
protected

The expected lower bound in the sample values.

Definition at line 44 of file FixedRangeScaler.h.

◆ lowerBoundOut

double iCub::learningmachine::FixedRangeScaler::lowerBoundOut
protected

The desired lower bound for the output range.

Definition at line 54 of file FixedRangeScaler.h.

◆ upperBoundIn

double iCub::learningmachine::FixedRangeScaler::upperBoundIn
protected

The expected upper bound in the sample values.

Definition at line 49 of file FixedRangeScaler.h.

◆ upperBoundOut

double iCub::learningmachine::FixedRangeScaler::upperBoundOut
protected

The desired upper bound for the output range.

Definition at line 59 of file FixedRangeScaler.h.


The documentation for this class was generated from the following files: