filters.groupby

Contents

filters.groupby#

The Groupby Filter takes a single PointView as its input and creates a PointView for each category in the named [dimension] as its output.

Default Embedded Stage

This stage is enabled by default

Example#

The following pipeline will create a set of LAS files, where each file contains only points of a single Classification.

[
    "input.las",
    {
        "type":"filters.groupby",
        "dimension":"Classification"
    },
    "output_#.las"
]

Note

By default the groups are ordered according to the order of first occurance within the input. To change this, use filters.sort first to order the points according to dimension.

Options#

dimension

The dimension containing data to be grouped.

where

An expression that limits points passed to a filter. Points that don’t pass the expression skip the stage but are available to subsequent stages in a pipeline. [Default: no filtering]

where_merge

A strategy for merging points skipped by a where option when running in standard mode. If true, the skipped points are added to the first point view returned by the skipped filter. If false, skipped points are placed in their own point view. If auto, skipped points are merged into the returned point view provided that only one point view is returned and it has the same point count as it did when the filter was run. [Default: auto]