Merge pull request #124 from jGaboardi/refresh_docs

refreshing documentation

doc/_build/html/_sources/api.rst.txt

@@ -20,6 +20,7 @@ spaghetti.Network
     Network.distancebandweights
     Network.snapobservations
     Network.compute_distance_to_nodes
+    Network.compute_snap_dist
     Network.count_per_edge
     Network.simulate_observations
     Network.enum_links_node

doc/_build/html/_sources/generated/spaghetti.Network.compute_snap_dist.rst.txt

@@ -0,0 +1,6 @@
+spaghetti.Network.compute\_snap\_dist
+=====================================
+
+.. currentmodule:: spaghetti
+
+.. automethod:: Network.compute_snap_dist

doc/_build/html/api.html

@@ -159,40 +159,43 @@
 <tr class="row-even"><td><a class="reference internal" href="generated/spaghetti.Network.compute_distance_to_nodes.html#spaghetti.Network.compute_distance_to_nodes" title="spaghetti.Network.compute_distance_to_nodes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.compute_distance_to_nodes</span></code></a>(x,&nbsp;y,&nbsp;edge)</td>
 <td>Given an observation on a network edge, return the distance to the two nodes that bound that end.</td>
 </tr>
-<tr class="row-odd"><td><a class="reference internal" href="generated/spaghetti.Network.count_per_edge.html#spaghetti.Network.count_per_edge" title="spaghetti.Network.count_per_edge"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.count_per_edge</span></code></a>(obs_on_network[,&nbsp;graph])</td>
+<tr class="row-odd"><td><a class="reference internal" href="generated/spaghetti.Network.compute_snap_dist.html#spaghetti.Network.compute_snap_dist" title="spaghetti.Network.compute_snap_dist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.compute_snap_dist</span></code></a>(pattern,&nbsp;idx)</td>
+<td>Given an observation snapped to a network edge, calculate the distance from the original location to the snapped location.</td>
+</tr>
+<tr class="row-even"><td><a class="reference internal" href="generated/spaghetti.Network.count_per_edge.html#spaghetti.Network.count_per_edge" title="spaghetti.Network.count_per_edge"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.count_per_edge</span></code></a>(obs_on_network[,&nbsp;graph])</td>
 <td>Compute the counts per edge.</td>
 </tr>
-<tr class="row-even"><td><a class="reference internal" href="generated/spaghetti.Network.simulate_observations.html#spaghetti.Network.simulate_observations" title="spaghetti.Network.simulate_observations"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.simulate_observations</span></code></a>(count[,&nbsp;…])</td>
+<tr class="row-odd"><td><a class="reference internal" href="generated/spaghetti.Network.simulate_observations.html#spaghetti.Network.simulate_observations" title="spaghetti.Network.simulate_observations"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.simulate_observations</span></code></a>(count[,&nbsp;…])</td>
 <td>Generate a simulated point pattern on the network.</td>
 </tr>
-<tr class="row-odd"><td><a class="reference internal" href="generated/spaghetti.Network.enum_links_node.html#spaghetti.Network.enum_links_node" title="spaghetti.Network.enum_links_node"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.enum_links_node</span></code></a>(v0)</td>
+<tr class="row-even"><td><a class="reference internal" href="generated/spaghetti.Network.enum_links_node.html#spaghetti.Network.enum_links_node" title="spaghetti.Network.enum_links_node"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.enum_links_node</span></code></a>(v0)</td>
 <td>Returns the edges (links) around node.</td>
 </tr>
-<tr class="row-even"><td><a class="reference internal" href="generated/spaghetti.Network.node_distance_matrix.html#spaghetti.Network.node_distance_matrix" title="spaghetti.Network.node_distance_matrix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.node_distance_matrix</span></code></a>(n_processes[,&nbsp;…])</td>
+<tr class="row-odd"><td><a class="reference internal" href="generated/spaghetti.Network.node_distance_matrix.html#spaghetti.Network.node_distance_matrix" title="spaghetti.Network.node_distance_matrix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.node_distance_matrix</span></code></a>(n_processes[,&nbsp;…])</td>
 <td>Called from within allneighbordistances(), nearestneighbordistances(), and distancebandweights().</td>
 </tr>
