Summary
Extracts depth point features from a surface created within the Compose Surface window in ArcGIS for Maritime: Bathymetry. Depth features are points sampled from an interpolated raster surface. Point spacing of extracted depth features will be in the planar distance of the input spatial reference.
Depths represent a measurement of the vertical distance from a given water level to the seafloor.
Usage
Use this tool to create data for use with the Depths To ASCII tool.
The BIS Model parameter consists of a mosaic dataset, attributes, display order, and sorting rules. You create and save BIS models in the Compose Surface window in ArcGIS for Maritime: Bathymetry.
The Clipping Features parameter requires one feature. This can be a single selected feature or a feature layer with a definition query that references one feature. If Clipping Features is a path to a feature class, that feature class must contain one polygon. You can use the Create Feature Class tool to create a new feature class to store a clipping feature.
The Output Depth Features parameter is the location in which the new output feature class will be generated.
If a Bathymetric Attributed Grid (BAG) is used with this tool, both Depth and TPU values are sampled from the BAG's elevation and uncertainty bands. Depth values will be stored as part of each point's geometry, such that the output will be z-enabled, while TPU values will be added to the attribute table.
Syntax
ExtractDepths_bathymetry (bis_workspace, bis_model, clip_features, spacing_value, out_features)
| Parameter | Explanation | Data Type |
bis_workspace | The Bathymetric Information System (BIS) geodatabase (.gdb) or a connection (.sde) to the BIS database containing the surface model and mosaic dataset. | Workspace |
bis_model | The name of the composite surface in the BIS Workspace. It is prepopulated with a list of names of the models saved in the workspace. | String |
clip_features | The features that define the feature extraction extent. | Feature Layer |
spacing_value | The desired spacing between sampled points in the output, in meters. | Double |
out_features | The feature class that will contain the extracted depth features. This tool will output a new, z-enabled point feature class. | Feature Class |
Code Sample
ExtractDepths example (stand-alone script)
The following stand-alone script demonstrates how to use the ExtractDepths tool.
# Name: ExtractDepths_Example.py
# Description: Extracts point features from a BIS composite surface.
# Requirements: ArcGIS for Maritime Bathymetry
import arcpy
# setup parameters
bis_workspace = "C:/data/BIS.gdb"
bis_model = "NewModel"
clip_features = "C:/data/MyData.gdb/ClipPolyFC"
spacing_value = 50.0
out_features = "C:/output/Output.gdb/PointFC"
# execute the tool. For a stand-alone scripts, check out the extension first - arcpy.CheckOutExtension("Bathymetry")
arcpy.ExtractDepths_bathymetry(bis_workspace, bis_model, clip_features, spacing_value, out_features)
Environments
Licensing Information
- ArcGIS for Desktop Basic: No
- ArcGIS for Desktop Standard: Requires Maritime Bathymetry
- ArcGIS for Desktop Advanced: Requires Maritime Bathymetry