sipp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008, Maxim Likhachev
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the University of Pennsylvania nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef __ENVSIPP_H_
#define __ENVSIPP_H_

#include <sbpl_dynamic_planner/DiscreteSpaceTimeInformation.h>
#include <sbpl_dynamic_planner/sbpl_dynamicObstacles.h>

//eight-connected grid
#define ENVSIPPLAT_DXYWIDTH 8

#define ENVSIPPLAT_DEFAULTOBSTHRESH 254 //see explanation of the value below
#define ENVSIPPLAT_DEFAULTDYNOBSTHRESH 254      //see explanation of the value below


//definition of theta orientations
//0 - is aligned with X-axis in the positive direction (1,0 in polar coordinates)
//theta increases as we go counterclockwise
//number of theta values - should be power of 2
#define ENVSIPPLAT_THETADIRS 16

//number of actions per x,y,theta state
#define ENVSIPPLAT_DEFAULT_ACTIONWIDTH 5 //decrease, increase, same angle while moving plus decrease, increase angle while standing.

#define ENVSIPPLAT_COSTMULT_MTOMM 1000

#define CONTTIME2DISC(X, CELLSIZE) (((X)>=0)?((int)((X)/(CELLSIZE)+0.5)):((int)((X)/(CELLSIZE))-1))
#define DISCTIME2CONT(X, CELLSIZE) ((X)*(CELLSIZE))

#define FAIL 0
#define SUCCESS_WITH_TIME 1
#define SUCCESS_NO_TIME 2

typedef struct
{
        char starttheta;
        char dX;
        char dY;
        int dT;
  char endtheta;
        unsigned int cost;
  
  //all cells within footprint of polygon for all pose on trajectory
        vector<SBPL_4Dcell_t> intersectingcellsV;
        
  //start at 0,0,starttheta and end at endcell in continuous domain with half-bin less to account for 0,0 start
  //points along centerpoint trajectory (continuous)
        vector<SBPL_4Dpt_t> intermptV;
        
  //start at 0,0,starttheta and end at endcell in discrete domain
  //centerpoint cells along all poses in trajectory
        vector<SBPL_4Dcell_t> interm4DcellsV;
} envSIPPLatAction_t;


typedef struct 
{
        int stateID;
        int X;
        int Y;
        char Theta;
  int Interval;
  int T;
  bool closed;
        int iteration;
} envSIPPLatHashEntry_t;


typedef struct
{
        int motprimID;
        unsigned char starttheta_c;
        int additionalactioncostmult;
        SBPL_4Dcell_t endcell;
        //intermptV start at 0,0,starttheta and end at endcell in continuous domain with half-bin less to account for 0,0 start
        vector<SBPL_4Dpt_t> intermptV; 
}SBPL_xythetasipp_mprimitive;


//variables that dynamically change (e.g., array of states, ...)
typedef struct
{

        int startstateid;
        int goalstateid;

        bool bInitialized;

        //any additional variables


}EnvSIPPLat_t;

//configuration parameters
typedef struct envSIPPLat_config
{
        int EnvWidth_c;
        int EnvHeight_c;
        int StartX_c;
        int StartY_c;
        int StartTheta;
        int StartTime;
        int EndX_c;
        int EndY_c;
        int EndTheta;
        unsigned char** Grid2D;

        //the value at which and above which cells are obstacles in the maps sent from outside
        //the default is defined above
        unsigned char obsthresh; 

        //the value at which and above which until obsthresh (not including it) cells have the nearest obstacle at distance smaller than or equal to 
        //the inner circle of the robot. In other words, the robot is definitely colliding with the obstacle, independently of its orientation
        //if no such cost is known, then it should be set to obsthresh (if center of the robot collides with obstacle, then the whole robot collides with it
        //independently of its rotation)
        unsigned char cost_inscribed_thresh; 

        //the value at which and above which until cost_inscribed_thresh (not including it) cells 
        //**may** have a nearest osbtacle within the distance that is in between the robot inner circle and the robot outer circle
        //any cost below this value means that the robot will NOT collide with any obstacle, independently of its orientation
        //if no such cost is known, then it should be set to 0 or -1 (then no cell cost will lower than it, and therefore the robot's footprint will always be checked)
        int cost_possibly_circumscribed_thresh; //it has to be integer, because -1 means that it is not provided.

  //theshold for how close we get to a dynamic obstacle before it is called a collision
        unsigned char dynamic_obstacle_collision_cost_thresh;

        double nominalvel_mpersecs;
        double timetoturn45degsinplace_secs;
        double cellsize_m;
        double timeResolution;

        int dXY[ENVSIPPLAT_DXYWIDTH][2];

        envSIPPLatAction_t** ActionsV; //array of actions, ActionsV[i][j] - jth action for sourcetheta = i
        vector<envSIPPLatAction_t*>* PredActionsV; //PredActionsV[i] - vector of pointers to the actions that result in a state with theta = i

        int actionwidth; //number of motion primitives
        vector<SBPL_xythetasipp_mprimitive> mprimV;

        vector<sbpl_2Dpt_t> FootprintPolygon;
  double robotRadius;
  double maxMovement;
} envSIPPLatConfig_t;


