tide.voronoi package

Submodules

tide.voronoi.voronoi_algorithm module

Module qui contient l’algorithme de création des polygones de Voronoi.

tide.voronoi.voronoi_algorithm.create_voronoi_polygons(geometry, tolerance=0.0, extend_to=<POLYGON ((-10 10, -10 89, -175 89, -175 10, -10 10))>, only_edges=False, **kwargs)

Fonction qui crée des polygones de Voronoi à partir d’un ensemble de points. https://shapely.readthedocs.io/en/stable/reference/shapely.voronoi_polygons.html

Paramètres:

• geometry (Geometry) – Géométrie des objets.

• tolerance (float) – La tolérance pour l’intersection des lignes.

• extend_to (Geometry) – L’étendue de la géométrie des polygones de Voronoi.

• only_edges (bool) – Création de polylignes plutôt que des polygones.

• kwargs (dict) – Autres paramètres.

Renvoie:

Collection de polygones de Voronoi.

Type renvoyé:

GeometryCollection

tide.voronoi.voronoi_geodataframe module

Module qui contient les fonctions pour manipuler les GeoDataFrame des polygones de Voronoi.

Les fonctions permettent de créer les polygones de Voronoi, de les joindre avec les stations et de fusionner les attributs.

tide.voronoi.voronoi_geodataframe.create_voronoi_gdf(geometry)

Crée un GeoDataFrame de polygone de Voronoi à partir d’une geometrie Shapely.

Paramètres:

geometry (Geometry) – La géométrie Shapely à utiliser pour créer les polygones de Voronoi.

Renvoie:

Le GeoDataFrame contenant les polygones de Voronoi.

Type renvoyé:

gpd.GeoDataFrame

tide.voronoi.voronoi_geodataframe.from_shapely_object_to_geodataframe(geometry, epsg=4326)

Fonction qui transforme un objet Shapely en GeoDataFrame.

Paramètres:

• geometry (shapely.geometry) – La géométrie Shapely à transformer.

• epsg (Optional[int]) – Le code EPSG du CRS à utiliser.

Renvoie:

Le GeoDataFrame.

Type renvoyé:

gpd.GeoDataFrame

tide.voronoi.voronoi_geodataframe.get_code_by_station_id(gdf_voronoi, station_id)

Récupère le code de la station.

Paramètres:

• gdf_voronoi (gpd.GeoDataFrame[schema.TideZoneStationSchema]) – Le GeoDataFrame des polygones de Voronoi.

• station_id (str) – L’identifiant de la station.

Renvoie:

Le code de la station.

Type renvoyé:

str

tide.voronoi.voronoi_geodataframe.get_concave_hull(geometry, ratio=0.5, allow_holes=True)

Récupère l’enveloppe concave des polygones de Voronoi.

Paramètres:

• geometry (Geometry) – La géométrie a utilisé pour l’enveloppe concave.

• ratio (float) – Le ratio de l’enveloppe concave.

• allow_holes (bool) – Autorise les trous dans l’enveloppe concave.

Renvoie:

L’enveloppe concave des polygones.

Type renvoyé:

Geometry

tide.voronoi.voronoi_geodataframe.get_name_by_station_id(gdf_voronoi, station_id)

Récupère le nom de la station.

Paramètres:

• gdf_voronoi (gpd.GeoDataFrame[schema.TideZoneStationSchema]) – Le GeoDataFrame des polygones de Voronoi.

• station_id (str) – L’identifiant de la station.

Renvoie:

Le nom de la station.

Type renvoyé:

str

tide.voronoi.voronoi_geodataframe.get_polygon_by_geometry(gdf_voronoi, geometry)

Récupère les polygones de Voronoi qui intersectent les géométries données.

Paramètres:

• gdf_voronoi (gpd.GeoDataFrame[schema.TideZoneStationSchema]) – Le GeoDataFrame des polygones de Voronoi.

• geometry (gpd.GeoDataFrame) – La géométrie a utilisé pour l’intersection.

Renvoie:

Le GeoDataFrame des polygones de Voronoi qui intersectent les géométries.

Type renvoyé:

gpd.GeoDataFrame[schema.TideZoneSchema]

