Résumé
Creates a surface model within the Bathymetric Information System (BIS) workspace.
Utilisation
If an existing model name is provided for the BIS Model Name parameter, the existing model will be overwritten if the BIS is stored in a file geodatabase, or a new model version will be created if the BIS is stored in a versioned enterprise geodatabase.
The Filter Expression parameter takes a SQL expression as an input. For details on the syntax, how to construct a SQL expression, and to view examples, see Building a query expression or SQL reference for query expressions used in ArcGIS.
Once this tool has finished executing, the new surface model will be visible in the Load Surface Model and Manage Surface Model dialog boxes, accessible from the Compose Surface window.
The output of this tool can be chained to other bathymetry tools, such as Export Points or Export BIS Metadata.
When constructing a filter expression, you can reorder the fields in alphabetical ascending or descending order using the options found by clicking the down arrow in the upper right corner of the Query Builder dialog box.
Spatial Filter Geometry and Spatial Filter Method can be used to restrict the datasets added to the surface model on the basis of location rather than metadata.
If both a filter expression and a spatial filter are supplied, the resulting surface model will contain the datasets that satisfy both the metadata and location requirement.
If no value is specified for Spatial Filter Method, or if the value is left blank, INTERSECT will be applied when the tool executes.
Syntaxe
CreateSurfaceModel(bis_workspace, model_name, {filter_expression}, {filter_geometry}, {filter_method}, {rule_file}, {model_description})
Paramètre | Explication | Type de données |
bis_workspace | The Bathymetric Information System (BIS) containing the datasets and to which the surface model should be saved. This parameter accepts any geodatabase (.gdb) or enterprise database connection file (.sde) that has been registered as a BIS and which is on the latest version. | Workspace |
model_name | The name to associate with the surface model being saved. Providing an existing surface model's name will overwrite that model in a file geodatabase BIS or save a new version in a versioned enterprise BIS. | String |
filter_expression (Facultatif) | The SQL expression used to filter datasets in the BIS by their associated metadata. | SQL Expression |
filter_geometry (Facultatif) | The point, line, or polygon geometry that should be used to spatially constrain the datasets saved to the surface model. | Feature Layer |
filter_method (Facultatif) | The spatial relationship to apply to the BIS dataset using the specified filter geometry.
| String |
rule_file (Facultatif) | The rule file that determines the sort order of datasets in the surface model. This is used to deconflict the surface where multiple datasets overlap and can be saved from the Compose Surface window. Leaving this parameter blank will result in the datasets being ordered alphabetically by their dataset name. | File |
model_description (Facultatif) | A short piece of text describing the surface model. This is limited to 255 characters. | String |
Exemple de code
CreateSurfaceModel example (stand-alone script)
The following stand-alone script demonstrates how to use the CreateSurfaceModel tool.
# Name: CreateSurfaceModel_Ex1.py
# Description: Creates a surface model comprised of a filtered and ordered list of datasets within a BIS geodatabase
# Requirements: ArcGIS for Maritime Bathymetry
import arcpy
arcpy.CheckOutExtension("Bathymetry")
# set up parameters
bis_workspace = r"C:\Data\BIS.gdb"
model_name = "Golden Gate Seafloor"
filter_expression = "(BISDatasetType = 'Gridded BAG' AND CellSize <= 5) AND NOT ExtSurveyDate <= 01/01/2014"
filter_geometry = r"C:\Data\Areas.gdb\GoldenGate"
filter_method = "INTERSECT"
rule_file = r" C:\Users\BathyAdmin\AppData\Roaming\ESRI\Bathymetry10.4\SavedRules\OrderedBy_Date_Cellsize.rul"
model_description = "Recent, high-resolution bathymetry for the Golden Gate region of the greater San Francisco Bay"
# execute the tool
arcpy.CreateSurfaceModel_bathymetry(bis_workspace, model_name, filter_expression, filter_geometry, filter_method, rule_file, model_description)
Environnements
Informations de licence
- Basic: Non
- Standard: Requiert Maritime Bathymetry
- Advanced: Requiert Maritime Bathymetry