The linear camera sensor of the e-puck. More...

Public Member Functions | |
EpuckLinearCameraSensor (ConfigurationParameters ¶ms, QString prefix) | |
Constructor. | |
virtual | ~EpuckLinearCameraSensor () |
Destructor. | |
virtual void | save (ConfigurationParameters ¶ms, QString prefix) |
Saves current parameters into the given ConfigurationParameters object. | |
virtual int | size () |
Returns the number of neurons required by this sensor. | |
virtual void | update () |
Performs the sensor update. This also modifies the activation of input neurons. | |
![]() | |
EpuckSensor (ConfigurationParameters ¶ms, QString prefix) | |
Constructor. | |
virtual | ~EpuckSensor () |
Destructor. | |
![]() | |
Sensor (ConfigurationParameters ¶ms, QString prefix) | |
Constructor and Configure. | |
~Sensor () | |
Destructor. | |
QString | name () |
Return the name of the Sensor. | |
void | save (ConfigurationParameters ¶ms, QString prefix) |
Save the parameters into the ConfigurationParameters. | |
void | setName (QString name) |
Use this method for changing the name of the Sensor. | |
![]() | |
ParameterSettableInConstructor (ConfigurationParameters &, QString) | |
void | addObserver (RuntimeParameterObserver *obs) |
T | getRuntimeParameter (QString paramName) |
virtual ParameterSettableUI * | getUIManager () |
ParameterSettable () | |
virtual void | postConfigureInitialization () |
void | removeObserver (RuntimeParameterObserver *obs) |
void | setRuntimeParameter (QString paramName, T newvalue) |
QString | typeName () const |
![]() | |
void | addObserver (RuntimeParameterObserver *obs) |
T | getRuntimeParameter (QString paramName) |
void | removeObserver (RuntimeParameterObserver *obs) |
void | setRuntimeParameter (QString paramName, T newvalue) |
QString | typeName () const |
![]() | |
void | addUsableResource (QString resource) |
void | addUsableResources (QStringList resources) |
void | declareResource (QString name, T *resource, QString lockBuddy="") |
void | deleteResource (QString name) |
T * | getResource (QString name, bool *resourceExists=NULL) |
bool | hasResource (QString name) const |
void | removeAllUsableResources () |
void | removeUsableResource (QString resource) |
void | removeUsableResources (QStringList resources) |
virtual void | shareResourcesWith (ResourcesUser *buddy) |
void | usableResources (QStringList resources) |
bool | usedResourcesExist (QStringList *nonExistingResources=NULL) const |
Static Public Member Functions | |
static void | describe (QString type) |
Generates a description of this class and its parameters. | |
![]() | |
static void | describe (QString type) |
Describes all the parameters for this sensor. | |
![]() | |
static void | describe (QString type) |
Describe all the parameter for configuring the Sensor. | |
![]() | |
static void | describe (QString type) |
static QString | fullParameterDescriptionPath (QString type, QString param) |
static QString | fullSubgroupDescriptionPath (QString type, QString sub) |
![]() | |
static void | describe (QString type) |
static QString | fullParameterDescriptionPath (QString type, QString param) |
static QString | fullSubgroupDescriptionPath (QString type, QString sub) |
Additional Inherited Members | |
![]() | |
enum | Property |
![]() | |
typedef Resource::ResourceChangeType | ResourceChangeType |
![]() | |
AllowMultiple | |
Default | |
IsList | |
IsMandatory | |
![]() | |
static const double | Infinity |
static const int | MaxInteger |
static const int | MinInteger |
![]() | |
QString | actualResourceNameForMultirobot (QString resourceName) const |
Returns the actual resource name to use. | |
void | checkAllNeededResourcesExist () |
Checks whether all resources we need are existing and throws an exception if they aren't. | |
void | resetNeededResourcesCheck () |
Resets the check on needed resources so that the next call to checkAllNeededResourcesExist() will perform the full check and not the quick one. | |
![]() | |
static Descriptor | addTypeDescription (QString type, QString shortHelp, QString longHelp=QString("")) |
static void | setGraphicalEditor (QString type) |
![]() | |
QString | m_epuckResource |
The name of the resource associated with the e-puck robot. | |
QString | m_neuronsIteratorResource |
The name of th resource associated with the neural network iterator. | |
Detailed Description
The linear camera sensor of the e-puck.
This is a linear camera with configurable aperture (using the aperture parameter). The number of photoreceptors can be configured using the numReceptors parameter. Each receptor returns three values, one for each of the three colors (red, green, blue). This means that the size returned by this sensor is 3 * numReceptors. The inputs for the controller are returned in the following order: first the values of all the red receptors, then the values for all the green receptors, finally the values for all the blue receptors. This sensor only works with objects created using the Arena instance.
In addition to all parameters defined by the parent class (EpuckSensor), this class also defines the following parameters:
- numReceptors: the number of receptors of the sensor. Each receptor returns three values, one for each of the three colors (red, green, blue). This means that the size returned by this sensor is 3 * numReceptors (default is 8)
- aperture: the aperture of the camera in degrees. The real e-puck has a camera with an aperture of 36°, but here you can use any value up to 360°
The resources required by this Sensor are the same as those of the parent class plus:
- arena: the instance of the Arena object where the robot lives
Definition at line 306 of file epucksensors.h.
Constructor & Destructor Documentation
EpuckLinearCameraSensor | ( | ConfigurationParameters & | params, |
QString | prefix | ||
) |
Constructor.
Creates and configures the sensor
- Parameters
-
params the ConfigurationParameters containing the parameters prefix the path prefix to the paramters for this Sensor
Definition at line 233 of file epucksensors.cpp.
|
virtual |
Destructor.
Definition at line 244 of file epucksensors.cpp.
Member Function Documentation
|
static |
Generates a description of this class and its parameters.
- Parameters
-
type the string representation of this class name
Definition at line 262 of file epucksensors.cpp.
References ParameterSettableInConstructor::addTypeDescription(), ParameterSettable::IntDescriptor::def(), ParameterSettable::RealDescriptor::def(), ParameterSettable::BoolDescriptor::def(), EpuckSensor::describe(), ParameterSettable::Descriptor::describeBool(), ParameterSettable::Descriptor::describeInt(), ParameterSettable::Descriptor::describeReal(), ParameterSettable::BoolDescriptor::help(), ParameterSettable::RealDescriptor::help(), ParameterSettable::IntDescriptor::help(), ParameterSettable::IntDescriptor::limits(), ParameterSettable::RealDescriptor::limits(), and ParameterSettableInConstructor::MaxInteger.
|
virtual |
Saves current parameters into the given ConfigurationParameters object.
- Parameters
-
params the ConfigurationParameters object in which parameters should be saved prefix the name and path of the group where to save parametrs
Reimplemented from EpuckSensor.
Definition at line 250 of file epucksensors.cpp.
References ConfigurationParameters::createParameter(), EpuckSensor::save(), and ConfigurationParameters::startObjectParameters().
|
virtual |
Returns the number of neurons required by this sensor.
- Returns
- the number of neurons required by this sensor
Implements Sensor.
Definition at line 298 of file epucksensors.cpp.
|
virtual |
Performs the sensor update. This also modifies the activation of input neurons.
Implements Sensor.
Definition at line 274 of file epucksensors.cpp.
References Sensor::checkAllNeededResourcesExist(), LinearCamera::colorForReceptor(), Sensor::name(), NeuronsIterator::nextNeuron(), NeuronsIterator::setCurrentBlock(), NeuronsIterator::setInput(), and LinearCamera::update().
The documentation for this class was generated from the following files:
- experiments/include/epucksensors.h
- experiments/src/epucksensors.cpp