Aufbau einer Referenzseite zu einem Geoverarbeitungswerkzeug
Die Referenzseiten zu den einzelnen Geoverarbeitungswerkzeugen in ArcGIS Pro sind gleich aufgebaut. In diesem Thema wird der Aufbau beschrieben und der Zweck der einzelnen Abschnitte erläutert.
Zusammenfassung und Abbildung
Der Abschnitt Zusammenfassung enthält eine kurze Beschreibung zur Funktionsweise des Werkzeugs. Sie kann Links zu ausführlicheren Informationen zur Funktionsweise des Werkzeugs enthalten. In einigen Fällen folgt eine Abbildung auf die Zusammenfassung, anhand derer die Funktionsweise des Werkzeugs ebenfalls erläutert wird.
Verwendung
Der Abschnitt Verwendung enthält Hinweise und Erklärungen zur Verwendung des Werkzeugs. Wenn sich die Hinweise auf einen bestimmten Parameter beziehen, wird die Parameterbeschriftung, die im Werkzeugdialogfeld angezeigt wird, verwendet und nicht der Parametername, der in der Syntax angezeigt und in Python genutzt wird. Der Zusammenhang zwischen Parameterbeschriftung und dem -namen ist normalerweise offensichtlich; in einigen Fällen wird jedoch der Name angegeben, um Verwechslungen zu vermeiden.
Parameter
Der Abschnitt Parameter ist in zwei Registerkarten gegliedert: Dialogfeld und Python.
Die Registerkarte Dialogfeld enthält Parameterinformationen zur Verwendung des Werkzeugs im Bereich Geoverarbeitung.
Die Registerkarte Python enthält Informationen zur Verwendung des Werkzeugs in Python. Die Registerkarte umfasst die Werkzeugsyntax, eine Parametertabelle mit den drei Spalten Name, Erläuterung und Datentyp und den Bereich Codebeispiel mit Beispielen zur Verwendung des Werkzeugs in Python.
Syntax
Die erste Zeile auf der Registerkarte "Python" unter der Überschrift "Syntax" enthält die Werkzeugsignatur. Für Python wird anstelle der Beschriftung der Name des Werkzeugs verwendet.
Die Werkzeugbeschriftung wird am oberen Rand des Werkzeugdialogfeldes angezeigt.
In Python werden hinter
arcpyder Toolbox-Aliasname und der Werkzeugname angegeben (jeweils durch einen Punkt getrennt). Beispiel: In Python wird das Werkzeug Symmetrische Differenz alsarcpy.analysis.SymDiffangegeben.Da Werkzeuge in den Toolboxes "Spatial Analyst" und "Image Analyst" häufig aus den Modulen
saundiafür Map Algebra importiert werden, zeigt die Syntax für diese Werkzeuge nur den Werkzeugnamen.
Hinweis:
In ArcPy sind Geoverarbeitungswerkzeuge auf zwei Arten organisiert. Alle Werkzeuge sind als Funktionen aus dem Namespace arcpy und auch in Modulen, die dem Toolbox-Aliasnamen entsprechen, verfügbar. In der Syntax werden die Werkzeuge in der letztgenannten Form dargestellt, es sind jedoch beide Methoden gültig. Welche Vorgehensweise Sie verwenden, hängt von den persönlichen Vorlieben und Codierungsgewohnheiten ab.
Werkzeuge können über Module, die mit dem Toolbox-Namen übereinstimmen, aufgerufen werden.
arcpy.management.GetCount(in_features)
Werkzeuge können als Funktionen im arcpy-Modul aufgerufen werden.
arcpy.management.GetCount(in_features)
Der Modulname und Werkzeugname können auch identifiziert werden, indem ein Werkzeug aus dem Bereich Geoverarbeitung in das Python-Fenster gezogen wird.
Parametertabelle
Die Parametertabelle enthält drei Spalten: Beschriftung/Name, Erläuterung und Datentyp.
Die Parametertabelle wird abhängig davon, ob Sie sich auf der Registerkarte Dialogfeld oder Python befinden, unterschiedlich dargestellt. Auf der Registerkarte Dialogfeld wird die Parameterbeschriftung angezeigt, und die Beschreibungen sind am Bereich Geoverarbeitung ausgerichtet. Auf der Registerkarte Python dagegen wird der Parametername angezeigt, und die Beschreibungen beziehen sich auf die Verwendung des Werkzeugs in Python.
Die Unterschiede in den beiden Parametertabellen sind bei booleschen Parametern und Zeichenfolgenparametern mit Schlüsselwörtern am offensichtlichsten. Im Dialogfeld des Parameters werden boolesche Parameter als Kontrollkästchen angezeigt und Zeichenfolgenparameter als Beschriftungen. In Python dagegen werden für boolesche Parameter und Zeichenfolgenparameter Auswahlmöglichkeiten als Zeichenfolgen-Schlüsselwörter angezeigt.
Hinweis:
Die Parameterhilfe lässt sich auch aufrufen, wenn Sie mit der Maus auf die Schaltfläche "Information" 
neben dem jeweiligen Parameter zeigen.
In einem Werkzeugdialogfeld können Parameter in einer anderen Reihenfolge als der tatsächlichen Parameterreihenfolge angezeigt werden. Das heißt, in manchen Fällen entspricht die Reihenfolge der Parameter im Bereich Geoverarbeitung möglicherweise nicht der Reihenfolge in der Parametertabelle. Verwenden Sie für Python immer die Reihenfolge in der Parametertabelle.
Parameternamen im Vergleich zu Parameterbeschriftungen
Die Parameterbeschriftung wird im Dialogfeld des Werkzeugs verwendet. Der Parametername steht für das Werkzeug in Python. Der Zusammenhang zwischen Parameterbeschriftung und dem -namen ist normalerweise offensichtlich; in einigen Fällen wird jedoch der Parametername angegeben, um Verwechslungen zu vermeiden.
Werkzeugparameter können erforderlich oder optional sein. In der Tabelle Parameter sind optionale Parameter mit dem Vermerk (Optional) gekennzeichnet.****
| Parametertyp | Beschreibung |
|---|---|
| Erforderlich | Für erforderliche Parameter müssen Sie Werte angeben. Diese Parameter sind stets die ersten Parameter im Befehl. |
| Optional | Diese Parameter stehen stets hinter den erforderlichen Parametern. Wenn Sie keinen Wert für einen optionalen Parameter angeben, wird der Standardwert berechnet und verwendet. Der Standardwert wird in der Spalte Erläuterung beschrieben. |
Auf der Registerkarte Python werden zusätzliche Informationen für Parameter, die eine Liste von Werten akzeptieren, angezeigt. Die Syntax der Liste hängt wie folgt vom Parameternamen ab:
| Aussehen | Beschreibung |
|---|---|
 |
