Change how the docstring is worded.

This commit is contained in:
Vighnesh Birodkar
2016-06-28 21:34:35 -04:00
parent bc11ca8a24
commit 5a78719a40
2 changed files with 6 additions and 6 deletions
@@ -10,7 +10,7 @@ The regions with the lowest edge weights are successively merged until there
is no edge with weight less than ``thresh``. The hierarchical merging is done
through the :py:func:`skimage.future.graph.merge_hierarchical` function.
For an example of how to contruct region boundary based RAGs, see
:any:`plot_rag_boundary`
:any:`plot_rag_boundary`.
"""
@@ -3,12 +3,12 @@
Region Boundary based RAGs
==========================
This example demonstrates construction of region boundary based RAGs with the
:py:func:`skimage.future.graph.rag_boundary` function. The function taken an
Construct a region boundary RAG with the ``rag_boundary`` function. The
function :py:func:`skimage.future.graph.rag_boundary`, takes an
``edge_map`` argument, which gives the significance of a feature (such as
edges) being present at each pixel. In a region boundary RAG, the edge between
two regions is the average value of the corresponding pixels in ``edge_map``
along their shared boundary.
edges) being present at each pixel. In a region boundary RAG, the edge weight
between two regions is the average value of the corresponding pixels in
``edge_map`` along their shared boundary.
"""
from skimage.future import graph