ompl::geometric::pRRT Class Reference

#include <pRRT.h>

Inheritance diagram for ompl::geometric::pRRT:

Classes
class	Motion
struct	SolutionInfo
Public Member Functions
virtual void	clear (void)
	Clear all internal datastructures. Planner settings are not affected. Subsequent calls to solve() will ignore all previous work.
double	getGoalBias (void) const
	Get the goal bias the planner is using.
virtual void	getPlannerData (base::PlannerData &data) const
	Get information about the current run of the motion planner. Repeated calls to this function will update data (only additions are made). This is useful to see what changed in the exploration datastructure, between calls to solve(), for example (without calling clear() in between).
double	getRange (void) const
	Get the range the planner is using.
unsigned int	getThreadCount (void) const
	pRRT (const base::SpaceInformationPtr &si)
void	setGoalBias (double goalBias)
	Set the goal bias.
template<template< typename T > class NN>
void	setNearestNeighbors (void)
	Set a different nearest neighbors datastructure.
void	setRange (double distance)
	Set the range the planner is supposed to use.
void	setThreadCount (unsigned int nthreads)
	Set the number of threads the planner should use. Default is 2.
virtual void	setup (void)
	Perform extra configuration steps, if needed. This call will also issue a call to ompl::base::SpaceInformation::setup() if needed. This must be called before solving.
virtual bool	solve (const base::PlannerTerminationCondition &ptc)
	Function that can solve the motion planning problem. This function can be called multiple times on the same problem, without calling clear() in between. This allows the planner to continue work more time on an unsolved problem, for example. If this option is used, it is assumed the problem definition is not changed (unpredictable results otherwise). The only change in the problem definition that is accounted for is the addition of starting or goal states (but not changing previously added start/goal states). The function terminates if the call to ptc returns true.
virtual	~pRRT (void)
Protected Member Functions
double	distanceFunction (const Motion a, const Motion b) const
void	freeMemory (void)
void	threadSolve (unsigned int tid, const base::PlannerTerminationCondition &ptc, SolutionInfo *sol)
Protected Attributes
double	goalBias_
double	maxDistance_
boost::shared_ptr < NearestNeighbors< Motion * > >	nn_
boost::mutex	nnLock_
base::StateSamplerArray < base::StateSampler >	samplerArray_
unsigned int	threadCount_

Detailed Description

Parallel RRT.

Short description: RRT is a tree-based motion planner that uses the following idea: RRT samples a random state qr in the state space, then finds the state qc among the previously seen states that is closest to qr and expands from qc towards qr, until a state qm is reached. qm is then added to the exploration tree.

External documentation: J. Kuffner and S.M. LaValle, RRT-connect: An efficient approach to single-query path planning, in Proc. 2000 IEEE Intl. Conf. on Robotics and Automation, pp. 995–1001, Apr. 2000. DOI: 10.1109/ROBOT.2000.844730
[PDF] [more]

Definition at line 62 of file pRRT.h.

Constructor & Destructor Documentation

ompl::geometric::pRRT::pRRT ( const base::SpaceInformationPtr & si ) [inline]

Definition at line 45 of file pRRT.h.

virtual ompl::geometric::pRRT::~pRRT ( void ) [inline, virtual]

Definition at line 55 of file pRRT.h.

Member Function Documentation

virtual void ompl::geometric::pRRT::clear ( void ) [virtual]

Clear all internal datastructures. Planner settings are not affected. Subsequent calls to solve() will ignore all previous work.

Reimplemented from ompl::base::Planner.

double ompl::geometric::pRRT::distanceFunction	(	const Motion *	a,
		const Motion *	b
	)			const `[inline, protected]`

Definition at line 153 of file pRRT.h.

void ompl::geometric::pRRT::freeMemory ( void ) [protected]

double ompl::geometric::pRRT::getGoalBias ( void ) const [inline]

Get the goal bias the planner is using.

Definition at line 81 of file pRRT.h.

virtual void ompl::geometric::pRRT::getPlannerData ( base::PlannerData & data ) const [virtual]

Get information about the current run of the motion planner. Repeated calls to this function will update data (only additions are made). This is useful to see what changed in the exploration datastructure, between calls to solve(), for example (without calling clear() in between).

Reimplemented from ompl::base::Planner.

double ompl::geometric::pRRT::getRange ( void ) const [inline]

Get the range the planner is using.

Definition at line 97 of file pRRT.h.

unsigned int ompl::geometric::pRRT::getThreadCount ( void ) const [inline]

Definition at line 105 of file pRRT.h.

void ompl::geometric::pRRT::setGoalBias ( double goalBias ) [inline]

Set the goal bias.

In the process of randomly selecting states in the state space to attempt to go towards, the algorithm may in fact choose the actual goal state, if it knows it, with some probability. This probability is a real number between 0.0 and 1.0; its value should usually be around 0.05 and should not be too large. It is probably a good idea to use the default value.

Definition at line 75 of file pRRT.h.

template<template< typename T > class NN>

void ompl::geometric::pRRT::setNearestNeighbors ( void ) [inline]

Set a different nearest neighbors datastructure.

Definition at line 112 of file pRRT.h.

void ompl::geometric::pRRT::setRange ( double distance ) [inline]

Set the range the planner is supposed to use.

This parameter greatly influences the runtime of the algorithm. It represents the maximum length of a motion to be added in the tree of motions.

Definition at line 91 of file pRRT.h.

void ompl::geometric::pRRT::setThreadCount ( unsigned int nthreads )

Set the number of threads the planner should use. Default is 2.

virtual void ompl::geometric::pRRT::setup ( void ) [virtual]

Perform extra configuration steps, if needed. This call will also issue a call to ompl::base::SpaceInformation::setup() if needed. This must be called before solving.

Reimplemented from ompl::base::Planner.

virtual bool ompl::geometric::pRRT::solve ( const base::PlannerTerminationCondition & ptc ) [virtual]

Function that can solve the motion planning problem. This function can be called multiple times on the same problem, without calling clear() in between. This allows the planner to continue work more time on an unsolved problem, for example. If this option is used, it is assumed the problem definition is not changed (unpredictable results otherwise). The only change in the problem definition that is accounted for is the addition of starting or goal states (but not changing previously added start/goal states). The function terminates if the call to ptc returns true.

Implements ompl::base::Planner.