API Reference

Full API documentation auto-generated from source code docstrings using mkdocstrings.

Start with Entry Points (rasteret module) for the top-level functions most users need. Core covers the Collection class and execution layer (get_numpy(), get_xarray(), get_gdf(), sample_points(), to_table(), read_window()). Ingest has the builders for STAC and Parquet sources. Fetch has the COG reader and obstore backend internals. Integrations covers the to_table() / read_window() boundary used by RasteretDataset in TorchGeo. Configuration covers cloud/storage, types, and the CLI.

Browse by navigating the module tree in the sidebar, or use the search box.

Note

Only public API is documented here. Private methods (prefixed with _) and test modules are excluded.