//-------------------------------------------------------------------------//

class SBPL2DGridSearch;

class EnvSIPPLattice : public DiscreteSpaceTimeInformation
{

public:

        EnvSIPPLattice();

        bool InitializeEnv(const char* sEnvFile, const vector<sbpl_2Dpt_t>& perimeterptsV, const char* sMotPrimFile, const char* sDynObsFile);  
        bool InitializeEnv(const char* sEnvFile, const vector<sbpl_2Dpt_t>& perimeterptsV, const char* sMotPrimFile);   
        bool InitializeEnv(const char* sEnvFile);
        virtual bool SetEnvParameter(const char* parameter, int value);
        virtual int GetEnvParameter(const char* parameter);
        bool InitializeMDPCfg(MDPConfig *MDPCfg);
        virtual int  GetFromToHeuristic(int FromStateID, int ToStateID) = 0;
        virtual int  GetGoalHeuristic(int stateID) = 0;
        virtual int  GetStartHeuristic(int stateID) = 0;
        virtual void SetAllActionsandAllOutcomes(CMDPSTATE* state) = 0;
        virtual void SetAllPreds(CMDPSTATE* state);
        virtual void GetSuccs(int SourceStateID, vector<int>* SuccIDV, vector<int>* CostV);

        virtual void GetPreds(int TargetStateID, vector<int>* PredIDV, vector<int>* CostV) = 0;


        void PrintEnv_Config(FILE* fOut);

    bool InitializeEnv(int width, int height,
                       const unsigned char* mapdata,
                       double startx, double starty, double starttheta, double startTime,
                       double goalx, double goaly, double goaltheta,
                                           double goaltol_x, double goaltol_y, double goaltol_theta,
                                           const vector<sbpl_2Dpt_t> & perimeterptsV,
                                           double cellsize_m, double timeResolution,
             double nominalvel_mpersecs, double timetoturn45degsinplace_secs, 
                                           unsigned char obsthresh, unsigned char dynobsthresh, const char* sMotPrimFile,
             vector<SBPL_DynamicObstacle_t> & dynObs);
    bool InitializeEnv(int width, int height,
                       const unsigned char* mapdata,
                       double startx, double starty, double starttheta, double startTime,
                       double goalx, double goaly, double goaltheta,
                                           double goaltol_x, double goaltol_y, double goaltol_theta,
                                           const vector<sbpl_2Dpt_t> & perimeterptsV,
                                           double cellsize_m, double timeResolution,
             double nominalvel_mpersecs, double timetoturn45degsinplace_secs, 
                                           unsigned char obsthresh, unsigned char dynobsthresh, const char* sMotPrimFile);
    bool UpdateCost(int x, int y, unsigned char newcost);
        virtual void GetPredsofChangedEdges(vector<nav2dcell_t> const * changedcellsV, vector<int> *preds_of_changededgesIDV) = 0;
        virtual void GetSuccsofChangedEdges(vector<nav2dcell_t> const * changedcellsV, vector<int> *succs_of_changededgesIDV) = 0;


        bool IsObstacle(int x, int y);
        bool IsValidConfiguration(int X, int Y, int Theta);

  int getStartID();
  int getGoalID();

        void GetEnvParms(int *size_x, int *size_y, double* startx, double* starty, double* starttheta, double* startTime, double* goalx, double* goaly, double* goaltheta,
                        double* cellsize_m, double* timeResolution, double* nominalvel_mpersecs, double* timetoturn45degsinplace_secs, unsigned char* obsthresh, unsigned char* dyn_obs_thresh, vector<SBPL_xythetasipp_mprimitive>* motionprimitiveV);

