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

#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.

virtual std::string	getInfo ()
	Asks the learning machine to return a string containing statistics on its operation so far.

virtual bool	configure (yarp::os::Searchable &config)

FixedRangeScaler *	clone ()
	Asks the scaler to return a new object of its type.

virtual double	getLowerBoundOut ()
	Accessor for the desired lower bound.

virtual void	setLowerBoundOut (double lo)
	Mutator for the desired lower bound.

virtual double	getUpperBoundOut ()
	Accessor for the desired upper bound.

virtual void	setUpperBoundOut (double uo)
	Mutator for the desired upper bound.

virtual double	getLowerBoundIn ()
	Accessor for the expected lower bound.

virtual void	setLowerBoundIn (double li)
	Mutator for the expected lower bound.

virtual double	getUpperBoundIn ()
	Accessor for the expected upper bound.

virtual void	setUpperBoundIn (double ui)
	Mutator for the expected upper bound.

Public Member Functions inherited from iCub::learningmachine::IScaler
	IScaler (double s=1., double o=0.)
	Constructor.

virtual	~IScaler ()
	Destructor (empty).

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.

virtual double	transform (double val)
	Transforms a single sample value according to the state of the scaler.

virtual double	unTransform (double val)
	Untransforms a single sample value according to the state of the scaler.

std::string	getName () const
	Retrieve the name of this scaler.

void	setName (std::string name)
	Set the name of this machine learning technique.

virtual void	setUpdateEnabled (bool u)
	Mutator for the update state.

virtual bool	getUpdateEnabled ()
	Accessor for the update state.

virtual std::string	toString ()
	Asks the scaler to return a string serialization.

virtual bool	fromString (const std::string &str)
	Asks the scaler to initialize from a string serialization.

Protected Member Functions
void	updateScales ()
	Updates the scale and offset according to the specified expected and desired ranges.

virtual void	writeBottle (yarp::os::Bottle &bot)
	Writes a serialization of the scaler into a bottle.

virtual void	readBottle (yarp::os::Bottle &bot)
	Unserializes a scaler from a bottle.

Protected Attributes
double	lowerBoundIn
	The expected lower bound in the sample values.

double	upperBoundIn
	The expected upper bound in the sample values.

double	lowerBoundOut
	The desired lower bound for the output range.

double	upperBoundOut
	The desired upper bound for the output range.

Protected Attributes inherited from iCub::learningmachine::IScaler
double	offset
	The offset for the linear transformation.

double	scale
	The scale for the linear transformation.

std::string	name
	The name of this type of scaler.

bool	updateEnabled
	Boolean indicating whether the scaler has to update each sample.

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

li	the initial lower input bound
ui	the initial upper input bound
lo	the initial lower output bound
uo	the 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

bot	the 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

l	the 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

l	the 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

u	the 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

u	the 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

bot	the 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:

icub-main/src/libraries/learningMachine/include/iCub/learningMachine/FixedRangeScaler.h
icub-main/src/libraries/learningMachine/src/FixedRangeScaler.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FixedRangeScaler()

Member Function Documentation

◆ clone()

◆ configure()

◆ getInfo()

◆ getLowerBoundIn()

◆ getLowerBoundOut()

◆ getUpperBoundIn()

◆ getUpperBoundOut()

◆ readBottle()

◆ setLowerBoundIn()

◆ setLowerBoundOut()

◆ setUpperBoundIn()

◆ setUpperBoundOut()

◆ updateScales()

◆ writeBottle()

Member Data Documentation

◆ lowerBoundIn

◆ lowerBoundOut

◆ upperBoundIn

◆ upperBoundOut