libs/geometry/doc/doxy/doxygen_output/html_by_doxygen/group__simplify.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   5 <title>Boost.Geometry (aka GGL, Generic Geometry Library)</title>
   6 <link href="doxygen.css" rel="stylesheet" type="text/css">
   7 <link href="tabs.css" rel="stylesheet" type="text/css">
   8 </head>
   9 <table cellpadding="2" width="100%">
  10 <tbody>
  11 <tr>
  12 <td valign="top">
  13 <img alt="Boost.Geometry" src="images/ggl-logo-big.png" height="80" width="200">
  14 &nbsp;&nbsp;
  15 </td>
  16 <td valign="top" align="right">
  17 <a href="http://www.boost.org">
  18 <img alt="Boost C++ Libraries" src="images/accepted_by_boost.png" height="80" width="230" border="0">
  19 </a>
  20 </td>
  21 </tr>
  22 </tbody>
  23 </table>
  24 <!-- Generated by Doxygen 1.8.6 -->
  25   <div id="navrow1" class="tabs">
  26     <ul class="tablist">
  27       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  28       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  29       <li><a href="modules.html"><span>Modules</span></a></li>
  30       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  31       <li><a href="annotated.html"><span>Classes</span></a></li>
  32       <li><a href="files.html"><span>Files</span></a></li>
  33       <li><a href="examples.html"><span>Examples</span></a></li>
  34     </ul>
  35   </div>
  36 </div><!-- top -->
  37 <div class="header">
  38   <div class="summary">
  39 <a href="#nested-classes">Classes</a> &#124;
  40 <a href="#func-members">Functions</a>  </div>
  41   <div class="headertitle">
  42 <div class="title">simplify: remove points from a geometry, keeping shape (simplification or generalization)</div>  </div>
  43 </div><!--header-->
  44 <div class="contents">
  45 <table class="memberdecls">
  46 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  47 Classes</h2></td></tr>
  48 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1geometry_1_1concepts_1_1_simplify_strategy.html">boost::geometry::concepts::SimplifyStrategy&lt; Strategy, Point &gt;</a></td></tr>
  49 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks strategy for simplify.  <a href="structboost_1_1geometry_1_1concepts_1_1_simplify_strategy.html#details">More...</a><br/></td></tr>
  50 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51 </table><table class="memberdecls">
  52 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  53 Functions</h2></td></tr>
  54 <tr class="memitem:ga8f1c13c0fe844ffdaa6196ce3854849f"><td class="memTemplParams" colspan="2">template&lt;typename Geometry , typename Distance , typename Strategy &gt; </td></tr>
  55 <tr class="memitem:ga8f1c13c0fe844ffdaa6196ce3854849f"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__simplify.html#ga8f1c13c0fe844ffdaa6196ce3854849f">boost::geometry::simplify</a> (Geometry const &amp;geometry, Geometry &amp;out, Distance const &amp;max_distance, Strategy const &amp;strategy)</td></tr>
  56 <tr class="memdesc:ga8f1c13c0fe844ffdaa6196ce3854849f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simplify a geometry using a specified strategy.  <a href="#ga8f1c13c0fe844ffdaa6196ce3854849f">More...</a><br/></td></tr>
  57 <tr class="separator:ga8f1c13c0fe844ffdaa6196ce3854849f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58 <tr class="memitem:ga7f1ed83b2a595dc644205374eddf0057"><td class="memTemplParams" colspan="2">template&lt;typename Geometry , typename Distance &gt; </td></tr>
  59 <tr class="memitem:ga7f1ed83b2a595dc644205374eddf0057"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__simplify.html#ga7f1ed83b2a595dc644205374eddf0057">boost::geometry::simplify</a> (Geometry const &amp;geometry, Geometry &amp;out, Distance const &amp;max_distance)</td></tr>
  60 <tr class="memdesc:ga7f1ed83b2a595dc644205374eddf0057"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simplify a geometry.  <a href="#ga7f1ed83b2a595dc644205374eddf0057">More...</a><br/></td></tr>
  61 <tr class="separator:ga7f1ed83b2a595dc644205374eddf0057"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62 </table>
  63 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  64 <h2 class="groupheader">Function Documentation</h2>
  65 <a class="anchor" id="ga8f1c13c0fe844ffdaa6196ce3854849f"></a>
  66 <div class="memitem">
  67 <div class="memproto">
  68 <div class="memtemplate">
  69 template&lt;typename Geometry , typename Distance , typename Strategy &gt; </div>
  70       <table class="memname">
  71         <tr>
  72           <td class="memname">void boost::geometry::simplify </td>
  73           <td>(</td>
  74           <td class="paramtype">Geometry const &amp;&#160;</td>
  75           <td class="paramname"><em>geometry</em>, </td>
  76         </tr>
  77         <tr>
  78           <td class="paramkey"></td>
  79           <td></td>
  80           <td class="paramtype">Geometry &amp;&#160;</td>
  81           <td class="paramname"><em>out</em>, </td>
  82         </tr>
  83         <tr>
  84           <td class="paramkey"></td>
  85           <td></td>
  86           <td class="paramtype">Distance const &amp;&#160;</td>
  87           <td class="paramname"><em>max_distance</em>, </td>
  88         </tr>
  89         <tr>
  90           <td class="paramkey"></td>
  91           <td></td>
  92           <td class="paramtype">Strategy const &amp;&#160;</td>
  93           <td class="paramname"><em>strategy</em>&#160;</td>
  94         </tr>
  95         <tr>
  96           <td></td>
  97           <td>)</td>
  98           <td></td><td></td>
  99         </tr>
 100       </table>
 101 </div><div class="memdoc">
 102
 103 <p>Simplify a geometry using a specified strategy. </p>
 104 <dl class="tparams"><dt>Template Parameters</dt><dd>
 105   <table class="tparams">
 106     <tr><td class="paramname">Geometry</td><td>Any type fulfilling a Geometry Concept </td></tr>
 107     <tr><td class="paramname">Distance</td><td>A numerical distance measure </td></tr>
 108     <tr><td class="paramname">Strategy</td><td>A type fulfilling a SimplifyStrategy concept </td></tr>
 109   </table>
 110   </dd>
 111 </dl>
 112 <dl class="params"><dt>Parameters</dt><dd>
 113   <table class="params">
 114     <tr><td class="paramname">strategy</td><td>A strategy to calculate simplification </td></tr>
 115     <tr><td class="paramname">geometry</td><td>input geometry, to be simplified </td></tr>
 116     <tr><td class="paramname">out</td><td>output geometry, simplified version of the input geometry </td></tr>
 117     <tr><td class="paramname">max_distance</td><td>distance (in units of input coordinates) of a vertex to other segments to be removed </td></tr>
 118     <tr><td class="paramname">strategy</td><td>simplify strategy to be used for simplification, might include point-distance strategy</td></tr>
 119   </table>
 120   </dd>
 121 </dl>
 122 <div class="image">
 123 <img src="svg_simplify_country.png" alt="svg_simplify_country.png"/>
 124 <div class="caption">
 125 The image below presents the simplified country</div></div>
 126  <dl><dt><b>Examples: </b></dt><dd><a class="el" href="02_linestring_example_8cpp-example.html#a15">02_linestring_example.cpp</a>.</dd>
 127 </dl>
 128 </div>
 129 </div>
 130 <a class="anchor" id="ga7f1ed83b2a595dc644205374eddf0057"></a>
 131 <div class="memitem">
 132 <div class="memproto">
 133 <div class="memtemplate">
 134 template&lt;typename Geometry , typename Distance &gt; </div>
 135       <table class="memname">
 136         <tr>
 137           <td class="memname">void boost::geometry::simplify </td>
 138           <td>(</td>
 139           <td class="paramtype">Geometry const &amp;&#160;</td>
 140           <td class="paramname"><em>geometry</em>, </td>
 141         </tr>
 142         <tr>
 143           <td class="paramkey"></td>
 144           <td></td>
 145           <td class="paramtype">Geometry &amp;&#160;</td>
 146           <td class="paramname"><em>out</em>, </td>
 147         </tr>
 148         <tr>
 149           <td class="paramkey"></td>
 150           <td></td>
 151           <td class="paramtype">Distance const &amp;&#160;</td>
 152           <td class="paramname"><em>max_distance</em>&#160;</td>
 153         </tr>
 154         <tr>
 155           <td></td>
 156           <td>)</td>
 157           <td></td><td></td>
 158         </tr>
 159       </table>
 160 </div><div class="memdoc">
 161
 162 <p>Simplify a geometry. </p>
 163 <dl class="tparams"><dt>Template Parameters</dt><dd>
 164   <table class="tparams">
 165     <tr><td class="paramname">Geometry</td><td>Any type fulfilling a Geometry Concept </td></tr>
 166     <tr><td class="paramname">Distance</td><td>numerical type (int, double, ttmath, ...) </td></tr>
 167   </table>
 168   </dd>
 169 </dl>
 170 <dl class="section note"><dt>Note</dt><dd>This version of simplify simplifies a geometry using the default strategy (Douglas Peucker), </dd></dl>
 171 <dl class="params"><dt>Parameters</dt><dd>
 172   <table class="params">
 173     <tr><td class="paramname">geometry</td><td>input geometry, to be simplified </td></tr>
 174     <tr><td class="paramname">out</td><td>output geometry, simplified version of the input geometry </td></tr>
 175     <tr><td class="paramname">max_distance</td><td>distance (in units of input coordinates) of a vertex to other segments to be removed</td></tr>
 176   </table>
 177   </dd>
 178 </dl>
 179
 180 </div>
 181 </div>
 182 </div><!-- contents -->
 183 <hr size="1">
 184 <table width="100%">
 185 <tbody>
 186 <tr>
 187 <td align="left"><small>
 188 <p>April 2, 2011</p>
 189 </small></td>
 190 <td align="right">
 191 <small>
 192 Copyright &copy; 2007-2011 Barend Gehrels, Amsterdam, the Netherlands<br>
 193 Copyright &copy; 2008-2011 Bruno Lalande, Paris, France<br>
 194 Copyright &copy; 2009-2010 Mateusz Loskot, London, UK<br>
 195 </small>
 196 </td>
 197 </tr>
 198 </tbody>
 199 </table>
 200 <address style="text-align: right;"><small>
 201 Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
 202 </small></address>
 203 </body>
 204 </html>