        const envSIPPLatConfig_t* GetEnvNavConfig();


    ~EnvSIPPLattice();

    void PrintTimeStat(FILE* fOut);
  
        unsigned char GetMapCost(int x, int y);

  
  bool IsWithinMapCell(int X, int Y);
  
  //bool PoseContToDisc(double px, double py, double pth,
                      //int &ix, int &iy, int &ith) const;
  bool PoseContToDisc(double px, double py, double pth, double pt,
                      int &ix, int &iy, int &ith, int &it) const;
  
  //bool PoseDiscToCont(int ix, int iy, int ith,
                      //double &px, double &py, double &pth) const;
  bool PoseDiscToCont(int ix, int iy, int ith, int it,
                      double &px, double &py, double &pth, double &pt) const;

  virtual void PrintVars(){};

 protected:

  virtual int GetActionCost(int SourceX, int SourceY, int SourceTheta, envSIPPLatAction_t* action);

  void InitializeTimelineMap();
  bool UpdateTimelineMap();
  void FillInBubble(int CenterX, int CenterY, int T, int rad);
  void FillInBubbleColumn(int x, int topY, int botY, int T);
  void FillInBubbleCell(int x, int y, int T);

  void intervals2Timeline(int x, int y);
  int getInterval(int x, int y, int t);
  void getIntervals(vector<int>* intervals, vector<int>* times, envSIPPLatHashEntry_t* state, envSIPPLatAction_t* action);
  int getArrivalTimeToInterval(envSIPPLatHashEntry_t* state, envSIPPLatAction_t* action, int start_t, int end_t);
  virtual envSIPPLatHashEntry_t* getEntryFromID(int id) = 0;
  static bool pairCompare (pair<int,int> i, pair<int,int> j) { return (i.first<j.first); };

        //member data
        envSIPPLatConfig_t envSIPPLatCfg;
        EnvSIPPLat_t envSIPPLat;
        vector<SBPL_4Dcell_t> affectedsuccstatesV; //arrays of states whose outgoing actions cross cell 0,0
        vector<SBPL_4Dcell_t> affectedpredstatesV; //arrays of states whose incoming actions cross cell 0,0
        int iteration;
  vector<SBPL_DynamicObstacle_t> dynamicObstacles;
  vector< vector< vector<int> > > timelineMap;
  vector< vector< vector< pair<int,int> > > > intervalMap;
  int temporal_padding;

        //2D search for heuristic computations
        bool bNeedtoRecomputeStartHeuristics; //set whenever grid2Dsearchfromstart needs to be re-executed
        bool bNeedtoRecomputeGoalHeuristics; //set whenever grid2Dsearchfromgoal needs to be re-executed
        SBPL2DGridSearch* grid2Dsearchfromstart; //computes h-values that estimate distances from start x,y to all cells
        SBPL2DGridSearch* grid2Dsearchfromgoal;  //computes h-values that estimate distances to goal x,y from all cells

  //load dynamic obstacles
  void ReadDynamicObstacles(FILE* fDynObs);

        virtual void ReadConfiguration(FILE* fCfg);

        void InitializeEnvConfig(vector<SBPL_xythetasipp_mprimitive>* motionprimitiveV);


        bool CheckQuant(FILE* fOut);

        void SetConfiguration(int width, int height,
                              const unsigned char* mapdata,
                              int startx, int starty, int starttheta, int startTime,
                              int goalx, int goaly, int goaltheta,
                                  double cellsize_m, double timeResolution,
          double nominalvel_mpersecs, double timetoturn45degsinplace_secs, const vector<sbpl_2Dpt_t> & robot_perimeterV);
        
        bool InitGeneral( vector<SBPL_xythetasipp_mprimitive>* motionprimitiveV);
        void PrecomputeActionswithBaseMotionPrimitive(vector<SBPL_xythetasipp_mprimitive>* motionprimitiveV);
        void PrecomputeActionswithCompleteMotionPrimitive(vector<SBPL_xythetasipp_mprimitive>* motionprimitiveV);
        void PrecomputeActions();

        void CreateStartandGoalStates();

        virtual void InitializeEnvironment() = 0;

        void ComputeHeuristicValues();

        bool IsValidCell(int X, int Y);

