ds.rst.to_pointcloud() or Raster.to_pointcloud()

ds.rst.to_pointcloud() or Raster.to_pointcloud()#

RasterBase.to_pointcloud(data_name='b1', data_band=1, auxiliary_data_bands=None, auxiliary_column_names=None, subsample=1, skip_nodata=True, as_array=False, random_state=None, force_pixel_offset='ul', mp_config=None, force_output_to_memory=False, pointcloud_return_type=None)[source]#

Convert raster cells to a point cloud, optionally selecting a random subsample.

Overloads:

Cell selection and output construction use the same implementation as subsample(). With the default subsample=1, every eligible cell is returned, while this method keeps conversion arguments first.

Parameters:

  • data_name (str) – Name to use for point cloud data attribute, defaults to “bX” where X is the data band number.

  • data_band (int) – (Only for multi-band rasters) Band to use for data attribute, defaults to first. Band counting starts at 1.

  • auxiliary_data_bands (Iterable[int] | None) – (Only for multi-band rasters) Other bands to save as auxiliary data attributes, defaulting to every band other than data_band. Pass an empty iterable to keep only the main band.

  • auxiliary_column_names (Iterable[str] | None) – (Only for multi-band rasters) Names to use for auxiliary data bands, only if auxiliary data bands is not none, defaults to “b1”, “b2”, etc.

  • subsample (float | int) – Fraction or maximum number of eligible cells to return, with 1 selecting every cell.

  • skip_nodata (bool) – Whether to skip nodata values.

  • as_array (bool) – Return an array instead of a vector.

  • random_state (int | Generator | None) – Random state or seed number.

  • force_pixel_offset (Literal['center', 'ul', 'ur', 'll', 'lr']) – Force offset to derive point coordinate with. Raster coordinates normally only associate to upper-left corner “ul” (“Area” definition) or center (“Point” definition).

  • mp_config (MultiprocConfig | None) – Worker, tile and output settings for multiprocessing. Point output uses GeoPackage, LAS or LAZ; LAS/LAZ stores the main raster value as elevation. Array output does not write a file. Cannot be combined with a Dask source.

  • force_output_to_memory (bool) – Keep the complete output in memory instead of using the automatic chunked path.

  • pointcloud_return_type (Literal['dataarray', 'dataset', 'geodataframe'] | None) – Returned representation: dataarray, dataset, or geodataframe. None uses config[“pointcloud_return_type”] for accessors, or returns a PointCloud for GeoUtils objects.

Raises:

ValueError – If the sample count or fraction is poorly formatted.

Returns:

A point cloud, or array of the shape (N, 2 + count) where N is the sample count.