-<tr class="row-odd"><td><a class="reference internal" href="generated/spaghetti.Network.allneighbordistances.html#spaghetti.Network.allneighbordistances" title="spaghetti.Network.allneighbordistances"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.allneighbordistances</span></code></a>(sourcepattern)</td>
+<tr class="row-even"><td><a class="reference internal" href="generated/spaghetti.Network.allneighbordistances.html#spaghetti.Network.allneighbordistances" title="spaghetti.Network.allneighbordistances"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.allneighbordistances</span></code></a>(sourcepattern)</td>
 <td>Compute either all distances between i and j in a single point pattern or all distances between each i from a source pattern and all j from a destination pattern.</td>
 </tr>
-<tr class="row-even"><td><a class="reference internal" href="generated/spaghetti.Network.nearestneighbordistances.html#spaghetti.Network.nearestneighbordistances" title="spaghetti.Network.nearestneighbordistances"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.nearestneighbordistances</span></code></a>(sourcepattern)</td>
+<tr class="row-odd"><td><a class="reference internal" href="generated/spaghetti.Network.nearestneighbordistances.html#spaghetti.Network.nearestneighbordistances" title="spaghetti.Network.nearestneighbordistances"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.nearestneighbordistances</span></code></a>(sourcepattern)</td>
 <td>Compute the interpattern nearest neighbor distances or the intrapattern nearest neighbor distances between a source pattern and a destination pattern.</td>
 </tr>
-<tr class="row-odd"><td><a class="reference internal" href="generated/spaghetti.Network.NetworkF.html#spaghetti.Network.NetworkF" title="spaghetti.Network.NetworkF"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.NetworkF</span></code></a>(pointpattern[,&nbsp;nsteps,&nbsp;…])</td>
+<tr class="row-even"><td><a class="reference internal" href="generated/spaghetti.Network.NetworkF.html#spaghetti.Network.NetworkF" title="spaghetti.Network.NetworkF"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.NetworkF</span></code></a>(pointpattern[,&nbsp;nsteps,&nbsp;…])</td>
 <td>Computes a network constrained F-Function</td>
 </tr>
-<tr class="row-even"><td><a class="reference internal" href="generated/spaghetti.Network.NetworkG.html#spaghetti.Network.NetworkG" title="spaghetti.Network.NetworkG"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.NetworkG</span></code></a>(pointpattern[,&nbsp;nsteps,&nbsp;…])</td>
+<tr class="row-odd"><td><a class="reference internal" href="generated/spaghetti.Network.NetworkG.html#spaghetti.Network.NetworkG" title="spaghetti.Network.NetworkG"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.NetworkG</span></code></a>(pointpattern[,&nbsp;nsteps,&nbsp;…])</td>
 <td>Computes a network constrained G-Function</td>
 </tr>
-<tr class="row-odd"><td><a class="reference internal" href="generated/spaghetti.Network.NetworkK.html#spaghetti.Network.NetworkK" title="spaghetti.Network.NetworkK"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.NetworkK</span></code></a>(pointpattern[,&nbsp;nsteps,&nbsp;…])</td>
+<tr class="row-even"><td><a class="reference internal" href="generated/spaghetti.Network.NetworkK.html#spaghetti.Network.NetworkK" title="spaghetti.Network.NetworkK"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.NetworkK</span></code></a>(pointpattern[,&nbsp;nsteps,&nbsp;…])</td>
 <td>Computes a network constrained K-Function</td>
 </tr>
