Earth Index Embeddings

class torchgeo.datasets.EarthIndexEmbeddings(root='data', transforms=None)

Bases: NonGeoDataset

Earth Index Embeddings dataset.

Earth Index Embeddings are a global embedding product generated from Earth Index v2 Sentinel-2 mosaics. The embeddings are generated using the SoftCon model from Zhu XLabs and result in an embedding of length 384. Each embedding captures a 320 square meter patch of the Earth, gridded using a MajorTom-based grid. These embeddings, their IDs and centroids are encoded in geoparquet. The GeoParquet is named similarly to the imagery and references the original MGRS/UTM tile which the imagery covered.

Added in version 0.9.

__init__(root='data', transforms=None)

Initialize a new EarthIndexEmbeddings instance.

Parameters:

• root (str | PathLike[str]) – Root directory where dataset can be found.

• transforms (Callable[[dict[str, Any]], dict[str, Any]] | None) – A function/transform that takes input sample and its target as entry and returns a transformed version.

Raises:

DatasetNotFoundError – If dataset is not found.

__len__()

Return the number of data points in the dataset.

Returns:

Length of the dataset.

Return type:

int

__getitem__(index)

Return an index within the dataset.

Parameters:

index (int) – Index to return.

Returns:

Data and label at that index.

Return type:

dict[str, Any]

plot(sample, show_titles=True)

Plot a sample from the dataset.

Parameters:

• sample (dict[str, Any]) – A sample returned by __getitem__().

• show_titles (bool) – Flag indicating whether to show titles above each panel.

Returns:

A matplotlib Figure with the rendered sample.

Return type:

Figure