24navigation/install/octomap-distribution/include/dynamicEDT3D/dynamicEDT3D.h

152 lines
5.1 KiB
C++

/**
* dynamicEDT3D:
* A library for incrementally updatable Euclidean distance transforms in 3D.
* @author C. Sprunk, B. Lau, W. Burgard, University of Freiburg, Copyright (C) 2011.
* @see http://octomap.sourceforge.net/
* License: New BSD License
*/
/*
* Copyright (c) 2011-2012, C. Sprunk, B. Lau, W. Burgard, University of Freiburg
* 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 Freiburg 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 _DYNAMICEDT3D_H_
#define _DYNAMICEDT3D_H_
#include <limits.h>
#include <queue>
#include "bucketedqueue.h"
//! A DynamicEDT3D object computes and updates a 3D distance map.
class DynamicEDT3D {
public:
DynamicEDT3D(int _maxdist_squared);
~DynamicEDT3D();
//! Initialization with an empty map
void initializeEmpty(int _sizeX, int _sizeY, int sizeZ, bool initGridMap=true);
//! Initialization with a given binary map (false==free, true==occupied)
void initializeMap(int _sizeX, int _sizeY, int sizeZ, bool*** _gridMap);
//! add an obstacle at the specified cell coordinate
void occupyCell(int x, int y, int z);
//! remove an obstacle at the specified cell coordinate
void clearCell(int x, int y, int z);
//! remove old dynamic obstacles and add the new ones
void exchangeObstacles(std::vector<INTPOINT3D> newObstacles);
//! update distance map to reflect the changes
virtual void update(bool updateRealDist=true);
//! returns the obstacle distance at the specified location
float getDistance( int x, int y, int z ) const;
//! gets the closest occupied cell for that location
INTPOINT3D getClosestObstacle( int x, int y, int z ) const;
//! returns the squared obstacle distance in cell units at the specified location
int getSQCellDistance( int x, int y, int z ) const;
//! checks whether the specficied location is occupied
bool isOccupied(int x, int y, int z) const;
//! returns the x size of the workspace/map
unsigned int getSizeX() const {return sizeX;}
//! returns the y size of the workspace/map
unsigned int getSizeY() const {return sizeY;}
//! returns the z size of the workspace/map
unsigned int getSizeZ() const {return sizeZ;}
typedef enum {invalidObstData = INT_MAX} ObstDataState;
///distance value returned when requesting distance for a cell outside the map
static float distanceValue_Error;
///distance value returned when requesting distance in cell units for a cell outside the map
static int distanceInCellsValue_Error;
protected:
struct dataCell {
float dist;
int obstX;
int obstY;
int obstZ;
int sqdist;
char queueing;
bool needsRaise;
};
typedef enum {free=0, occupied=1} State;
typedef enum {fwNotQueued=1, fwQueued=2, fwProcessed=3, bwQueued=4, bwProcessed=1} QueueingState;
// methods
inline void raiseCell(INTPOINT3D &p, dataCell &c, bool updateRealDist);
inline void propagateCell(INTPOINT3D &p, dataCell &c, bool updateRealDist);
inline void inspectCellRaise(int &nx, int &ny, int &nz, bool updateRealDist);
inline void inspectCellPropagate(int &nx, int &ny, int &nz, dataCell &c, bool updateRealDist);
void setObstacle(int x, int y, int z);
void removeObstacle(int x, int y, int z);
private:
void commitAndColorize(bool updateRealDist=true);
inline bool isOccupied(int &x, int &y, int &z, dataCell &c);
// queues
BucketPrioQueue<INTPOINT3D> open;
std::vector<INTPOINT3D> removeList;
std::vector<INTPOINT3D> addList;
std::vector<INTPOINT3D> lastObstacles;
// maps
protected:
int sizeX;
int sizeY;
int sizeZ;
int sizeXm1;
int sizeYm1;
int sizeZm1;
dataCell*** data;
bool*** gridMap;
// parameters
int padding;
double doubleThreshold;
double sqrt2;
double maxDist;
int maxDist_squared;
};
#endif