tide.voronoi.voronoi_geodataframe.get_polygon_by_station_id(gdf_voronoi, station_id)

Récupère le polygone de Voronoi pour une station donnée.

Paramètres:

• gdf_voronoi (gpd.GeoDataFrame[schema.TideZoneStationSchema]) – Le GeoDataFrame des polygones de Voronoi.

• station_id (str) – L’identifiant de la station.

Renvoie:

Le polygone de Voronoi de la station.

Type renvoyé:

gpd.GeoDataFrame

tide.voronoi.voronoi_geodataframe.get_station_position_by_station_id(gdf_voronoi, station_id)

Récupère la position de la station.

Paramètres:

• gdf_voronoi (gpd.GeoDataFrame[schema.TideZoneStationSchema]) – Le GeoDataFrame des polygones de Voronoi.

• station_id (str) – L’identifiant de la station.

Renvoie:

La position de la station.

Type renvoyé:

gpd.GeoSeries

tide.voronoi.voronoi_geodataframe.get_station_title(gdf_voronoi, station_id)

Retourne le titre formaté d’une station marégraphique (nom + code).

Paramètres:

• gdf_voronoi (gpd.GeoDataFrame[schema.TideZoneStationSchema]) – GeoDataFrame des polygones de Voronoi.

• station_id (str) – Identifiant de la station.

Renvoie:

Titre de la station au format "Nom (code)".

Type renvoyé:

str

tide.voronoi.voronoi_geodataframe.get_time_series_by_station_id(gdf_voronoi, station_id)

Récupère les séries temporelles pour une station donnée.

Paramètres:

• gdf_voronoi (gpd.GeoDataFrame[schema.TideZoneStationSchema]) – Le GeoDataFrame des polygones de Voronoi.

• station_id (str) – L’identifiant de la station.

Renvoie:

Les séries temporelles de la station.

Type renvoyé:

list[str]

tide.voronoi.voronoi_geodataframe.get_voronoi_geodataframe(stations_handler, time_series, excluded_stations=None, water_level_stations=None, **kwargs)

Récupère le GeoDataFrame des polygones de Voronoi.

Paramètres:

• stations_handler (StationsHandlerABC) – Gestionnaire des stations.

• time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations.

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

• water_level_stations (Collection[str] | None) – Liste des stations de niveau d’eau à utiliser.

Renvoie:

Le GeoDataFrame des polygones de Voronoi.

Type renvoyé:

gpd.GeoDataFrame[schema.TideZoneStationSchema]

tide.voronoi.voronoi_geodataframe.join_stations_voronoi(gdf_stations, gdf_voronoi)

Crée une jointure spatiale entre les stations et les polygones de Voronoi.

Paramètres:

• gdf_stations (gpd.GeoDataFrame) – Le GeoDataFrame des stations.

• gdf_voronoi (gpd.GeoDataFrame) – Le GeoDataFrame des polygones de Voronoi.

Renvoie:

Le GeoDataFrame joint.

Type renvoyé:

gpd.GeoDataFrame

tide.voronoi.voronoi_geodataframe.merge_attributes(gdf_voronoi, gdf_joined)

Fusionne les attributs des stations avec les polygones de Voronoi.

Paramètres:

• gdf_voronoi (gpd.GeoDataFrame) – Le GeoDataFrame des polygones de Voronoi.

• gdf_joined (gpd.GeoDataFrame) – Le GeoDataFrame avec le geodataframe des stations et des polygones de Voronoi joins.

Renvoie:

Le GeoDataFrame avec les attributs fusionnés.

Type renvoyé:

gpd.GeoDataFrame

tide.voronoi.voronoi_geodataframe.WGS84: int = 4326

EPSG code pouur le système de coordonnées WGS84.

tide.voronoi.voronoi_models module

Module qui contient les modèles et les protocoles pour manipuler les données des séries temporelles et des stations.

class tide.voronoi.voronoi_models.StationsHandlerProtocol(*args, **kwargs)

Bases : Protocol

Protocole pour définir les méthodes de manipulation des stations.

get_stations_geodataframe(filter_time_series, excluded_stations, ttl)

