#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# =============================================================================
# ___ ___ _____ _______
# | \/ | |_ _| | | ___ \
# | . . |_ _ ___ ___ ___ | | ___ ___ | | |_/ / _____ __
# | |\/| | | | / __|/ _ \/ _ \ | |/ _ \ / _ \| | ___ \/ _ \ \/ /
# | | | | |_| \__ \ __/ (_) | | | (_) | (_) | | |_/ / (_) > <
# \_| |_/\__,_|___/\___|\___/ \_/\___/ \___/|_\____/ \___/_/\_\
#
# @author: Nicolas Karasiak
# @site: www.karasiak.net
# @git: www.github.com/nkarasiak/MuseoToolBox
# =============================================================================
"""
The :mod:`museotoolbox.datasets` module gathers available datasets for testing
`MuseoToolBox`.
"""
import os
__pathFile = os.path.dirname(os.path.realpath(__file__))
[docs]def load_historical_data(return_X_y=False, return_X_y_g=False,
centroid=False, low_res=False):
"""
Get a sample of a french Historical map made by the army (carte d'état-major).
These maps are used to identify forest in the 1800's.
Field of the vector containning the label class is `Class`.
=================== ==============
Classes 5
Samples total 12647
Number of polygons 17
Dimensionality 3
Features integer
=================== ==============
Parameters
-----------
return_X_y : boolean, default=False.
If True, returns ``(data, target)`` instead of a path of files.
centroid : boolean, default=False.
If True, return the path of the centroid for each feature.
Returns
-------
raster,vector : list of str.
Return path of raster and vector files.
(data, target) : tuple if ``return_X_y`` is True
References
-----------
https://github.com/nkarasiak/HistoricalMap
Examples
--------
>>> X, y = load_historical_data(return_X_y=True)
>>> X.shape, y.shape
(12647, 3) (12647,)
>>> raster,vector = load_historical_data()
>>> raster
/mnt/DATA/lib/MuseoToolBox/museotoolbox/datasets/_historicalmap/map_compress.tif
>>> vector
/mnt/DATA/lib/MuseoToolBox/museotoolbox/datasets/_historicalmap/train.gpkg
"""
toReturn = []
if low_res:
raster = os.path.join(__pathFile, '_historicalmap/map_lowres.tif')
else:
raster = os.path.join(__pathFile, '_historicalmap/map_compress.tif')
vector = os.path.join(__pathFile, '_historicalmap/train.gpkg')
if return_X_y or return_X_y_g:
from ..processing import extract_ROI
if centroid:
vector = os.path.join(
__pathFile, '_historicalmap/train_centroid.gpkg')
if return_X_y_g:
X, y, g = extract_ROI(raster, vector, 'Class', 'uniquefid')
toReturn = (X, y, g)
else:
X, y = extract_ROI(raster, vector, 'Class')
toReturn = (X, y)
else:
toReturn.append(raster)
if centroid:
vectorCentroid = os.path.join(
__pathFile, '_historicalmap/train_centroid.gpkg')
toReturn.append(vectorCentroid)
else:
toReturn.append(vector)
return toReturn