Lookout.h

Go to the documentation of this file.

//-*-c++-*-
#ifndef INCLUDED_Lookout_h_
#define INCLUDED_Lookout_h_

#include <queue>

#include "Behaviors/BehaviorBase.h"
#include "Crew/LookoutRequests.h"
#include "DualCoding/ShapePolygon.h"
#include "Events/VisionObjectEvent.h"
#include "Motion/HeadPointerMC.h"

namespace DualCoding {


//! The Lookout accepts LookoutRequests to move the head and collect sensor information.
/*!
 HeadMotionType can be none (user will point the head himself),
 pointAt, scan, track, or search.  The data collected can be an image
 or distance reading, or for scan operations, it can be a list of
 locations where certain VisionObject or VisionRegion streams reported
 hits.

*/

class Lookout : public BehaviorBase {
public:
  //! Constructor
  Lookout();

  virtual void doStart();
  virtual void doStop();
  virtual void doEvent();

  static std::string getClassDescription() { return "Moves head and collects data according to request"; }
  virtual std::string getDescription() const { return getClassDescription(); }

  unsigned int executeRequest(const LookoutRequestBase&);
  unsigned int executeRequest(BehaviorBase* requestingBehavior, const LookoutRequestBase& req);
  bool busy() { return curReq != NULL; }
  void stopTrack();

  static Shape<PolygonData> groundSearchPoints(); //!< returns a polygon with points for searching the ground around the robot

  void moveHeadToPoint();
  //  bool isLandmarkVisible() const { return landmark_inview; }

  void relax(); //!< Inactivates all Lookout motion commands; called when MapBuilder finishes

  static Point findLocationFor(const float normX, const float normY);
  static const unsigned int invalid_LO_ID=(unsigned int)-1;
  
protected:
  virtual void executeRequest();
  virtual void requestComplete(bool result=true);

  template<class T>
  void pushRequest(const LookoutRequestBase& req) {
    requests.push(new T(dynamic_cast<const T&>(req)));
  }
    

  //@name PointAtRequest functions
  //@{
  void processPointAtEvent(const EventBase& event);
  bool findPixelModes();
#ifdef TGT_HAS_IR_DISTANCE
  bool findDistanceMode();
  float getDistanceModeValue();
#endif
  //@}

  //@name ScanRequest functions
  //@{
  void setupScan();
  void triggerScanMotionSequence();
  void processScanEvent(const EventBase& event);
  void scanAlongLine(const Point& start,const Point& end);
  void scanAlongPolygon(const std::vector<Point>& vertices, const bool closed=false);
  void scanArea(const Point &topLeft, const Point &topRight,
    const Point &bottomLeft, const Point &bottomRight);

  static Point findLocationFor(const VisionObjectEvent& visev) {
    return findLocationFor(visev.getCenterX(), visev.getCenterY());
  }

  static Point findLocationFor(const CMVision::region* reg);

  void storeVisionRegionDataTo(std::vector<Point>&, const std::set<color_index>&, int);
#ifdef TGT_HAS_IR_DISTANCE
  void storeIRDataTo(std::vector<Point>&);
#endif
  //@}

  //@name TrackRequest functions
  //@{
  void setupTrack();
  void processTrackEvent(const EventBase& event);
  /*
  void processTrackVision(float normX, float normY, bool isCurrentlyVisible);
  void trackObjectAt(float normX, float normY); //! tracks point at [normX,normY] in cam frame
  Point findLocationFor(float, float);
  */
  //@}

  //@name SearchRequest functions
  //@{
  void setupSearch();
  void processSearchEvent(const EventBase& event);
  void triggerSearchMotionSequence();
  static void searchAt(HeadPointerMC &hpmc_temp,
           std::vector<float> &jointvals,
           const Point &target);
  //@}


private:
  unsigned int idCounter;
  Lookout& operator=(const Lookout&);
  Lookout(const Lookout&);

protected:
  std::vector<std::map<uchar,unsigned int> > pixelHistograms;
  std::priority_queue<float> distanceSamples;

  MC_ID pointer_id;  //!< id for HeadPointerMC for pointing the camera
  MC_ID posture_id;  //!< id for PostureMC for pointing the IR sensors
  MC_ID sequence_id; //!< id for MotionSequenceMC for scanning
  std::queue<LookoutRequestBase*> requests;  //!< queue of pending LookoutRequestBase instances, including the current request
  LookoutRequestBase *curReq;           //!< pointer to request currently being executed
  LookoutPointRequest *curPAR;      //!< current Point-At request (same object as curReq)
  bool successSave;

  enum TrackerStates {
    inactive,
    moveToAcquire,
    tracking,
    searching,
    centering,
    lost
  } trackerState;

  enum LookoutTimerSourceId_t {
    settle_timer = 1,
    sample_timer,
    lost_timer,
    scan_timer, //scan_timer has to be at the end of enum list
  };
};

} //namespace

#endif