Référence CLI

Générée automatiquement à partir des métadonnées actives de l’analyseur CLI.

Commande principale

Exécute les commandes FloodSR liées au modèle, au cache et aux utilitaires d’exécution.

Utilisation

usage: floodsr [-h] [--version] [-v] [-q]
               [--log-level {DEBUG,INFO,WARNING,ERROR}]
               {models,tohr,doctor} ...

Commandes

models

Liste les modèles du manifeste ou récupère des poids de modèle mis en cache.

tohr

Exécute une passe de super-résolution pour un raster de profondeur à basse résolution.

doctor

Signale l’état des dépendances d’exécution et des fournisseurs.

Options

-h, --help

affiche ce message d’aide et quitte

--version

Afficher la version installée du paquet FloodSR et quitter.

-v, --verbose

Augmente le niveau de détail de journalisation (répétable).

-q, --quiet

Diminue le niveau de détail de journalisation (répétable).

--log-level {DEBUG,INFO,WARNING,ERROR}

Force explicitement le niveau de journalisation.

models

Liste les modèles du manifeste ou récupère des poids de modèle mis en cache.

Utilisation

usage: floodsr models [-h] {list,fetch} ...

Commandes

list

Liste les versions de modèle définies dans le manifeste.

fetch

Récupère un modèle du manifeste dans le cache local.

Options

-h, --help

affiche ce message d’aide et quitte

models list

Liste les versions de modèle définies dans le manifeste.

Utilisation

usage: floodsr models list [-h] [--manifest MANIFEST]

Options

-h, --help

affiche ce message d’aide et quitte

--manifest MANIFEST

Lit les modèles à partir d’un fichier models.json alternatif.

models fetch

Récupère un modèle du manifeste dans le cache local.

Utilisation

usage: floodsr models fetch [-h] [--manifest MANIFEST] [--cache-dir CACHE_DIR]
                            [--backend {http,file}] [--force]
                            [--show-progress | --no-progress]
                            version

Arguments positionnels

version

Clé de version du modèle à récupérer dans le manifeste. Les modèles intégrés comme CostGrow_Terrain renvoient les métadonnées sans télécharger les poids.

Options

-h, --help

affiche ce message d’aide et quitte

--manifest MANIFEST

Lit les modèles à partir d’un fichier models.json alternatif.

--cache-dir CACHE_DIR

Enregistre les poids téléchargés dans un autre répertoire de cache.

--backend {http,file}

Force le choix du moteur de récupération des poids.

--force

Retélécharge même lorsqu’un fichier de poids valide existe déjà en cache.

--show-progress

Affiche la progression pendant le téléchargement du modèle. Utilisez --no-progress pour la désactiver. Activée par défaut.

--no-progress

Désactive l’affichage de la progression. La progression s’affiche par défaut.

tohr

Exécute une passe de super-résolution pour un raster de profondeur à basse résolution.

Utilisation

usage: floodsr tohr [-h] [--machine-json MACHINE_JSON] --in IN_FP (--dem DEM |
                    -f) [--fetch-out FETCH_OUT] [--fetch-force-tiling]
                    [--out OUT] [--model-version MODEL_VERSION]
                    [--model-path MODEL_PATH] [--manifest MANIFEST]
                    [--cache-dir CACHE_DIR] [--backend {http,file}] [--force]
                    [--max-depth MAX_DEPTH]
                    [--min-depth-threshold MIN_DEPTH_THRESHOLD]
                    [--dem-pct-clip DEM_PCT_CLIP]
                    [--window-method {hard,feather}]
                    [--tile-overlap TILE_OVERLAP] [--tile-size TILE_SIZE]
                    [--crs-policy {strict,use-dem,use-lores}]
                    [--show-progress | --no-progress]

Options

-h, --help

affiche ce message d’aide et quitte

--machine-json MACHINE_JSON

Charge les paramètres de tohr depuis JSON; les drapeaux CLI explicites demeurent prioritaires.

--in IN_FP

Chemin du raster de profondeur à basse résolution en entrée.

--dem DEM

Chemin du raster de DEM à haute résolution en entrée.