Einfache Liste: Einfache Listen sind MultiValue-Parameter. |
 |
Liste aus Listen: Der Datentyp ist Value Table. |
Erläuterung
Diese Spalte stellt weitere Informationen zur Verwendung und Einstellung eines Parameters bereit, einschließlich Schlüsselwortoptionen.
Datentyp
Jedem Werkzeugparameter ist ein Datentyp zugewiesen. Einige einfache Datentypen sind Zeichenfolgen (eine beliebige alphanumerische Zeichenkette), boolesche Variablen (wahr oder falsch) und ganze Zahlen (Ganzzahlwerte zwischen -2.147.483.648 und 2.147.483.647). Darüber hinaus gibt es noch viele weitere spezielle Datentypen für die Daten in ArcGIS, beispielsweise "Koordinatensystem" und "Ausdehnung".
Hinweis:
Die Spalte Datentyp enthält die unterstützten ArcGIS-Datentypen für die einzelnen Parameter. Dies ist anders als bei den Python-Typen, die vom Parameter unterstützt werden. Parameter weisen eine Vielzahl von ArcGIS-Datentypen auf, die meisten Parameter werden jedoch als Zeichenfolgen aus Python unterstützt.
Abgeleitete Ausgabe
Abgeleitete Parameter sind Ausgabeparameter, die nicht als Werte im Dialogfeld eines Werkzeugs oder als Argumente in Python eingegeben werden. Werkzeuge haben in folgenden Fällen abgeleitete Ausgaben:
Das Werkzeug berechnet einen Wert, der von dem Werkzeug ausgegeben wird, wie z. B. das Werkzeug Anzahl erhalten, mit dem die Anzahl von Datensätzen in einer Tabelle ermittelt wird.
Das Werkzeug ändert Eingabe-Datasets, wie z. B. das Werkzeug Feld berechnen, mit dem Feldwerte geändert werden.
Ausgabe-Datasets, deren Name oder Position anhand von Eingabeparametern oder anderen bekannten Positionen ermittelt wird, wie das Werkzeug Tabelle erstellen, mit dem der Ausgabepfad anhand der Parameter für "Workspace" und "Name der Feature-Class" ermittelt wird.
Rückgabewert
Viele der Werkzeuge in den Erweiterungen "Spatial Analyst" und "Image Analyst" unterstützen Map Algebra und werden in Python durch ein algebraisches Format aufgerufen. Das heißt, ein Objekt, dessen Name links neben einem Gleichheitszeichen angegeben wird, wird basierend auf einem rechts neben dem Gleichheitszeichen angegebenen Werkzeug oder Operator erstellt. Diese Werkzeuge enthalten den Abschnitt Rückgabewert, der dem Abschnitt Abgeleitete Ausgabe ähnlich ist. Auch wenn Parameter in den Abschnitten Rückgabewert in Python nicht als Argument ausgedrückt und als Werte zurückgegeben werden, unterscheiden sie sich von abgeleiteten Ausgabeparametern und werden im Dialogfeld eines Werkzeugs als Werte eingegeben.
Weitere Informationen zu Map Algebra
Codebeispiel
Der Abschnitt Codebeispiel umfasst mindestens ein Beispiel, in dem die Ausführung und Verwendung des Werkzeugs in Python veranschaulicht wird.
Umgebungen
Der Abschnitt Umgebungen ist eine Liste der Umgebungseinstellungen, die vom Werkzeug berücksichtigt werden. Klicken Sie auf einen beliebigen Link in der Liste, um die entsprechende Referenzseite aufzurufen. Wenn eine bestimmte Umgebungseinstellung für das Werkzeug eine besondere Bedeutung hat, werden möglicherweise weitere Informationen zu dieser Einstellung angeführt.
Lizenzierungsinformationen
Der Abschnitt Lizenzierungsinformationen enthält Details dazu, ob das Werkzeug in bestimmten Lizenzierungsstufen ausgeführt wird und ob eine Erweiterung erforderlich ist. Basic: Ja bedeutet beispielsweise, dass das Werkzeug mit einer ArcGIS Pro Basic-Lizenz ausgeführt wird, wohingegen Basic: 3D Analyst erforderlich bedeutet, dass es nur dann ausgeführt wird, wenn die Erweiterung "ArcGIS 3D Analyst" mit der ArcGIS Pro Basic-Lizenz verwendet wird.
Referenzen
Verweist auf wissenschaftliche Publikationen oder andere verlässliche Quellen, die die vom Werkzeug verwendete Theorie, Methodik oder die Algorithmen untermauern.
Verwandte Themen
Enthält Links zu Themen verwandter Werkzeuge oder zugehörigen Konzepten, die beim Erkunden der entsprechenden Funktionalität zu unterstützen.