export package

Submodules

export.export_utils module

Module contents

Ce package contient les fonctions d’export des données.

class export.FileTypes(value)

Bases : StrEnum

Enumération des types de fichiers de sortie.

CSAR = 'csar'

CSV = 'csv'

FEATHER = 'feather'

GEOJSON = 'geojson'

GEOTIFF = 'geotiff'

GPKG = 'gpkg'

PARQUET = 'parquet'

export.export_dataframe_to_csv(dataframe, output_path, **kwargs)

Sauvegarde le DataFrame dans un fichier CSV.

Paramètres:

• dataframe (pd.DataFrame) – Le DataFrame.

• output_path (Path) – Le chemin du fichier de sortie.

Type renvoyé:

None

export.export_geodataframe(geodataframe, file_type, output_path, **kwargs)

Exporte un GeoDataFrame dans un fichier.

Paramètres:

• geodataframe (gpd.GeoDataFrame) – Le GeoDataFrame.

• file_type (FileTypes) – Le type de fichier de sortie.

• output_path (Path) – Le chemin du fichier de sortie.

Type renvoyé:

None

export.export_geodataframe_to_csar_api(geo_dataframe, output_path, config_caris, **kwargs)

Sauvegarde le GeoDataFrame dans un fichier CSAR.

Paramètres:

• geo_dataframe (gpd.GeoDataFrame) – Le GeoDataFrame.

• output_path (Path) – Le chemin du fichier de sortie.

• config_caris (CarisAPIConfigProtocol) – La configuration de l’API Caris.

Type renvoyé:

None

export.export_geodataframe_to_geojson(geodataframe, output_path, to_epsg=4326, **kwargs)

Sauvegarde le GeoDataFrame dans un fichier GeoJSON.

Paramètres:

• geodataframe (gpd.GeoDataFrame) – Le GeoDataFrame.

• output_path (Path) – Le chemin du fichier de sortie.

• to_epsg (Optional[int]) – Le code EPSG de la projection.

Type renvoyé:

None

export.export_geodataframe_to_geotiff(geodataframe, output_path, column='Depth_processed_meter', resolution=2e-05, to_epsg=4326, **kwargs)

Exporte un GeoDataFrame en fichier GeoTIFF en rasterisant les géométries

Paramètres:

• geodataframe (gpd.GeoDataFrame) – Le GeoDataFrame à exporter.

• output_path (Path) – Le chemin du fichier de sortie.

• column (str) – Le nom de la colonne contenant les valeurs à rasteriser.

• resolution (float) – La résolution du raster en unités de la CRS

• to_epsg (Optional[int]) – Le code EPSG de la CRS cible

Lève:

ValueError – Si le GeoDataFrame n’a pas de CRS défini ou si les dimensions du raster sont invalides.

Type renvoyé:

None

export.export_geodataframe_to_gpkg(geodataframe, output_path, to_epsg=4326, **kwargs)

Sauvegarde le GeoDataFrame dans un fichier GeoPackage.

Paramètres:

• geodataframe (gpd.GeoDataFrame) – Le GeoDataFrame.

• output_path (Path) – Le chemin du fichier de sortie.

• to_epsg (Optional[int]) – Le code EPSG de la projection.

Type renvoyé:

None

export.export_geodataframe_to_shapefile(geodataframe, output_path, to_epsg=4326, **kwargs)

Sauvegarde le GeoDataFrame dans un fichier Shapefile.

Paramètres:

• geodataframe (gpd.GeoDataFrame) – Le GeoDataFrame.

• output_path (Path) – Le chemin du fichier de sortie.

• to_epsg (Optional[int]) – Le code EPSG de la projection.

Type renvoyé:

None

export.export_metadata(data_geodataframe, output_path, vessel_config, tide_stations, decimal_precision, vessel_name=None, software_version='', processing_context=None, output_file_name=None)

Exporte les métadonnées d’un levé CSB (JSON + rapport graphique).

Paramètres:

• data_geodataframe (gpd.GeoDataFrame[schema.DataLoggerSchema]) – Données traitées.

• output_path (Path) – Répertoire de sortie (le fichier JSON sera nommé automatiquement).

• vessel_config – Configuration du navire.

• tide_stations (Optional[Collection[str]]) – Liste des stations de marées utilisées.

• decimal_precision (int) – Précision des décimales.

• vessel_name (Optional[str]) – Nom du navire pour l’export (surcharge vessel_config.name).

• software_version (str) – Version du logiciel à inscrire dans les métadonnées.

• processing_context – Contexte de traitement (type capteur, statut réduction).