-f, --fetch-hrdem

Récupère le HRDEM pour l’emprise du raster basse résolution au lieu de spécifier --dem.

--fetch-out FETCH_OUT

Écrit le raster HRDEM récupéré à cet emplacement plutôt que dans un emplacement temporaire.

--fetch-force-tiling

Force l’utilisation de fenêtres de récupération par tuiles du HRDEM au lieu de s’appuyer sur le tuilage automatique.

--out OUT

Chemin du raster de sortie. Par défaut : ./<input_stem>_sr<input_suffix> dans le répertoire de travail courant.

--model-version MODEL_VERSION

Version du modèle à exécuter lorsque –model-path n’est pas fourni. Utilisez ResUNet_16x_DEM pour le modèle ONNX téléchargé ou CostGrow_Terrain pour le modèle intégré basé sur des règles et s’appuyant sur PCRaster.

--model-path MODEL_PATH

Utilise un fichier modèle ONNX local explicite au lieu de résoudre un modèle téléchargé depuis le cache ou le manifeste. Cette option n’est pas utilisée par les modèles intégrés comme CostGrow_Terrain.

--manifest MANIFEST

Lit les métadonnées du modèle à partir d’un fichier models.json alternatif.

--cache-dir CACHE_DIR

Utilise un autre répertoire de cache pour les poids de modèle résolus.

--backend {http,file}

Remplace le choix du moteur d’obtention des poids du modèle.

--force

Retélécharge une version spécifique du modèle lorsque la résolution du cache ferait en sorte de le réutiliser.

--max-depth MAX_DEPTH

Profondeur maximale utilisée pour l’écrêtage des valeurs de profondeur basse résolution avant la mise à l’échelle log1p vers la plage d’entrée du modèle. Les valeurs au-dessus de ce seuil sont plafonnées pendant le prétraitement et après la mise à l’échelle inverse. La valeur par défaut actuelle pour ResUNet_16x_DEM est de 5,0.

--min-depth-threshold MIN_DEPTH_THRESHOLD

Profondeur minimale prédite conservée dans le raster final. Les valeurs sous ce seuil sont écrites comme 0.0 après l’inférence. La valeur par défaut actuelle pour ResUNet_16x_DEM est de 0,01.

--dem-pct-clip DEM_PCT_CLIP

Percentile utilisé pour plafonner les valeurs élevées du DEM avant la normalisation min-max vers [0, 1]. Des valeurs plus basses écrêtent le relief de façon plus agressive; des valeurs plus élevées conservent davantage la partie supérieure de la distribution. Utilisé lorsque des statistiques explicites de normalisation du DEM ne sont pas disponibles. La valeur par défaut actuelle de ResUNet_16x_DEM est de 95,0.

--window-method {hard,feather}

Méthode de mosaïquage des tuiles utilisée lors de l’assemblage des fenêtres du modèle. hard utilise des tuiles sans chevauchement avec écriture directe; feather utilise des tuiles qui se chevauchent avec un mélange pondéré afin de réduire les artefacts de raccord. La valeur par défaut actuelle est feather.

--tile-overlap TILE_OVERLAP

Chevauchement feather en pixels basse résolution. Ignoré sauf si --window-method=feather.

--tile-size TILE_SIZE

Remplace la taille des tuiles basse résolution; doit correspondre à la taille d’entrée LR du modèle.

--crs-policy {strict,use-dem,use-lores}

Politique de gestion des divergences de SCR entre le raster de profondeur à basse résolution et le DEM.

--show-progress

Affiche la progression pendant le téléchargement du modèle, la récupération du DEM et le traitement par tuiles à l’exécution. Utilisez --no-progress pour la désactiver. Activée par défaut.

--no-progress

Désactive l’affichage de la progression. La progression s’affiche par défaut.

doctor

Signale l’état des dépendances d’exécution et des fournisseurs.

Utilisation

usage: floodsr doctor [-h] [--json]

Options

-h, --help

affiche ce message d’aide et quitte

--json

Produit du JSON lisible par machine au lieu d’un texte orienté ligne.