Skip to content
This repository has been archived by the owner on Nov 7, 2018. It is now read-only.

Commit

Permalink
Update geom/contour/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mbostock committed Dec 8, 2012
1 parent 90a118c commit 42e61cc
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions geom/contour/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
Computes a contour for a given input grid function using the <a href="http://en.wikipedia.org/wiki/Marching_squares">marching squares</a> algorithm. Returns the contour polygon as an array of points.
Demo: <http://bl.ocks.org/4241134>

@param grid a two-input function(x, y) that returns true for values inside the contour and false for values outside the contour.
@param start an optional starting point [x, y] on the grid.
@returns polygon [[x1, y1], [x2, y2], …]
Computes a contour for a given *grid function* using the [marching squares](http://en.wikipedia.org/wiki/Marching_squares) algorithm. Returns the contour polygon as an array of points. The grid function takes two arguments, *x* and *y*, and returns true if the specified point is inside the contour, and false for points outside the contour. The contour plugin can also take an optional starting point [x, y] on the grid.

0 comments on commit 42e61cc

Please sign in to comment.