• output_file_name (Optional[str]) – Nom de fichier de sortie forcé (surcharge le nom calculé automatiquement). Utilisé en mode split (merge_files=False) pour conserver le nom du fichier d’entrée.

Type renvoyé:

None

export.export_processed_data(data_geodataframe, output_data_path, file_type, resolution, **kwargs)

Exporte les données traitées dans un fichier GeoPackage.

Paramètres:

• data_geodataframe (gpd.GeoDataFrame[schema.DataLoggerSchema]) – Données traitées à exporter.

• output_data_path (Path) – Chemin du répertoire d’exportation.

• file_type (FileTypes) – Type de fichier de sortie.

• resolution (float) – Résolution pour les formats raster.

Type renvoyé:

None

export.export_processed_data_and_metadata(data_geodataframe, export_data_path, vessel_config, processing_config, caris_api_config=None, tide_stations=None, vessel_name=None, software_version='', processing_context=None, output_file_name=None)

Finalise, exporte les données traitées et génère les métadonnées.

Paramètres:

• data_geodataframe (gpd.GeoDataFrame) – Données géoréférencées traitées.

• export_data_path (Path) – Répertoire de sortie pour les données.

• vessel_config – Configuration du navire.

• processing_config – Configuration du traitement.

• caris_api_config – Configuration de l’API Caris (optionnel).

• tide_stations (Optional[Collection[str]]) – Liste des stations de marées.

• vessel_name (Optional[str]) – Nom du navire pour l’export (surcharge vessel_config.name).

• software_version (str) – Version du logiciel à inscrire dans les métadonnées.

• processing_context – Contexte de traitement (type capteur, statut réduction).

• output_file_name (Optional[str]) – Nom de fichier de sortie forcé (surcharge le nom calculé automatiquement). Utilisé en mode split (merge_files=False) pour conserver le nom du fichier d’entrée.

Type renvoyé:

None

export.export_processed_data_to_file_types(data_geodataframe, output_base_path, file_types, resolution=5e-05, groub_by_iho_order=True, **kwargs)

Exporte les données traitées dans plusieurs formats de fichier.

Paramètres:

• data_geodataframe (gpd.GeoDataFrame[schema.DataLoggerWithTideZoneSchema]) – Données traitées à exporter.

• output_base_path (Path) – Chemin de base pour les fichiers d’exportation.

• file_types (Collection[FileTypes]) – Liste des types de fichiers de sortie.

• resolution (float) – Résolution pour les formats raster.

• groub_by_iho_order (bool) – Regrouper les données par ordre IHO.

Type renvoyé:

None

export.finalize_geodataframe(data_geodataframe)

Finalise le GeoDataFrame des données.

Paramètres:

data_geodataframe (gpd.GeoDataFrame[schema.DataLoggerWithTideZoneSchema]) – GeoDataFrame des données.

Renvoie:

GeoDataFrame des données finalisé.

Type renvoyé:

gpd.GeoDataFrame[schema.DataLoggerSchema]

export.get_data_structure(output_path)

Crée et retourne la structure de répertoires standard pour les sorties de traitement.

Les trois répertoires Data/, Tide/ et Log/ sont créés sous output_path s’ils n’existent pas encore.

Paramètres:

output_path (Path) – Chemin racine du répertoire de sortie.

Renvoie:

Triplet (data_path, tide_path, log_path).

Type renvoyé:

tuple[Path, Path, Path]

export.get_export_file_name(data_geodataframe, datalogger_type, vessel_name)

Récupère le nom du fichier d’exportation.

Paramètres:

• data_geodataframe (gpd.GeoDataFrame[schema.DataLoggerSchema]) – Données traitées à exporter.

• datalogger_type (str) – Type de capteur.

• vessel_name (Optional[str]) – Nom du navire.

Renvoie:

Nom du fichier d’exportation.

Type renvoyé:

str

export.sanitize_path_name(path)

Fonction qui remplace les caractères invalides dans le nom d’un fichier.

Paramètres:

path (Path) – Le chemin du fichier.

Renvoie:

Le chemin du fichier avec un nom sans caractères invalides.

Type renvoyé:

Path

export.split_data_by_iho_order(data_geodataframe)

Regroupe et sépare le GeoDataFrame par ordre IHO.

Paramètres:

data_geodataframe (gpd.GeoDataFrame[schema.DataLoggerWithTideZoneSchema]) – Le GeoDataFrame à séparer.

Renvoie:

Un dictionnaire contenant les GeoDataFrames séparés par ordre IHO.

Type renvoyé:

dict[str, gpd.GeoDataFrame]