geo3d.pdal.filters¶

Attributes¶

FILTER_TYPES

Functions¶

`range`(→ Dict[str, str])	Create the filters.range's stage.
`cluster`(→ Dict[str, str])	Create the filters.cluster's stage.
`assign`(→ Dict[str, str])	Create filters.assign's stage.
`merge`(→ Dict)	Create filters.merge's stage.
`stats`(→ Dict[str, Any])	Create filters.stats's stage.
`expression`(→ Dict[str, str])	Create filters.expression's stage.
`crop`(→ Dict[str, str])	Create filters.crop's stage.
`info`(→ Dict)	Create filters.info's stage.
`nndistance`(→ Dict[str, Any])	Create filters.nndistance's stage.
`outlier`(→ Dict[str, Any])	Create filters.outlier's stage.
`groupby`(→ Dict[str, Any])	Create filters.groupby's stage.

Module Contents¶

geo3d.pdal.filters.FILTER_TYPES¶

geo3d.pdal.filters.range(limits: str) → Dict[str, str]¶

Create the filters.range’s stage.

Parameters:: limits (str) – A list of limits as defined in pdal. ‘Z[0:100],Classification[2:2]’ for example.
Returns:: The Filter’s stage dictionary.
Return type:: Dict

geo3d.pdal.filters.cluster(min_points: int, tolerance: float) → Dict[str, str]¶

Create the filters.cluster’s stage.

Parameters:

min_points (int) – The minimum size of a cluster.
tolerance (float) – The maximum distance to a cluster.

Returns:

The Filter’s stage dictionary.

Return type:

dict

geo3d.pdal.filters.assign(value: str) → Dict[str, str]¶

Create filters.assign’s stage.

Parameters:: value (str) – A list of assignment expressions. See pdal documentation.

Examples

value=’Dimension = ValueExpression [WHERE ConditionalExpression]’.

Returns:: The Filter’s stage dictionary.
Return type:: dict

geo3d.pdal.filters.merge() → Dict¶

Create filters.merge’s stage.

Returns:: The Filter’s stage dictionary.
Return type:: dict

geo3d.pdal.filters.stats(dimensions: str, enumerate: str | None = None, count: str | None = None) → Dict[str, Any]¶

Create filters.stats’s stage.

Parameters:

dimensions (str) – The dimensions on whose to compute statistics.
enumerate (str) – The dimensions whose values should be enumerated.
count (str) – Provide the count of the number of points of each enumerated category.

Returns:

The Stats’ stage dictionary.

Return type:

dict

geo3d.pdal.filters.expression(expression: str) → Dict[str, str]¶

Create filters.expression’s stage.

Parameters:: expression (str) – An expression that limits points passed to a filter. For example, ‘Classification == 3’.
Returns:: The Expression’ stage dictionary.
Return type:: dict

geo3d.pdal.filters.crop(bounds: str) → Dict[str, str]¶

Create filters.crop’s stage.

Parameters:: bounds (str) – The bounding box to crop on. It can be in the format ‘([xmin, xmax], [ymin, ymax])’.
Returns:: The Crop’s stage dictionary.
Return type:: dict

geo3d.pdal.filters.info() → Dict¶

Create filters.info’s stage.

Returns:: the Info’s stage dictionary.
Return type:: dict

geo3d.pdal.filters.nndistance(mode: str, k: int) → Dict[str, Any]¶

Create filters.nndistance’s stage.

Parameters:

mode (str) – The mode of operation.
k (int) – The number of nearest neighbors.

Returns:

the nndistance’s stage dictionary.

Return type:

dict

geo3d.pdal.filters.outlier(classification: int, method: str, min_k: int, radius: float, mean_k: int, multiplier: float) → Dict[str, Any]¶

Create filters.outlier’s stage.

Parameters:

classification (int) – The class value to assign to outliers.
method (str) – The outlier removal method. ‘statistical’ or ‘radius’.
min_k (int) – Minimum number of neighbors in radius. Applicable to radius method only.
radius (float) – The value of radius of the ball of neighbors.
mean_k (int) – The number of k nearest neighbors. Applicable to statistical method only.
multiplier (float) – The multiplier to use in computing the threshold.

Returns:

the outlier’s stage dictionary.

Return type:

dict

geo3d.pdal.filters.groupby(dimension: str) → Dict[str, Any]¶

Create filters.groupby’s stage.

Parameters:: dimension (str) – The dimension to be used in grouping the data.
Returns:: the Info’s stage dictionary.
Return type:: dict