csb_processing module

Module principal pour le traitement des données des capteurs à bord des navires.

Ce module contient le workflow de traitement des données des capteurs à bord des navires. Les données des capteurs sont récupérées à partir de fichiers bruts, nettoyées, filtrées, georéférencées et exportées dans un format standardisé.

exception csb_processing.VesselConfigManagerError(vessel_id, vessel_config_manager)[source]

Bases : Exception

Exception levée lorsque la configuration du gestionnaire de navires est manquante pour récupérer la configuration du navire.

vessel_config_manager: VesselManagerConfig | None

La configuration du gestionnaire de navires.

vessel_id: str

L’identifiant du navire.

csb_processing.classify_iho_order(data_geodataframe, decimal_precision)[source]

Classifie l’ordre IHO des données.

Paramètres:

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

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

Renvoie:

La qualification des données selon les ordres IHO.

Type renvoyé:

IHOorderQualifiquation

csb_processing.export_metadata(data_geodataframe, output_path, vessel_config, datalogger_type, tide_stations, decimal_precision, nbins_x=35, nbins_y=35)[source]

Exporte les métadonnées des données traitées.

Paramètres:

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

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

  • vessel_config (vessel_manager.VesselConfig) – Configuration du navire.

  • datalogger_type (DataLoggerType) – Type de capteur.

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

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

  • nbins_x (Optional[int]) – Nombre de cellules pour l’axe des X dans les graphiques.

  • nbins_y (Optional[int]) – Nombre de cellules pour l’axe des Y dans les graphiques.

Type renvoyé:

None

csb_processing.export_processed_data_and_metadata(data_geodataframe, export_data_path, vessel_config, datalogger_type, processing_config, caris_api_config=None, tide_stations=None)[source]

Exporte les données traitées et les métadonnées.

Paramètres:

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

  • export_data_path (Path) – Chemin du répertoire d’exportation des données.

  • vessel_config (vessel_manager.VesselConfig) – Configuration du navire.

  • datalogger_type (DataLoggerType) – Type de capteur.

  • processing_config (config.CSBprocessingConfig) – Configuration du traitement.

  • caris_api_config (Optional[config.CarisAPIConfig]) – Configuration de l’API Caris.

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

Type renvoyé:

None

csb_processing.get_data_structure(output_path)[source]

Récupère la structure de répertoires pour les données.

Paramètres:

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

Renvoie:

Chemin des répertoires pour les données.

Type renvoyé:

tuple[Path, Path, Path]

csb_processing.get_sensors_by_datetime(vessel_config, min_time, max_time)[source]

Méthode pour récupérer les données des capteurs et valider que la configuration du navire couvre la période de temps.

Paramètres:

  • vessel_config (vessel_manager.VesselConfig) – Configuration du navire.

  • min_time (datetime) – Date et heure minimale.

  • max_time (datetime) – Date et heure maximale.

Renvoie:

Données des capteurs pour le moment donné.

Type renvoyé:

tuple[vessel_manager.Sensor, vessel_manager.Waterline]

csb_processing.get_station_title(gdf_voronoi, station_id)[source]

Récupère le titre de la station.

Paramètres:

  • gdf_voronoi (gpd.GeoDataFrame[schema.TideZoneStationSchema]) – GeoDataFrame contenant les informations des stations.

  • station_id (str) – Identifiant de la station.

Renvoie:

Titre de la station.

Type renvoyé:

str

csb_processing.log_sounding_results(data, iterations)[source]

Vérifie et affiche les résultats du traitement des sondes.

Paramètres:

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

  • iterations (int) – Nombre d’itérations effectuées.

Renvoie:

True si des sondes ont été traitées avec succès, False sinon.

Type renvoyé:

bool

csb_processing.processing_workflow(files, vessel, output, config_path=PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/chs-csb-processing/checkouts/stable/src/CONFIG_csb-processing.toml'), apply_water_level=True, extra_logger=None, water_level_stations=None, excluded_stations=None)[source]

Workflow de traitement des données.

Paramètres:

  • files (Collection[Path]) – Liste des fichiers à traiter.

  • vessel (str | vessel_manager.VesselConfig) – Identifiant du navire ou configuration du navire.

  • output (Path) – Chemin du répertoire de sortie.

  • config_path (Optional[Path]) – Chemin du fichier de configuration.

  • apply_water_level (Optional[bool]) – Appliquer le niveau d’eau aux données.

  • extra_logger (Optional[Iterable[dict]]) – Liste d’objets de configuration supplémentaires pour le logger.

  • water_level_stations (Optional[Collection[str]]) – Liste des stations de niveau d’eau à utiliser pour le traitement.

  • excluded_stations (Optional[Collection[str]]) – Liste des stations de niveau d’eau à exclure du traitement.

Type renvoyé:

None