rasterio.sample module

rasterio.sample.sample_gen(dataset, xy, indexes=None, masked=False)

Sample pixels from a dataset

  • dataset (rasterio Dataset) – Opened in “r” mode.

  • xy (iterable) –

    Pairs of x, y coordinates in the dataset’s reference system.

    Note: Sorting coordinates can often yield better performance. A sort_xy function is provided in this module for convenience.

  • indexes (int or list of int) – Indexes of dataset bands to sample.

  • masked (bool, default: False) – Whether to mask samples that fall outside the extent of the dataset.


array – A array of length equal to the number of specified indexes containing the dataset values for the bands corresponding to those indexes.


Sort x, y coordinates by x then y


xy (iterable) – Pairs of x, y coordinates


A list of sorted x, y coordinates

Return type