-<tr class="row-even"><td><a class="reference internal" href="generated/spaghetti.Network.segment_edges.html#spaghetti.Network.segment_edges" title="spaghetti.Network.segment_edges"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.segment_edges</span></code></a>(distance)</td>
+<tr class="row-odd"><td><a class="reference internal" href="generated/spaghetti.Network.segment_edges.html#spaghetti.Network.segment_edges" title="spaghetti.Network.segment_edges"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.segment_edges</span></code></a>(distance)</td>
 <td>Segment all of the edges in the network at either a</td>
 </tr>
-<tr class="row-odd"><td><a class="reference internal" href="generated/spaghetti.Network.savenetwork.html#spaghetti.Network.savenetwork" title="spaghetti.Network.savenetwork"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.savenetwork</span></code></a>(filename)</td>
+<tr class="row-even"><td><a class="reference internal" href="generated/spaghetti.Network.savenetwork.html#spaghetti.Network.savenetwork" title="spaghetti.Network.savenetwork"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.savenetwork</span></code></a>(filename)</td>
 <td>Save a network to disk as a binary file.</td>
 </tr>
-<tr class="row-even"><td><a class="reference internal" href="generated/spaghetti.Network.loadnetwork.html#spaghetti.Network.loadnetwork" title="spaghetti.Network.loadnetwork"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.loadnetwork</span></code></a>(filename)</td>
+<tr class="row-odd"><td><a class="reference internal" href="generated/spaghetti.Network.loadnetwork.html#spaghetti.Network.loadnetwork" title="spaghetti.Network.loadnetwork"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Network.loadnetwork</span></code></a>(filename)</td>
 <td>Load a network from a binary file saved on disk.</td>
 </tr>
 </tbody>

doc/_build/html/generated/spaghetti.Network.allneighbordistances.html

@@ -125,7 +125,7 @@
 <h1>spaghetti.Network.allneighbordistances<a class="headerlink" href="#spaghetti-network-allneighbordistances" title="Permalink to this headline">¶</a></h1>
 <dl class="method">
 <dt id="spaghetti.Network.allneighbordistances">
-<code class="descclassname">Network.</code><code class="descname">allneighbordistances</code><span class="sig-paren">(</span><em>sourcepattern</em>, <em>destpattern=None</em>, <em>fill_diagonal=None</em>, <em>n_processes=None</em>, <em>gen_tree=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/spaghetti/network.html#Network.allneighbordistances"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#spaghetti.Network.allneighbordistances" title="Permalink to this definition">¶</a></dt>
+<code class="descclassname">Network.</code><code class="descname">allneighbordistances</code><span class="sig-paren">(</span><em>sourcepattern</em>, <em>destpattern=None</em>, <em>fill_diagonal=None</em>, <em>n_processes=None</em>, <em>gen_tree=False</em>, <em>snap_dist=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/spaghetti/network.html#Network.allneighbordistances"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#spaghetti.Network.allneighbordistances" title="Permalink to this definition">¶</a></dt>
 <dd><p>Compute either all distances between i and j in a single point
 pattern or all distances between each i from a source pattern and all
 j from a destination pattern.</p>
@@ -155,6 +155,10 @@ <h1>spaghetti.Network.allneighbordistances<a class="headerlink" href="#spaghetti
 <dt><strong>gen_tree</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
 <dd><p class="first last">rebuild shortest path {True}, or skip {False}</p>
 </dd>
+<dt><strong>snap_dist</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
+<dd><p class="first last">include the distance from the original location to the snapped
+location along the network. Default is False.</p>
+</dd>
 </dl>
 </td>
 </tr>

doc/_build/html/generated/spaghetti.Network.compute_distance_to_nodes.html

@@ -20,7 +20,7 @@
     <link rel="shortcut icon" href="../_static/pysal_favicon.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="spaghetti.Network.contiguityweights" href="spaghetti.Network.contiguityweights.html" />
+    <link rel="next" title="spaghetti.Network.compute_snap_dist" href="spaghetti.Network.compute_snap_dist.html" />
     <link rel="prev" title="spaghetti.Network.allneighbordistances" href="spaghetti.Network.allneighbordistances.html" />
 <meta charset='utf-8'>
 <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>