Skip to main content

A Python library to flexibly load the Toulouse Hyperspectral Data Set

Project description

Toulouse Hyperspectral Data Set

TlseHypDataSet is a Python library to flexibly load PyTorch datasets and run machine learning experiments on the Toulouse Hyperspectral Data Set.

Getting started

Installation from pip will be soon available.

For now, download the TlseHypDataSet repository and run the following:

$ cd TlseHypDataSet
$ pip install .

Download the hyperspectral images from the data catalogue in an images folder:

/path/to/dataset/
├── images
    ├── TLS_1b_2021-06-15_10-41-20_reflectance_rect.bsq
    ├── TLS_1b_2021-06-15_10-41-20_reflectance_rect.hdr
    ├── ...

Further documentation is going to be available soon. Here is a first example for a quick start.

The TlseHypDataSet class has a standard_splits attribute that contains 8 standard splits of the ground truth in a train set, a labeled_pool, an unlabeled_pool, a validation set and a test set. The following example shows how to load the training set of the first standard train / test split in a Pytorch data loader with the DisjointDataSplit class:

import torch
from TlseHypDataSet.tlse_hyp_data_set import TlseHypDataSet
from TlseHypDataSet.utils.dataset import DisjointDataSplit

dataset = TlseHypDataSet('/path/to/dataset/', pred_mode='pixel', patch_size=1)

# Load the first standard ground truth split
ground_truth_split = DisjointDataSplit(dataset, split=dataset.standard_splits[0])

train_loader = torch.utils.data.DataLoader(
    ground_truth_split.sets_['train'],
    shuffle=True,
    batch_size=1024
    )

for epoch in range(100):
    for samples, labels in train_loader:
        ...

NB: at first use, the images and the ground truth will be processed and additional data will be saved in a rasters folder.

Citation

If you use the TlseHypDataSet library, please cite the following two articles:

@article{ROUPIOZ2023109109,
title = {Multi-source datasets acquired over Toulouse (France) in 2021 for urban microclimate studies during the CAMCATT/AI4GEO field campaign},
journal = {Data in Brief},
volume = {48},
pages = {109109},
year = {2023},
issn = {2352-3409},
doi = {https://doi.org/10.1016/j.dib.2023.109109},
url = {https://www.sciencedirect.com/science/article/pii/S2352340923002287},
author = {L. Roupioz and X. Briottet and K. Adeline and A. {Al Bitar} and D. Barbon-Dubosc and R. Barda-Chatain and P. Barillot and S. Bridier and E. Carroll and C. Cassante and A. Cerbelaud and P. Déliot and P. Doublet and P.E. Dupouy and S. Gadal and S. Guernouti and A. {De Guilhem De Lataillade} and A. Lemonsu and R. Llorens and R. Luhahe and A. Michel and A. Moussous and M. Musy and F. Nerry and L. Poutier and A. Rodler and N. Riviere and T. Riviere and J.L. Roujean and A. Roy and A. Schilling and D. Skokovic and J. Sobrino},
keywords = {Land surface temperature, Spectral emissivity, Spectral reflectance, Air temperature, Airborne LiDAR, Atmospheric data, Urban area},
}

@misc{thoreau2023toulouse,
  title={Toulouse Hyperspectral Data Set: a benchmark data set to assess semi-supervised spectral representation learning and pixel-wise classification techniques},
  author={Romain Thoreau and Laurent Risser and Véronique Achard and Béatrice Berthelot and Xavier Briottet},
  year={2023},
  eprint={2311.08863},
  archivePrefix={arXiv},
  primaryClass={cs.CV}
 }

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

TlseHypDataSet-0.0.1.tar.gz (4.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

TlseHypDataSet-0.0.1-py3-none-any.whl (4.7 MB view details)

Uploaded Python 3

File details

Details for the file TlseHypDataSet-0.0.1.tar.gz.

File metadata

  • Download URL: TlseHypDataSet-0.0.1.tar.gz
  • Upload date:
  • Size: 4.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.5

File hashes

Hashes for TlseHypDataSet-0.0.1.tar.gz
Algorithm Hash digest
SHA256 973b1921a82fb4adddb257ad7645bdbeb9503c49e9e38028646daac5ca26dd57
MD5 769f5008e518bf5d35ace5d164ddff74
BLAKE2b-256 3562ed2068f225de5bbb8b9c15b9444e18e9a6e6f01b49b4f18c853b74f4a6a4

See more details on using hashes here.

File details

Details for the file TlseHypDataSet-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: TlseHypDataSet-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 4.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.5

File hashes

Hashes for TlseHypDataSet-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 956a2561d60a2a042fac7ac90847ded345c0765e21b221c6d83555e6230d1e44
MD5 c22e05c5c7dc0ddefd0c40adbef43041
BLAKE2b-256 aed6c772adc86bf5a3cabf5bc1a7e4bd9a0b92b25fbae3b87ff557ebefa909e2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page