LIBRCSC Docs
Documentation for HELIOS's BASE LIBRCSC library for RoboCup 2D Simulation League.
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
Classes | Public Member Functions | Protected Member Functions | List of all members
rcsc::Localization Class Referenceabstract

localization module More...

#include <localization.h>

Inheritance diagram for rcsc::Localization:
Inheritance graph
[legend]

Classes

struct  PlayerT
 localized player info More...
 

Public Member Functions

virtual ~Localization ()=default
 destructor
 
virtual bool updateBySenseBody (const BodySensor &body)=0
 update internal state using received sense_body information More...
 
virtual bool estimateSelfFace (const WorldModel &wm, const VisualSensor &see, double *self_face, double *self_face_err)=0
 estimate self facing direction. More...
 
virtual bool localizeSelf (const WorldModel &wm, const VisualSensor &see, const ActionEffector &act, const double self_face, const double self_face_err, Vector2D *self_pos, Vector2D *self_pos_err)=0
 localize self position. More...
 
virtual bool localizeBallRelative (const WorldModel &wm, const VisualSensor &see, const double self_face, const double self_face_err, Vector2D *rpos, Vector2D *rpos_err, Vector2D *rvel, Vector2D *rvel_err) const =0
 localze ball relative info More...
 
virtual bool localizePlayer (const WorldModel &wm, const VisualSensor::PlayerT &from, const double self_face, const double self_face_err, const Vector2D &self_pos, const Vector2D &self_vel, PlayerT *to) const =0
 localze other player More...
 

Protected Member Functions

 Localization ()=default
 default constructor (protected)
 

Detailed Description

localization module

Member Function Documentation

◆ estimateSelfFace()

virtual bool rcsc::Localization::estimateSelfFace ( const WorldModel wm,
const VisualSensor see,
double *  self_face,
double *  self_face_err 
)
pure virtual

estimate self facing direction.

Parameters
wmworld model
seeanalyzed see information
self_facepointer to the result variable
self_face_errpointer to the result variable
Returns
result

Implemented in rcsc::LocalizationDefault.

◆ localizeBallRelative()

virtual bool rcsc::Localization::localizeBallRelative ( const WorldModel wm,
const VisualSensor see,
const double  self_face,
const double  self_face_err,
Vector2D rpos,
Vector2D rpos_err,
Vector2D rvel,
Vector2D rvel_err 
) const
pure virtual

localze ball relative info

Parameters
wmworld model
seeanalyzed see info
self_facelocalized self face angle
self_face_errlocalized self face angle error
rpospointer to the variable to store the localized relative position
rpos_errpointer to the variable to store the localized relative position error
rvelpointer to the variable to store the localized relative velocity
rvel_errpointer to the variable to store the localized relative velocity error
Returns
if failed, returns false

Implemented in rcsc::LocalizationDefault.

◆ localizePlayer()

virtual bool rcsc::Localization::localizePlayer ( const WorldModel wm,
const VisualSensor::PlayerT from,
const double  self_face,
const double  self_face_err,
const Vector2D self_pos,
const Vector2D self_vel,
PlayerT to 
) const
pure virtual

localze other player

Parameters
wmworld model
fromseen player info
self_facelocalized self face angle
self_face_errlocalized self face angle error
self_poslocalized self position
self_vellocalized self velocity
topointer to the variable to store the localized result
Returns
if failed, returns false

Implemented in rcsc::LocalizationDefault.

◆ localizeSelf()

virtual bool rcsc::Localization::localizeSelf ( const WorldModel wm,
const VisualSensor see,
const ActionEffector act,
const double  self_face,
const double  self_face_err,
Vector2D self_pos,
Vector2D self_pos_err 
)
pure virtual

localize self position.

Parameters
wmworld model
seeanalyzed see info
actthe last action info
self_facelocalized face angle
self_face_errlocalized face angle error
self_pospointer to the variable to store the localized self position
self_pos_errpointer to the variable to store the localized self position error
Returns
if failed, returns false

Implemented in rcsc::LocalizationDefault.

◆ updateBySenseBody()

virtual bool rcsc::Localization::updateBySenseBody ( const BodySensor body)
pure virtual

update internal state using received sense_body information

Parameters
bodysense_body object
Returns
result

Implemented in rcsc::LocalizationDefault.


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