Résumé
Environment settings are exposed as properties on the env class. These properties can be used to retrieve the current values or to set them. Geoprocessing environment settings can be thought of as additional parameters that affect a tool's results.
Discussion
Starting at ArcGIS Pro 2.9, invalid environment names will fail with an AttributeError exception.
Propriétés
| Propriété | Explication | Type de données |
| addOutputsToMap (Lecture et écriture) | The tool's resulting output datasets will be added to the application display. The property is only applicable when used directly in the Python window or from a Notebook in ArcGIS Pro. | Boolean |
| annotationTextStringFieldLength (Lecture et écriture) | Les outils qui respectent l’environnement Longueur du champ de chaîne de texte d’annotation priment sur la longueur de champ par défaut du champ TextString dans les classes d’entités annotations créées dans une base de données. Learn more about annotationTextStringFieldLength. | Long |
| autoCancelling (Lecture et écriture) | When autoCancelling is set to True, a cancellation will end the script on the current line. If False, a cancellation will set the isCancelled property to True and continue executing. The default is True. For use in script tools or Python toolbox tools. Learn more about cancellation behavior. | Boolean |
| autoCommit (Lecture et écriture) | Les outils dédiés à l'environnement Validation automatique exécutent forcément une validation une fois que le nombre de changements spécifié a été effectué dans une transaction de géodatabase d'entreprise. Learn more about autoCommit. | Long |
| baDataSource (Lecture et écriture) | Les outils qui prennent en compte l’environnement Data Source (Source de données) sont conformes à la manière dont les données sont synthétisées d’une couche à une autre. Cet environnement s’applique uniquement aux outils Business Analyst. Learn more about baDataSource. | String |
| baNetworkSource (Lecture et écriture) | Les outils qui prennent en compte l’environnement Source de réseau vous permettent de définir votre service ou jeu de données réseau utilisé pour les tâches de calcul de la distance de réseau. Ce comportement s’applique uniquement aux outils Business Analyst. Learn more about baNetworkSource. | String |
| baUseDetailedAggregation (Lecture et écriture) | Les outils qui respectent l’environnement Utiliser l’agrégation détaillée utiliseront la méthode d’agrégation détaillée des données pour les zones qui se trouvent au-delà du rayon spécifié. Seuls les outils Business Analyst utilisent cet environnement. Learn more about baUseDetailedAggregation. | Boolean |
| buildStatsAndRATForTempRaster (Lecture et écriture) | Controls the calculation of statistics and building of raster attribute tables (RAT) for temporary rasters created by Spatial Analyst tools. The environment is only used from the interactive Python window in the application. The default is True. When set to False, the statistics will be approximate for the purpose of symbolizing raster layers, and no RAT will be built. | Boolean |
| cartographicCoordinateSystem (Lecture et écriture) | Les outils dédiés à l'environnement Système de coordonnées cartographiques utilisent le système de coordonnées cartographiques indiqué pour déterminer la taille, l'étendue et les relations spatiales des entités pour effectuer des calculs. Learn more about cartographicCoordinateSystem. | String |
| cartographicPartitions (Lecture et écriture) | Les outils qui respectent l'environnement Partitions cartographiques subdivisent les entités en entrée par les entités surfaciques de partition spécifiées pour un traitement séquentiel pour contourner les limites de la mémoire qui peuvent survenir avec les jeux de données volumineux. Learn more about cartographicPartitions. | String |
| cellSize (Lecture et écriture) | Les outils dédiés à l’environnement Celle Size (Taille de cellule) définissent la taille de cellule raster en sortie, ou résolution, de l’opération. La résolution en sortie par défaut est déterminée par le plus grossier des jeux de données raster en entrée. Learn more about cellSize. | String |
| cellSizeProjectionMethod (Lecture et écriture) | Les outils qui respectent l’environnement Cell Size Projection Method (Méthode de projection de la taille de cellule) utiliseront la méthode spécifiée pour calculer la taille de cellule du raster en sortie lorsque des jeux de données sont projetés au cours de l’analyse. Learn more about cellSizeProjectionMethod. | String |
| coincidentPoints (Lecture et écriture) | Les outils dédiés à l’environnement Coincident Points (Points coïncidents) définissent la façon dont les données coïncidentes sont gérées dans Geostatistical Analyst. Learn more about coincidentPoints. | String |
| compression (Lecture et écriture) | Les outils dédiés à l’environnement Compression définissent le type de compression lorsqu’ils stockent les jeux de données raster en sortie. Learn more about compression. | String |
| configKeyword (Lecture et écriture) | Les outils dédiés à l’environnement Output CONFIG Keyword (Mot-clé CONFIG en sortie) utilisent le mot-clé indiqué lors de la création de jeux de données dans une géodatabase. Learn more about configKeyword. | String |
| extent (Lecture et écriture) | Les outils qui respectent l'environnement Etendue traitent uniquement les entités ou rasters qui se trouvent au sein de l'étendue spécifiée dans ce paramètre. Learn more about extent. | String |
| geographicTransformations (Lecture et écriture) | Les outils qui respectent l'environnement Transformations géographiques utilisent les méthodes de transformation lors de la projection de données. Learn more about geographicTransformations. | String |
| gpuId (Lecture et écriture) | Les outils dédiés à l’environnement GPU ID (ID de GPU) identifient le GPU à utiliser pour traiter vos données. Learn more about gpuId. | Long |
| isCancelled (Lecture seule) | When autoCancelling is set to False and the tool has been cancelled, isCancelled will be set to True. isCancelled is False by default and is a read-only property. For use in script tools or Python toolbox tools. Learn more about cancellation behavior. | Boolean |
| maintainAttachments (Lecture et écriture) | Les outils dédiés à l’environnement Maintain Attachments (Conserver les pièces jointes) copient les pièces jointes des entités en entrée vers les entités en sortie. Une table de pièces jointes et une classe de relations sont créées. Learn more about maintainAttachments. | Boolean |
| maintainCurveSegments (Lecture et écriture) | Les outils qui prennent en compte l’environnement Maintain Curve Segments (Conserver les segments de courbe) préservent les segments de courbe en entrée dans la sortie. Learn more about maintainCurveSegments. | Boolean |
| maintainSpatialIndex (Lecture et écriture) | Héritage :L’environnement Maintain Spatial Index (Conserver un index spatial) n’est pas respecté dans ArcGIS Pro. Pour bénéficier du même comportement que l’environnement Maintain Spatial Index (Conserver un index spatial) dans ArcGIS Pro lors de l’exécution d’outils et de processus qui effectuent des opérations d’insertion, de mise à jour et de suppression sur des données existantes dans des géodatabases d’entreprise, vous pouvez contrôler l’index spatial à l’aide de l’outil Supprimer un index spatial afin de supprimer l’index spatial avant le traitement, ainsi que de l’outil Ajouter un index spatial pour recréer l’index spatial après le traitement. L’outil Ajouter prend également en charge ce processus avec les données de géodatabase fichier. | Boolean |
| mask (Lecture et écriture) | Les outils dédiés à l'environnement Masque ne prennent en compte que les cellules qui se trouvent dans le masque d'analyse de l'opération. Learn more about mask. | String |
| matchMultidimensionalVariable (Lecture et écriture) | Les outils qui prennent en charge l’environnement Apparier la variable multidimensionnelle ne génèrent un raster multidimensionnel que si les rasters multidimensionnels en entrée partagent au moins une variable portant le même nom. Learn more about matchMultidimensionalVariable. | String |
| MDomain (Lecture et écriture) | Les outils qui respectent l'environnement Domaine M en sortie génèrent des jeux de données de géotraitement en sortie dotés du domaine de mesure (M) spécifié. Learn more about MDomain. | String |
| MResolution (Lecture et écriture) | Les outils dédiés à l’environnement M Resolution (Résolution M) appliquent la résolution M à des jeux de données géographiques en sortie. La résolution m, exprimée comme une très petite distance, fait référence au nombre de bits significatifs utilisés pour stocker des valeurs m. Learn more about MResolution. | Double |
| MTolerance (Lecture et écriture) | Les outils dédiés à l’environnement M Tolerance (Tolérance M) remplacent la tolérance m par défaut dans les jeux de données géographiques créés dans une géodatabase. Learn more about MTolerance. | Double |
| nodata (Lecture et écriture) | Les outils qui respectent l’environnement NoData traitent uniquement les rasters dans lesquels la valeur NoData est valide. Learn more about nodata. | String |
| outputCoordinateSystem (Lecture et écriture) | Les outils qui respectent l'environnement Système de coordonnées en sortie créent des jeux de données géographiques en sortie dotés du système de coordonnées spécifié. Learn more about outputCoordinateSystem. | String |
| outputMFlag (Lecture et écriture) | Les outils dédiés à l’environnement Output has M Values (Valeurs M en sortie) déterminent si le jeu de données géographiques en sortie stocke des valeurs m. Learn more about outputMFlag. | String |
| cellAlignment (Lecture et écriture) | Outil dédié à l’environnement Cell Alignment (Alignement des cellules) qui ajuste l’alignement des cellules de la sortie de telle sorte qu’il corresponde à l’alignement de l’étendue de traitement spécifié. Learn more about cellAlignment | String |
| outputZFlag (Lecture et écriture) | Les outils qui respectent l'environnement Valeurs Z en sortie déterminent si le jeu de données géographiques en sortie aura des valeurs Z. Learn more about outputZFlag. | String |
| outputZValue (Lecture et écriture) | Les outils dédiés à l’environnement Default Output Z Value (Valeur Z en sortie par défaut) définissent les coordonnées z pour chaque sommet en sortie qui n’en possède pas déjà. Learn more about outputZValue. | String |
| overwriteOutput (Lecture et écriture) | Controls whether tools will automatically overwrite any existing output when run. When set to True, tools will execute and overwrite the output dataset. When set to False, existing outputs will not be overwritten, and the tool will return an error. | Boolean |
| packageWorkspace (Lecture seule) | Le paramètre d'environnement Espace de travail de paquetage est l'emplacement d'un dossier qui localise le contenu d'un paquetage ou service de géotraitement partagé. Learn more about packageWorkspace. | String |
| parallelProcessingFactor (Lecture et écriture) | Les outils conformes à l'environnement Facteur de traitement parallèle répartissent et réalisent les opérations sur plusieurs processus. Learn more about parallelProcessingFactor. | Integer |
| processingServer (Lecture et écriture) | Les outils dédiés à l’ensemble d’environnements Remote Processing Server (Serveur de traitement à distance) indiquent le serveur, le nom d’utilisateur et le mot de passe de ArcGIS Server lorsque vous utilisez l’environnement Parallel Processing Factor (Facteur de traitement parallèle). Adresse IP ou nom du serveur ArcGIS dont le service du système de traitement raster est activé. Si le serveur de traitement est une grappe de serveurs, utilisez le nom du serveur qui est l’hôte du site. Learn more about processingServer. | String |
| processingServerPassword (Lecture et écriture) | Les outils dédiés à l’ensemble d’environnements Remote Processing Server (Serveur de traitement à distance) indiquent le serveur, le nom d’utilisateur et le mot de passe de ArcGIS Server lorsque vous utilisez l’environnement Parallel Processing Factor (Facteur de traitement parallèle). Mot de passe associé au nom de l'utilisateur autorisé à utiliser le service Traitement raster. Learn more about processingServerPassword. | String |
| processingServerUser (Lecture et écriture) | Les outils dédiés à l’ensemble d’environnements Remote Processing Server (Serveur de traitement à distance) indiquent le serveur, le nom d’utilisateur et le mot de passe de ArcGIS Server lorsque vous utilisez l’environnement Parallel Processing Factor (Facteur de traitement parallèle). Nom de l'utilisateur autorisé à utiliser le service Traitement raster. Learn more about processingServerUser. | String |
| processorType (Lecture et écriture) | Les outils dédiés à l’environnement Processor Type (Type de processeur) permettent de déterminer où et comment traiter les données. Learn more about processorType. | Long |
| pyramid (Lecture et écriture) | Les outils dédiés à l’environnement Pyramid (Pyramide) ne traitent que les rasters de pyramides valides. Vous pouvez définir un nombre limité d'options pour les pyramides des fichiers ERDAS IMAGINE. Learn more about pyramid. | String |
| qualifiedFieldNames (Lecture et écriture) | Les outils dédiés à l’environnement Maintain fully qualified field names (Gérer les noms de champs complets) utilisent ce paramètre pour faire la distinction entre les noms de champs qualifiés et non qualifiés. Les noms de champs qualifiés sont les noms des champs d’une classe d’entités ou d’une table auxquels est ajouté le nom de la classe d’entités ou de la table d’origine. Ce paramètre est approprié dans le cadre de l'utilisation de données jointes. Learn more about qualifiedFieldNames. | Boolean |
| randomGenerator (Lecture et écriture) | Les outils qui utilisent l'environnement Générateur de nombres aléatoires ont recours à des algorithmes faisant appel à des valeurs germes et à la distribution pour générer une séquence de nombres aléatoires. Learn more about randomGenerator. | Object |
| rasterStatistics (Lecture et écriture) | Les outils dédiés à l'environnement Statistiques raster contrôlent le mode de génération des statistiques pour les jeux de données raster en sortie. Learn more about rasterStatistics. | String |
| recycleProcessingWorkers (Lecture et écriture) | Les outils qui prennent en compte l’environnement Recycle Interval Of Processing Workers (Intervalle de recyclage des processus de travail) définissent la manière dont les sections d’image sont traitées avant le redémarrage de processus de travail pour éviter tout risque de perte au terme de longs traitements. Learn more about recycleProcessingWorkers | Long |
| referenceScale (Lecture et écriture) | Les outils dédiés à l’environnement Reference Scale (Échelle de référence) tiennent compte de l’étendue et de la taille graphiques des entités symbolisées telles qu’elles apparaissent sur l’échelle de référence. Learn more about referenceScale. | Double |
| resamplingMethod (Lecture et écriture) | Les outils dédiés à l’environnement Resample (Ré-échantillonner) interpolent les valeurs de pixel tout en transformant le jeu de données raster. Il est utilisé lorsque l'entrée et la sortie ne s'alignent pas exactement, lorsque la taille de pixel change, lorsque les données sont déplacées, ou pour plusieurs de ces raisons. Learn more about resamplingMethod. | String |
| retryOnFailures (Lecture et écriture) | Les outils dédiés à l’environnement Number of Retries On Failures (Nombre de nouvelles tentatives en cas d’échecs) relancent le même processus de travail le nombre de fois spécifié en cas d’échec d’une tâche particulière. Learn more about retryOnFailures. | Long |
| scratchFolder (Lecture seule) | Le paramètre d’environnement Scratch Folder (Dossier temporaire) est l’emplacement d’un dossier que vous pouvez utiliser pour écrire des données basées sur un fichier, telles que les shapefiles, les fichiers texte et les fichiers de couches. Learn more about scratchFolder. | String |
| scratchGDB (Lecture seule) | Le paramètre d’environnement Scratch GDB (Géodatabase temporaire) est l’emplacement d’une géodatabase fichier que vous pouvez utiliser pour écrire des données temporaires. Learn more about scratchGDB. | String |
| scriptWorkspace (Lecture seule) | Script Workspace (Espace de travail de script) correspond à l’emplacement d’un projet et est utilisé par les outils de géotraitement lorsqu’ils ont été inclus dans un paquetage de projet (fichier .ppkx) et extraits. | String |
| scratchWorkspace (Lecture et écriture) | Les outils dédiés à l’environnement Scratch Workspace (Espace de travail temporaire) utilisent l’emplacement spécifié comme espace de travail par défaut pour les jeux de données en sortie. L’espace de travail temporaire est destiné aux données en sortie que vous ne souhaitez pas conserver. Learn more about scratchWorkspace. | String |
| snapRaster (Lecture et écriture) | Les outils dédiés à l'environnement Raster de capture ajustent l'étendue des rasters en sortie, de telle sorte qu'ils correspondent à l'alignement des cellules du raster de capture spécifié. Learn more about snapRaster. | String |
| S100FeatureCatalogueFile (Lecture et écriture) | Les outils dédiés à l’environnement S-100 Feature Catalogue File (Fichier de catalogue des entités S-100) utilisent le fichier indiqué pour apparier des objets, des attributs, des classes d’entités et des relations lors de l’importation des données et lors de la création de structures de base de données. Learn more about S100FeatureCatalogueFile. | String |
| terrainMemoryUsage (Lecture et écriture) | Les outils dédiés à l’environnement Minimize memory use during analysis on terrains (Réduire l’utilisation de la mémoire pendant l’analyse sur les terrains) contrôlent l’utilisation de la mémoire lors des analyses effectuées sur les MNT. Learn more about terrainMemoryUsage. | Boolean |
| tileSize (Lecture et écriture) | Les outils dédiés à l'environnement Taille de tuile définissent la taille de tuile des rasters stockés dans des blocs de données. Learn more about tileSize. | String |
| tinSaveVersion (Lecture et écriture) | Les outils qui respectent l'environnement Version de stockage TIN par défaut génèrent des surfaces TIN dans la version spécifiée. Learn more about tinSaveVersion. | String |
| transferDomains (Lecture et écriture) | Les outils dédiés à l’environnement Transfer field domain descriptions (Transférer les descriptions des domaines de champs) contrôlent si les shapefiles et les tables dBASE (.dbf) en sortie présentent des champs supplémentaires contenant des descriptions de domaine et de sous-type, en plus des champs contenant des codes de domaine et de sous-type. Ce paramètre n’est pertinent que si l’entrée d’un outil de géotraitement est une classe d’entités ou une table de géodatabase dont les domaines et les sous-types sont définis. Par défaut, seuls les codes de domaine et de sous-type sont inclus dans le shapefile ou la table dBASE en sortie. Learn more about transferDomains. | Boolean |
| transferGDBAttributeProperties (Lecture et écriture) | Les outils qui respectent l’environnement Transférer les propriétés des champs de géodatabase, transfèrent les domaines, sous-types, règles attributaires, groupes de champs et valeurs conditionnelles depuis les champs du jeu de données en entrée vers les champs du jeu de données en sortie. Learn more about transferGDBAttributeProperties. | Boolean |
| unionDimension (Lecture et écriture) | Les outils qui prennent en charge l’environnement Union Dimensions (Union des dimensions) génèrent un raster multidimensionnel qui inclut toutes les dimensions des rasters multidimensionnels en entrée. Learn more about unionDimension. | Boolean |
| workspace (Lecture et écriture) | Les outils dédiés à l’environnement Current Workspace (Espace de travail courant) utilisent l’espace de travail indiqué comme emplacement par défaut pour les entrées et les sorties des outils de géotraitement. Learn more about currentWorkspace. | String |
| XYDomain (Lecture et écriture) | Les outils qui respectent l'environnement Domaine XY en sortie appliquent le domaine x,y du jeu de données géographiques en sortie à la plage spécifiée. Learn more about XYDomain. | String |
| XYResolution (Lecture et écriture) | Les outils adaptés à l’environnement Résolution XY appliquent la résolution x,y aux jeux de données géographiques de sortie. La résolution x,y, exprimée sous la forme d'une très petite distance, fait référence au nombre de chiffres significatifs utilisés pour stocker des valeurs de coordonnées x,y. Learn more about XYResolution. | String |
| XYTolerance (Lecture et écriture) | Les outils adaptés à l’environnement Tolérance XY écrasent la tolérance x,y par défaut des jeux de données géographiques créé dans une géodatabase. Learn more about XYTolerance. | String |
| ZDomain (Lecture et écriture) | Les outils qui respectent l'environnement Domaine Z en sortie créent des jeux de données de géotraitement en sortie dotés du domaine z spécifié. Learn more about ZDomain. | String |
| ZResolution (Lecture et écriture) | Les outils dédiés à l’environnement Z Resolution (Résolution Z) appliquent la résolution z à des jeux de données géographiques en sortie. La résolution z, exprimée sous la forme d'une très petite distance, fait référence au nombre de chiffres significatifs utilisés pour stocker des valeurs de coordonnées z. Learn more about ZResolution. | String |
| ZTolerance (Lecture et écriture) | Les outils dédiés à l’environnement Z Tolerance (Tolérance Z) remplacent la tolérance z par défaut dans les jeux de données géographiques créés dans une géodatabase. Learn more about ZTolerance. | String |
Rubriques connexes
Vous avez un commentaire à formuler concernant cette rubrique ?