Méthode pour récupérer le GeoDataFrame des stations.

Paramètres:

• filter_time_series (Collection[TimeSeriesProtocol] | None) – Liste des séries temporelles pour filtrer les stations. Si None, toutes les stations sont retournées.

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

• ttl (Optional[int]) – Durée de vie du cache.

Renvoie:

GeoDataFrame des stations.

Type renvoyé:

gpd.GeoDataFrame

get_stations_geodataframe_from_codes(station_codes, filter_time_series)

Méthode pour récupérer le GeoDataFrame d’une station spécifique.

Paramètres:

• station_codes (Collection[str]) – Liste des codes des stations.

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer la station.

Renvoie:

GeoDataFrame de la station.

Type renvoyé:

gpd.GeoDataFrame

_is_protocol = True

class tide.voronoi.voronoi_models.TimeSeriesProtocol(*args, **kwargs)

Bases : Protocol

Protocole pour définir les types des séries temporelles.

from_str(value)

Méthode pour convertir une chaîne de caractères en série temporelle.

Paramètres:

value (str) – Chaîne de caractères.

Renvoie:

Série temporelle.

Type renvoyé:

TimeSeriesProtocol

WLF: str = 'wlf'

Water Level Forecast.

WLF_SPINE: str = 'wlf-spine'

Water Level Forecast Spine.

WLF_VTG: str = 'wlf-vtg'

Water Level Forecast VTG.

WLO: str = 'wlo'

Water Level Observed.

WLP: str = 'wlp'

Water Level Prediction.

_is_protocol = True

Module contents

Ce package contient les fonctions permettant de générer des polygones de Voronoi à partir de données de stations de mesures.

class tide.voronoi.StationsHandlerProtocol(*args, **kwargs)

Bases : Protocol

Protocole pour définir les méthodes de manipulation des stations.

get_stations_geodataframe(filter_time_series, excluded_stations, ttl)

Méthode pour récupérer le GeoDataFrame des stations.

Paramètres:

• filter_time_series (Collection[TimeSeriesProtocol] | None) – Liste des séries temporelles pour filtrer les stations. Si None, toutes les stations sont retournées.

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

• ttl (Optional[int]) – Durée de vie du cache.

Renvoie:

GeoDataFrame des stations.

Type renvoyé:

gpd.GeoDataFrame

get_stations_geodataframe_from_codes(station_codes, filter_time_series)

Méthode pour récupérer le GeoDataFrame d’une station spécifique.

Paramètres:

• station_codes (Collection[str]) – Liste des codes des stations.

• filter_time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer la station.

Renvoie:

GeoDataFrame de la station.

Type renvoyé:

gpd.GeoDataFrame

_is_protocol = True

class tide.voronoi.TimeSeriesProtocol(*args, **kwargs)

Bases : Protocol

Protocole pour définir les types des séries temporelles.

from_str(value)

Méthode pour convertir une chaîne de caractères en série temporelle.

Paramètres:

value (str) – Chaîne de caractères.

Renvoie:

Série temporelle.

Type renvoyé:

TimeSeriesProtocol

WLF: str = 'wlf'

Water Level Forecast.

WLF_SPINE: str = 'wlf-spine'

Water Level Forecast Spine.

WLF_VTG: str = 'wlf-vtg'

Water Level Forecast VTG.

WLO: str = 'wlo'

Water Level Observed.

WLP: str = 'wlp'

Water Level Prediction.

_is_protocol = True

tide.voronoi.from_shapely_object_to_geodataframe(geometry, epsg=4326)

Fonction qui transforme un objet Shapely en GeoDataFrame.

Paramètres:

• geometry (shapely.geometry) – La géométrie Shapely à transformer.

• epsg (Optional[int]) – Le code EPSG du CRS à utiliser.

Renvoie:

Le GeoDataFrame.

Type renvoyé:

gpd.GeoDataFrame

tide.voronoi.get_code_by_station_id(gdf_voronoi, station_id)

Récupère le code de la station.

Paramètres:

• gdf_voronoi (gpd.GeoDataFrame[schema.TideZoneStationSchema]) – Le GeoDataFrame des polygones de Voronoi.

