Skip to content

Commit

Permalink
Update Cluster filter docs for new is3d option
Browse files Browse the repository at this point in the history
  • Loading branch information
chambbj committed May 21, 2020
1 parent bb26b84 commit 2dcbe14
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/stages/filters.cluster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,7 @@ tolerance
Cluster tolerance - maximum Euclidean distance for a point to be added to the
cluster. [Default: 1.0]

is3d
By default, clusters are formed by considering neighbors in a 3D sphere, but
if ``is3d`` is set to false, it will instead consider neighbors in a 2D
cylinder (XY plane only). [Default: true]

0 comments on commit 2dcbe14

Please sign in to comment.