Skip to content

Commit

Permalink
add a doc about 3D boxes
Browse files Browse the repository at this point in the history
  • Loading branch information
hobu committed Feb 11, 2020
1 parent 528eb1f commit ed3c8e5
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion doc/stages/filters.crop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ filters.crop

The **crop filter** removes points that fall outside or inside a
cropping bounding
box (2D), polygon, or point+distance. If more than one bounding region is
box (2D or 3D), polygon, or point+distance. If more than one bounding region is
specified, the filter will pass all input points through each bounding region,
creating an output point set for each input crop region.

Expand Down Expand Up @@ -47,6 +47,16 @@ bounds
"([xmin, xmax], [ymin, ymax])". This option can be specified more than
once by placing values in an array.


.. note::

3D bounds can be given in the form ``([xmin, xmax, zmax], [ymin, ymax, zmax])``.

.. warning::

If a 3D bounds is given to the filter, a 3D crop will be attempted, even
if the Z values are invalid or inconsistent with the data.

polygon
The clipping polygon, expressed in a well-known text string,
eg: "POLYGON((0 0, 5000 10000, 10000 0, 0 0))". This option can be
Expand Down

0 comments on commit ed3c8e5

Please sign in to comment.