• station_id (str) – L’identifiant de la station.

Renvoie:

Le code de la station.

Type renvoyé:

str

tide.voronoi.get_concave_hull(geometry, ratio=0.5, allow_holes=True)

Récupère l’enveloppe concave des polygones de Voronoi.

Paramètres:

• geometry (Geometry) – La géométrie a utilisé pour l’enveloppe concave.

• ratio (float) – Le ratio de l’enveloppe concave.

• allow_holes (bool) – Autorise les trous dans l’enveloppe concave.

Renvoie:

L’enveloppe concave des polygones.

Type renvoyé:

Geometry

tide.voronoi.get_name_by_station_id(gdf_voronoi, station_id)

Récupère le nom de la station.

Paramètres:

• gdf_voronoi (gpd.GeoDataFrame[schema.TideZoneStationSchema]) – Le GeoDataFrame des polygones de Voronoi.

• station_id (str) – L’identifiant de la station.

Renvoie:

Le nom de la station.

Type renvoyé:

str

tide.voronoi.get_polygon_by_geometry(gdf_voronoi, geometry)

Récupère les polygones de Voronoi qui intersectent les géométries données.

Paramètres:

• gdf_voronoi (gpd.GeoDataFrame[schema.TideZoneStationSchema]) – Le GeoDataFrame des polygones de Voronoi.

• geometry (gpd.GeoDataFrame) – La géométrie a utilisé pour l’intersection.

Renvoie:

Le GeoDataFrame des polygones de Voronoi qui intersectent les géométries.

Type renvoyé:

gpd.GeoDataFrame[schema.TideZoneSchema]

tide.voronoi.get_polygon_by_station_id(gdf_voronoi, station_id)

Récupère le polygone de Voronoi pour une station donnée.

Paramètres:

• gdf_voronoi (gpd.GeoDataFrame[schema.TideZoneStationSchema]) – Le GeoDataFrame des polygones de Voronoi.

• station_id (str) – L’identifiant de la station.

Renvoie:

Le polygone de Voronoi de la station.

Type renvoyé:

gpd.GeoDataFrame

tide.voronoi.get_station_position_by_station_id(gdf_voronoi, station_id)

Récupère la position de la station.

Paramètres:

• gdf_voronoi (gpd.GeoDataFrame[schema.TideZoneStationSchema]) – Le GeoDataFrame des polygones de Voronoi.

• station_id (str) – L’identifiant de la station.

Renvoie:

La position de la station.

Type renvoyé:

gpd.GeoSeries

tide.voronoi.get_station_title(gdf_voronoi, station_id)

Retourne le titre formaté d’une station marégraphique (nom + code).

Paramètres:

• gdf_voronoi (gpd.GeoDataFrame[schema.TideZoneStationSchema]) – GeoDataFrame des polygones de Voronoi.

• station_id (str) – Identifiant de la station.

Renvoie:

Titre de la station au format "Nom (code)".

Type renvoyé:

str

tide.voronoi.get_time_series_by_station_id(gdf_voronoi, station_id)

Récupère les séries temporelles pour une station donnée.

Paramètres:

• gdf_voronoi (gpd.GeoDataFrame[schema.TideZoneStationSchema]) – Le GeoDataFrame des polygones de Voronoi.

• station_id (str) – L’identifiant de la station.

Renvoie:

Les séries temporelles de la station.

Type renvoyé:

list[str]

tide.voronoi.get_voronoi_geodataframe(stations_handler, time_series, excluded_stations=None, water_level_stations=None, **kwargs)

Récupère le GeoDataFrame des polygones de Voronoi.

Paramètres:

• stations_handler (StationsHandlerABC) – Gestionnaire des stations.

• time_series (Collection[TimeSeriesProtocol]) – Liste des séries temporelles pour filtrer les stations.

• excluded_stations (Collection[str] | None) – Liste des stations à exclure.

• water_level_stations (Collection[str] | None) – Liste des stations de niveau d’eau à utiliser.

Renvoie:

Le GeoDataFrame des polygones de Voronoi.

Type renvoyé:

gpd.GeoDataFrame[schema.TideZoneStationSchema]