GBIF

class torchgeo.datasets.GBIF(root='data')

Bases: GeoDataset

Dataset for the Global Biodiversity Information Facility.

GBIF, the Global Biodiversity Information Facility, is an international network and data infrastructure funded by the world’s governments and aimed at providing anyone, anywhere, open access to data about all types of life on Earth.

This dataset is intended for use with GBIF’s occurrence records. It may or may not work for other GBIF datasets. Data for a particular species or region of interest can be downloaded from the above link.

If you use a GBIF dataset in your research, please cite it according to:

• https://www.gbif.org/citation-guidelines

Added in version 0.3.

__init__(root='data')

Initialize a new Dataset instance.

Parameters:

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

Raises:

DatasetNotFoundError – If dataset is not found.

__getitem__(index)

Retrieve input, target, and/or metadata indexed by spatiotemporal slice.

Parameters:

index (slice | tuple[slice] | tuple[slice, slice] | tuple[slice, slice, slice]) – [xmin:xmax:xres, ymin:ymax:yres, tmin:tmax:tres] coordinates to index.

Returns:

Sample of input, target, and/or metadata at that index.

Raises:

IndexError – If index is not found in the dataset.

Return type:

dict[str, Any]

plot(sample, show_titles=True, suptitle=None)

Plot a sample from the dataset.

Parameters:

• sample (dict[str, Any]) – a sample return by __getitem__()

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

• suptitle (str | None) – optional suptitle to use for Figure

Returns:

a matplotlib Figure with the rendered sample

Return type:

Figure

Added in version 0.8.