iCub-main
Loading...
Searching...
No Matches
Public Member Functions | List of all members
iCub::learningmachine::TransformModule Class Reference

A module for transforming vectors. More...

#include <TransformModule.h>

+ Inheritance diagram for iCub::learningmachine::TransformModule:

Public Member Functions

 TransformModule (std::string pp="/lm/transform")
 Constructor.
 
virtual ~TransformModule ()
 Destructor (empty).
 
virtual bool configure (yarp::os::ResourceFinder &opt)
 
virtual bool interruptModule ()
 
virtual bool respond (const yarp::os::Bottle &cmd, yarp::os::Bottle &reply)
 
virtual ITransformergetTransformer ()
 Retrieve the transformer that is used in this TransformModule.
 
virtual TransformerPortablegetTransformerPortable ()
 Retrieve the transformer portable.
 
- Public Member Functions inherited from iCub::learningmachine::IMachineLearnerModule
 IMachineLearnerModule (std::string pp)
 Constructor.
 
virtual ~IMachineLearnerModule ()
 Destructor (empty).
 
virtual bool close ()
 Close the module.
 
virtual bool updateModule ()
 Default empty update loop with 1 second delay.
 

Additional Inherited Members

- Protected Member Functions inherited from iCub::learningmachine::IMachineLearnerModule
 IMachineLearnerModule (const IMachineLearnerModule &other)
 Copy Constructor (private and unimplemented on purpose).
 
IMachineLearnerModuleoperator= (const IMachineLearnerModule &other)
 Assignment operator (private and unimplemented on purpose).
 
void registerPort (yarp::os::Contactable &port, std::string name)
 Register a port with a given name.
 
virtual void loadCommandFile (std::string fname, yarp::os::Bottle *out=(yarp::os::Bottle *) 0)
 Reads bottles from a file and sends these one by one to the respond method.
 
virtual yarp::os::ResourceFinder & getResourceFinder ()
 Returns a reference to the cached ResourceFinder.
 
std::string findFile (std::string fname)
 Finds the full path to a specified filename using the ResourceFinder.
 
virtual void setResourceFinder (yarp::os::ResourceFinder *rf)
 Mutator for the locally stored ResourceFinder.
 
- Protected Attributes inherited from iCub::learningmachine::IMachineLearnerModule
yarp::os::Port cmd_in
 An input port for commands.
 
std::string portPrefix
 A prefix path for the ports that will be registered.
 
DispatcherManager dmanager
 An instance of the DispatchManager to configure event listeners.
 
yarp::os::ResourceFinder * rf
 A pointer to the ResourceFinder.
 

Detailed Description

A module for transforming vectors.

This most common use of this module will be data preprocessing (e.g. standardization), although it also supports much more advanced transformations of the data.

Author
Arjan Gijsberts

Definition at line 176 of file TransformModule.h.

Constructor & Destructor Documentation

◆ TransformModule()

iCub::learningmachine::TransformModule::TransformModule ( std::string  pp = "/lm/transform")
inline

Constructor.

Parameters
ppthe default prefix used for the ports.

Definition at line 249 of file TransformModule.h.

◆ ~TransformModule()

virtual iCub::learningmachine::TransformModule::~TransformModule ( )
inlinevirtual

Destructor (empty).

Definition at line 258 of file TransformModule.h.

Member Function Documentation

◆ configure()

bool iCub::learningmachine::TransformModule::configure ( yarp::os::ResourceFinder &  opt)
virtual

Definition at line 134 of file TransformModule.cpp.

◆ getTransformer()

virtual ITransformer & iCub::learningmachine::TransformModule::getTransformer ( )
inlinevirtual

Retrieve the transformer that is used in this TransformModule.

Returns
a reference to the transformer

Definition at line 280 of file TransformModule.h.

◆ getTransformerPortable()

virtual TransformerPortable & iCub::learningmachine::TransformModule::getTransformerPortable ( )
inlinevirtual

Retrieve the transformer portable.

Returns
a reference to the transformer portable

Definition at line 289 of file TransformModule.h.

◆ interruptModule()

bool iCub::learningmachine::TransformModule::interruptModule ( )
virtual

Definition at line 125 of file TransformModule.cpp.

◆ respond()

bool iCub::learningmachine::TransformModule::respond ( const yarp::os::Bottle &  cmd,
yarp::os::Bottle &  reply 
)
virtual

Definition at line 216 of file TransformModule.cpp.


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