Documentation Index
Fetch the complete documentation index at: https://mintlify.com/terrafloww/rasteret/llms.txt
Use this file to discover all available pages before exploring further.
Class Definition
class DatasetRegistry:
@classmethod
def register(cls, descriptor: DatasetDescriptor) -> None
@classmethod
def unregister(cls, dataset_id: str) -> DatasetDescriptor | None
@classmethod
def get(cls, dataset_id: str) -> DatasetDescriptor | None
@classmethod
def list(cls) -> list[DatasetDescriptor]
@classmethod
def search(cls, keyword: str) -> list[DatasetDescriptor]
Description
Registry of dataset descriptors. This is a proto-spec catalog that stores metadata for known cloud-native raster collections. Built-in datasets are registered at module import time. Users can add custom entries via register() or the top-level rasteret.register() helper.
Each DatasetDescriptor captures identity, access, and band-mapping metadata for a collection. The registry auto-populates BandRegistry and CloudConfig keyed by STAC collection ID.
Class Methods
register()
@classmethod
def register(cls, descriptor: DatasetDescriptor) -> None
BandRegistry and CloudConfig keyed by the descriptor ID so that provider-specific conventions do not collide.
descriptor
DatasetDescriptor
required
The descriptor to register. See DatasetDescriptor class.
unregister()
@classmethod
def unregister(cls, dataset_id: str) -> DatasetDescriptor | None
Full namespaced ID (e.g., "earthsearch/sentinel-2-l2a").
The removed descriptor, or None if not found.
get()
@classmethod
def get(cls, dataset_id: str) -> DatasetDescriptor | None
Full namespaced ID (e.g., "earthsearch/sentinel-2-l2a").
The descriptor, or None if not found.
list()
@classmethod
def list(cls) -> list[DatasetDescriptor]
List of all registered dataset descriptors.
search()
@classmethod
def search(cls, keyword: str) -> list[DatasetDescriptor]
Case-insensitive search term.
Descriptors matching the search term.
DatasetDescriptor
@dataclass(frozen=True)
class DatasetDescriptor:
# Identity
id: str
name: str
description: str = ""
# Access
stac_api: str | None = None
stac_collection: str | None = None
geoparquet_uri: str | None = None
column_map: dict[str, str] | None = None
# GeoParquet normalization hints
href_column: str | None = None
band_index_map: dict[str, int] | None = None
bbox_columns: dict[str, str] | None = None
# Band mapping
band_map: dict[str, str] | None = None
separate_files: bool = True
# Coverage metadata
spatial_coverage: str = ""
temporal_range: tuple[str, str] | None = None
requires_auth: bool = False
license: str = ""
license_url: str = ""
commercial_use: bool = True
# Static STAC catalog support
static_catalog: bool = False
# Auth / Cloud configuration
s3_credentials_url: str | None = None
cloud_config: dict[str, str] | None = None
example_bbox: tuple[float, float, float, float] | None = None
example_date_range: tuple[str, str] | None = None
# Cross-references
torchgeo_class: str | None = None
torchgeo_verified: bool = False
Usage Example
import rasteret
from rasteret.catalog import DatasetDescriptor
# Register a custom dataset
rasteret.register(DatasetDescriptor(
id="acme/field-survey-2024",
name="ACME Field Survey",
description="High-resolution RGB imagery from field surveys",
stac_api="https://acme.example.com/stac/v1",
stac_collection="field-survey-2024",
band_map={"R": "red", "G": "green", "B": "blue"},
separate_files=True,
spatial_coverage="regional",
temporal_range=("2024-01-01", "2024-12-31"),
license="CC-BY-4.0",
license_url="https://creativecommons.org/licenses/by/4.0/",
))
# List all datasets
for desc in rasteret.DatasetRegistry.list():
print(f"{desc.id}: {desc.name}")
# Search for datasets
sentinel = rasteret.DatasetRegistry.search("sentinel")
for desc in sentinel:
print(f"{desc.id}: {desc.description}")
# Get a specific dataset
desc = rasteret.DatasetRegistry.get("earthsearch/sentinel-2-l2a")
if desc:
print(f"Found: {desc.name}")
print(f"STAC API: {desc.stac_api}")
print(f"Collection: {desc.stac_collection}")
# Use a registered dataset
collection = rasteret.build(
"acme/field-survey-2024",
name="field-survey",
bbox=(-122.5, 37.5, -122.0, 38.0),
date_range=("2024-06-01", "2024-06-30"),
)