        void CalculateFootprintForPose(SBPL_4Dpt_t pose, vector<SBPL_4Dcell_t>* footprint);
        void RemoveSourceFootprint(SBPL_4Dpt_t sourcepose, vector<SBPL_4Dcell_t>* footprint);

        //virtual void GetSuccs(int SourceStateID, vector<int>* SuccIDV, vector<int>* CostV, vector<envSIPPLatAction_t*>* actionindV=NULL) = 0;
  virtual void GetSuccs(int SourceStateID, vector<int>* SuccIDV, vector<int>* CostV, vector<envSIPPLatAction_t*>* actionV=NULL) = 0;

        double EuclideanDistance_m(int X1, int Y1, int X2, int Y2);

        void ComputeReplanningData();
        void ComputeReplanningDataforAction(envSIPPLatAction_t* action);

        bool ReadMotionPrimitives(FILE* fMotPrims);
  bool ReadinMotionPrimitive(SBPL_xythetasipp_mprimitive* pMotPrim, FILE* fIn, bool &isWaitMotion);
        int ReadinCell(SBPL_4Dcell_t* cell, char* fIn);
        int ReadinPose(SBPL_4Dpt_t* pose, char* fIn);

        void PrintHeuristicValues();

};


class EnvSIPPLat : public EnvSIPPLattice
{

 public:
  ~EnvSIPPLat();

  //int SetStart(double x, double y, double theta);
  int SetStart(double x, double y, double theta, double startTime);
  int SetGoal(double x, double y, double theta);
  void SetGoalTolerance(double tol_x, double tol_y, double tol_theta) {  }
  bool setDynamicObstacles(vector<SBPL_DynamicObstacle_t> dynObs, bool reset_states = true);
  void ClearStates();
  envSIPPLatHashEntry_t* getEntryFromID(int id);

  //void GetCoordFromState(int stateID, int& x, int& y, int& theta) const;
  void GetCoordFromState(int stateID, int& x, int& y, int& theta, int& t) const;
  //int GetStateFromCoord(int x, int y, int theta);
  int GetStateFromCoord(int x, int y, int theta, int t);

  //void PostProcess(vector<int>* states, vector<int>* cost);
  void ConvertStateIDPathintoXYThetaPath(vector<int>* stateIDPath, vector<SBPL_4Dpt_t>* xythetaPath); 
  void PrintState(int stateID, bool bVerbose, FILE* fOut=NULL);

  virtual void GetPreds(int TargetStateID, vector<int>* PredIDV, vector<int>* CostV);
  virtual void GetSuccs(int SourceStateID, vector<int>* SuccIDV, vector<int>* CostV, vector<envSIPPLatAction_t*>* actionV=NULL);

  void GetPredsofChangedEdges(vector<nav2dcell_t> const * changedcellsV, vector<int> *preds_of_changededgesIDV);
  void GetSuccsofChangedEdges(vector<nav2dcell_t> const * changedcellsV, vector<int> *succs_of_changededgesIDV);

  virtual void SetAllActionsandAllOutcomes(CMDPSTATE* state);

  virtual int  GetFromToHeuristic(int FromStateID, int ToStateID);
  virtual int  GetGoalHeuristic(int stateID);
  virtual int  GetStartHeuristic(int stateID);

  virtual int    SizeofCreatedEnv();

  virtual void PrintVars(){};


  void getExpansions(vector<SBPL_4Dpt_t>* p);
  void dumpStatesToFile();
  void dumpEnvironmentToFile();
  void dumpDynamicObstaclesToFile();
 protected:

  //hash table of size x_size*y_size. Maps from coords to stateId       
  int HashTableSize;
  vector<envSIPPLatHashEntry_t*>* Coord2StateIDHashTable;
  //vector that maps from stateID to coords     
  vector<envSIPPLatHashEntry_t*> StateID2CoordTable;

  unsigned int GETHASHBIN(unsigned int X, unsigned int Y, unsigned int Theta, unsigned int interval);

  envSIPPLatHashEntry_t* GetHashEntry(int X, int Y, int Theta, int interval, int T);
  envSIPPLatHashEntry_t* CreateNewHashEntry(int X, int Y, int Theta, int interval, int T);

  virtual void InitializeEnvironment();

  void PrintHashTableHist();

};


#endif

---

sbpl_dynamic_planner
Author(s): Michael Phillips, Maxim Likhachev
autogenerated on Fri Jan 11 09:41:03 2013