La page de chaque outil dans Référence des outils ArcGIS Pro respecte la même structure. Apprenez à connaître la structure pour être en mesure d’utiliser n’importe quel outil.
Résumé et illustration
La section Summary (Résumé) comprend une brève description des fonctions de l’outil. Il peut contenir des liens vers des informations plus approfondies du fonctionnement de l’outil. Dans d’autres cas, le résumé est suivi d’une illustration qui explique également les fonctions de l’outil.
Utilisation
La section Usage (Utilisation) contient des remarques et des clarifications concernant l’utilisation de l’outil. Lorsque les remarques font référence à un paramètre particulier, l’étiquette du paramètre (qui apparaît dans la boîte de dialogue de l’outil) est utilisée plutôt que le nom du paramètre (qui apparaît dans la syntaxe et est utilisé dans Python). La relation entre l'étiquette et le nom du paramètre est généralement évidente, mais dans certains cas, le nom est indiqué pour éviter toute confusion.
Paramètres
La section Parameters (Paramètres) se compose de deux onglets : Dialog (Boîte de dialogue) et Python.
L’onglet Dialog (Boîte de dialogue) comporte des informations sur l’utilisation de l’outil dans la fenêtre Geoprocessing (Géotraitement).
L’onglet Python comporte des informations sur l’utilisation de l’outil dans Python. L’onglet inclut la syntaxe de l’outil, une table de paramètres avec trois colonnes : Name (Nom), Explanation (Explication) et Data Type (Type de données), ainsi qu’une section Code Sample (Exemple de code) avec des exemples illustrant l’utilisation de l’outil dans Python.
Syntaxe
Sur l’onglet Python, la première ligne qui se trouve sous l’en-tête de la syntaxe contient la signature de l’outil. Dans Python, le nom de l’outil est utilisé à la place de l’étiquette de l’outil.
- L’étiquette de l’outil apparaît en haut de la boîte de dialogue de l’outil.
- Dans Python, arcpy est suivi par l’alias de la boîte d’outils et le nom de l’outil, chacun étant séparé par un trait de soulignement. Par exemple, dans Python, l’outil Différence symétrique est identifié sous la forme arcpy.analysis.SymDiff.
Remarque :
Dans ArcPy, les outils de géotraitement sont organisés de deux manières. Tous les outils sont disponibles en tant que fonctions dans mais également dans des modules correspondant au nom d’alias de la boîte d’outils. Même si la syntaxe montre les outils sous la dernière forme, les deux approches sont équivalentes. L’approche utilisée dépend des préférences personnelles et des habitudes de codage.
Les outils sont accessibles à partir des modules correspondant au nom de la boîte d’outils.
arcpy.management.GetCount(in_features)Les outils sont accessibles en tant que fonctions dans le module arcpy.
arcpy.GetCount_management(in_features)Vous pouvez également identifier le nom du module et le nom de l’outil en faisant glisser un outil depuis la fenêtre Geoprocessing (Géotraitement) jusqu’à la fenêtre Python.
Table des paramètres
La table des paramètres comporte trois colonnes : Label (Étiquette)/Name (Nom), Explanation (Explication) et Data Type (Type de données).
La table des paramètres varie selon que vous utilisez l’onglet Dialog (Boîte de dialogue) ou Python. L’onglet Dialog (Boîte de dialogue) présente l’étiquette des paramètres et les descriptions sont tournées vers la fenêtre Geoprocessing (Géotraitement), tandis que l’onglet Python présente le nom des paramètres et les descriptions sont tournées vers l’utilisation de l’outil dans Python.
Dans les deux tables des paramètres, les différences sont les plus notables pour les paramètres booléens et les paramètres de chaîne avec mots-clés. Dans la boîte de dialogue des paramètres, les paramètres booléens sont présentés sous forme de cases à cocher et les paramètres de chaîne sont présentés sous forme d’étiquettes, tandis que dans Python, les paramètres booléens et de chaîne affichent les deux options sous forme de mots-clés de chaîne.
Remarque :
Pour afficher l’aide relative aux paramètres concernant l’utilisation de l’outil à partir de la boîte de dialogue de celui-ci, vous pouvez également survoler le bouton d’informations 
figurant à côté de chaque paramètre.
La boîte de dialogue d’un outil peut afficher les paramètres dans un ordre différent de l’ordre des paramètres réels. Ainsi, dans de rares cas, l’ordre des paramètres dans la fenêtre Geoprocessing (Géotraitement) peut être différent de l’ordre dans la table des paramètres. Pour Python, utilisez toujours l’ordre affiché dans la table des paramètres.
Nom de paramètre et étiquette
L’étiquette du paramètre est utilisée dans la boîte de dialogue de l’outil. Le nom du paramètre correspond à l’outil dans Python. La relation entre l’étiquette et le nom du paramètre est généralement évidente, mais dans certains cas, le nom du paramètre est indiqué pour éviter toute confusion.
Les paramètres d’outil peuvent être soit obligatoires soit facultatifs. Les paramètres facultatifs sont suivis de la mention (Optional [Facultatif]) dans la boîte de dialogue d’un outil.
| Type de paramètre | Description |
|---|---|
Requis |
Vous devez fournir une valeur pour les paramètres obligatoires. Ces paramètres sont toujours les premiers paramètres de la commande. |
Facultatif |
Ces paramètres suivent toujours les paramètres obligatoires. Si vous ne fournissez pas de valeur pour un paramètre facultatif, la valeur par défaut est calculée et utilisée. La valeur par défaut est décrite dans la colonne Explanation (Explication). |
Sur l’onglet Python, des informations supplémentaires s’affichent pour les paramètres qui acceptent une liste de valeurs. La syntaxe de la liste suit le nom des paramètres comme suit :
| Apparence | Description |
|---|---|
| Liste simple : les listes simples sont connues sous le nom de paramètres à valeurs multiples. |
| Liste de listes : le type de données est Value Table (Table de valeurs). |
Explication
Cette colonne offre des informations complémentaires concernant le rôle d’un paramètre et son mode de configuration, notamment des options de mots-clés.
Type de données
Tous les paramètres d'outil disposent d'un type de données associé. Certains types de données simples sont des chaînes (n'importe quel ensemble de caractères alphanumériques), booléens (valeur vraie ou fausse) et longs (valeur entière comprise entre -2 147 483 648 et 2 147 483 647). En plus de ces types de données simples, plus de cent autres types de données sont créés spécifiquement pour les données existant dans ArcGIS, comme le système de coordonnées et l’étendue.
Remarque :
La colonne Data Type (Type de données) inclut les types de données ArcGIS pris en charge pour chaque paramètre. Cela est différent des types Python pris en charge par le paramètre. Même si les paramètres vont afficher différents types de données ArcGIS, la plupart d’entre eux sont pris en charge sous forme de chaînes dans Python.
Sortie dérivée
Les paramètres dérivés sont des paramètres en sortie qui ne sont saisis ni comme valeurs dans la boîte de dialogue d’un outil, ni comme arguments dans Python. Les outils s’accompagnent de sorties dérivées dans les cas suivants :
- L’outil calcule une valeur qui a été renvoyée par l’outil ; c’est le cas de l’outil Compter qui fournit le total des enregistrements d’une table.
- L’outil modifie les jeux de données en entrée ; c’est le cas de l’outil Calculer le champ modifiant les valeurs de champ.
- Les jeux de données en sortie dont le nom ou l’emplacement est déterminé par les paramètres en entrée ou d’autres emplacements connus. C’est le cas de l’outil Classe d’entités vers classe d’entités qui détermine le chemin en sortie à partir des paramètres de noms de classes d’entités et de l’espace de travail.
Valeur renvoyée
De nombreux outils dans les extensions Spatial Analyst et Image Analyst prennent en charge le module Algèbre spatial et sont accessibles dans Python via un format algébrique. En d'autres termes, un objet dont le nom est identifié à gauche d'un signe égal est créé en fonction de l'état d'un outil ou opérateur à droite du signe égal. Ces outils incluent une section Return Value (Valeur de renvoi) qui est semblable à la section Derived Output (Sortie dérivée). Même si les paramètres dans les sections Return Value (Valeur de renvoi) ne sont pas exprimés dans Python sous forme d’argument et sont renvoyés sous forme de valeurs, ils sont différents des paramètres de sortie dérivée et sont saisis en tant que valeurs dans la boîte de dialogue d’un outil.
Exemple de code
La section Code Sample (Exemple de code) comprend un ou plusieurs exemples illustrant le mode d’exécution et d’utilisation de l’outil dans Python.
Environnements
La section Environments (Environnements) est une liste des paramètres d’environnement que l’outil respecte. Cliquez sur un lien de la liste pour accéder à sa page de référence. Si un paramètre d'environnement en particulier est important pour l'outil, des informations supplémentaires concernant ce paramètre peuvent être fournies.
Informations de licence
La section Licensing Information (Informations de licence) explique si l’outil s’exécute à des niveaux de licence en particulier et stipule si une extension est requise. Par exemple, Basic: Yes (Basic : oui) signifie que l’outil s’exécute avec une licence ArcGIS Pro Basic tandis que Basic: Requires 3D Analyst (Basic : requiert 3D Analyst) signifie qu’il ne s’exécute que si l’ArcGIS 3D Analyst extension est utilisée avec la licence ArcGIS Pro Basic.
Vous avez un commentaire à formuler concernant cette rubrique ?