<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8"/>
<title>OMPL: ompl::base::GaussianValidStateSampler Class Reference</title>
<meta name="author" content="Ioan A. Șucan, Mark Moll, Lydia E. Kavraki">
<link rel="stylesheet" href="../css/screen.css" type="text/css" media="screen, projection">
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print">
<!--[if lt IE 7]>
<script type="text/javascript" src="../js/jquery/jquery.js"></script>
<script type="text/javascript" src="../js/jquery/jquery.dropdown.js"></script>
<![endif]-->
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-9156598-2']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search API');
--></script>
<div class="navigation" id="top">
<div class="tabs" id="ompltitle">
<ul class="tablist">
<li>The Open Motion Planning Library</li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search API" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<ul id="nav" class="dropdown">
<li class="first"><a href="index.html">Home</a></li>
<li><a href="download.html">Download</a></li>
<li><a href="documentation.html">Documentation</a></li>
<li><span class="dir">Code API</span>
<ul>
<li><a href="api_overview.html">API Overview</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="annotated.html">Classes</a></li>
<li><a href="files.html">Files</a></li>
<li><a href="dirs.html">Directories</a></li>
</ul>
</li>
<li><span class="dir">Community</span>
<ul>
<li><a href="developers.html">Developers</a></li>
<li><a href="thirdparty.html">Contributions</a></li>
<li><a href="education.html">Education</a></li>
<li><a href="gallery.html">Gallery</a></li>
</ul>
</li>
<li><span class="dir">About</span>
<ul>
<li><a href="license.html">License</a></li>
<li><a href="citations.html">Citations</a></li>
<li><a href="acknowledgements.html">Acknowledgments</a></li>
<li><a href="contact.html">Contact Us</a></li>
</ul>
</li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"name="MSearchResults" id="MSearchResults"></iframe>
</div>
<div class="container">
<div class="span-22 push-2 first last">
<div>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceompl.html">ompl</a> </li>
<li class="navelem"><a class="el" href="namespaceompl_1_1base.html">base</a> </li>
<li class="navelem"><a class="el" href="classompl_1_1base_1_1GaussianValidStateSampler.html">GaussianValidStateSampler</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">ompl::base::GaussianValidStateSampler Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="ompl::base::GaussianValidStateSampler" --><!-- doxytag: inherits="ompl::base::ValidStateSampler" -->
<p>Generate valid samples using the Gaussian sampling strategy.
<a href="classompl_1_1base_1_1GaussianValidStateSampler.html#details">More...</a></p>
<p><code>#include <<a class="el" href="GaussianValidStateSampler_8h_source.html">GaussianValidStateSampler.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ompl::base::GaussianValidStateSampler:</div>
<div class="dyncontent">
<div class="center"><img src="classompl_1_1base_1_1GaussianValidStateSampler__inherit__graph.png" border="0" usemap="#ompl_1_1base_1_1GaussianValidStateSampler_inherit__map" alt="Inheritance graph"/></div>
<map name="ompl_1_1base_1_1GaussianValidStateSampler_inherit__map" id="ompl_1_1base_1_1GaussianValidStateSampler_inherit__map">
<area shape="rect" id="node2" href="classompl_1_1base_1_1ValidStateSampler.html" title="Abstract definition of a state sampler." alt="" coords="32,5,235,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classompl_1_1base_1_1GaussianValidStateSampler-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1e86d2bbad84c0d6ef8f8ba1bd6e80f"></a><!-- doxytag: member="ompl::base::GaussianValidStateSampler::GaussianValidStateSampler" ref="ac1e86d2bbad84c0d6ef8f8ba1bd6e80f" args="(const SpaceInformation *si)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1GaussianValidStateSampler.html#ac1e86d2bbad84c0d6ef8f8ba1bd6e80f">GaussianValidStateSampler</a> (const <a class="el" href="classompl_1_1base_1_1SpaceInformation.html">SpaceInformation</a> *si)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ba42cec0b1ba4b2f272bc70ddddde97"></a><!-- doxytag: member="ompl::base::GaussianValidStateSampler::sample" ref="a6ba42cec0b1ba4b2f272bc70ddddde97" args="(State *state)" -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1GaussianValidStateSampler.html#a6ba42cec0b1ba4b2f272bc70ddddde97">sample</a> (<a class="el" href="classompl_1_1base_1_1State.html">State</a> *state)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sample a state. Return false in case of failure. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1GaussianValidStateSampler.html#afc6097a6245bc5ef69f4b64cc9c2a9cc">sampleNear</a> (<a class="el" href="classompl_1_1base_1_1State.html">State</a> *state, const <a class="el" href="classompl_1_1base_1_1State.html">State</a> *near, const double distance)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sample a state near another, within specified distance. Return false, in case of failure. <a href="#afc6097a6245bc5ef69f4b64cc9c2a9cc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf954d108110f80996e4c67dd3f7267a"></a><!-- doxytag: member="ompl::base::GaussianValidStateSampler::getStdDev" ref="aaf954d108110f80996e4c67dd3f7267a" args="(void) const " -->
double </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1GaussianValidStateSampler.html#aaf954d108110f80996e4c67dd3f7267a">getStdDev</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the standard deviation used when sampling. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa82bfdfce3b00d6ea22a02c570356588"></a><!-- doxytag: member="ompl::base::GaussianValidStateSampler::setStdDev" ref="aa82bfdfce3b00d6ea22a02c570356588" args="(double stddev)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1GaussianValidStateSampler.html#aa82bfdfce3b00d6ea22a02c570356588">setStdDev</a> (double stddev)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the standard deviation to use when sampling. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48a0f8607cf0581ad8e991b49cf494f5"></a><!-- doxytag: member="ompl::base::GaussianValidStateSampler::sampler_" ref="a48a0f8607cf0581ad8e991b49cf494f5" args="" -->
<a class="el" href="classompl_1_1base_1_1StateSamplerPtr.html">StateSamplerPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1GaussianValidStateSampler.html#a48a0f8607cf0581ad8e991b49cf494f5">sampler_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The sampler to build upon. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8ba0b055b4a9c2c1bf1809b5fff577b8"></a><!-- doxytag: member="ompl::base::GaussianValidStateSampler::stddev_" ref="a8ba0b055b4a9c2c1bf1809b5fff577b8" args="" -->
double </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1GaussianValidStateSampler.html#a8ba0b055b4a9c2c1bf1809b5fff577b8">stddev_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The standard deviation to use in the sampling process. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Generate valid samples using the Gaussian sampling strategy. </p>
<p>Definition at line <a class="el" href="GaussianValidStateSampler_8h_source.html#l00049">49</a> of file <a class="el" href="GaussianValidStateSampler_8h_source.html">GaussianValidStateSampler.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afc6097a6245bc5ef69f4b64cc9c2a9cc"></a><!-- doxytag: member="ompl::base::GaussianValidStateSampler::sampleNear" ref="afc6097a6245bc5ef69f4b64cc9c2a9cc" args="(State *state, const State *near, const double distance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ompl::base::GaussianValidStateSampler::sampleNear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classompl_1_1base_1_1State.html">State</a> * </td>
<td class="paramname"><em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classompl_1_1base_1_1State.html">State</a> * </td>
<td class="paramname"><em>near</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double </td>
<td class="paramname"><em>distance</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sample a state near another, within specified distance. Return false, in case of failure. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>The memory for <em>near</em> must be disjoint from the memory for <em>state</em> </dd></dl>
<p>Implements <a class="el" href="classompl_1_1base_1_1ValidStateSampler.html#a86a022797e62aa7953d5381f0109c6a2">ompl::base::ValidStateSampler</a>.</p>
<p>Definition at line <a class="el" href="GaussianValidStateSampler_8cpp_source.html#l00070">70</a> of file <a class="el" href="GaussianValidStateSampler_8cpp_source.html">GaussianValidStateSampler.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/ompl/base/samplers/<a class="el" href="GaussianValidStateSampler_8h_source.html">GaussianValidStateSampler.h</a></li>
<li>src/ompl/base/samplers/src/<a class="el" href="GaussianValidStateSampler_8cpp_source.html">GaussianValidStateSampler.cpp</a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div>
<div class="footer span-22 push-2 last">
<a href="http://www.kavrakilab.org">Physical and Biological Computing Group</a> •
<a href="http://www.cs.rice.edu">Department of Computer Science</a> •
<a href="http://www.rice.edu">Rice University</a><br>
<div class="gray">Generated on Sun Oct 9 2011 23:04:31 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.7.4</div>
</div>
</div>
</body>
</html>
