Summary
Extracts depths from a surface model stored in a BIS workspace and converts depths to an ASCII file. This model allows you to share your depths with non-Esri software packages. This model runs Extract Depths and Depths To ASCII to create an output feature class and ASCII file.
Usage
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 ASCII File parameter references a text file that contains X, Y, Z, and uncertainty attributes from a BIS points feature class. Uncertainty can vary depending on the type of BAG. Depth derived from a BAG created for navigation would specify elevation uncertainty.
Before you can run this model, you will need to have done the following:
- Generate a surface model from bathymetry data managed in your BIS.
- Create a polygon feature whose geometry will be the clipping area or the area in which the depths will be extracted from.
Syntax
ExtractDepthstoASCII_bathymetry (BIS_Workspace, BIS_Model, Clipping_Features, Spacing__m_, Output_Depth_Features, Output_ASCII_File)
| 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 |
Clipping_Features | The features that define the feature extraction extent. | Feature Layer |
Spacing__m_ | The desired spacing between sampled points in the output, in meters. | Double |
Output_Depth_Features | The feature class that will contain the extracted depth features. This tool will output a new, z-enabled point feature class. | Feature Class |
Output_ASCII_File | The text file to which features will be written. | File |
Code Sample
ExtractDepthstoASCII example (Python window)
The following Python window script demonstrates how to use the ExtractDepthstoASCII tool.
# Name: ExtractingDepthstoASCII_Example.py
# Description: Extracts depths from a surface model and writes them to an ASCII file.
# Requirements: ArcGIS for Maritime Bathymetry
# Import the arcpy module
import arcpy
# check out the extension
arcpy.CheckOutExtension("Bathymetry")
# reference the BIS workspace
BIS_Workspace = "C:/Data/BIS/MyBIS.gdb"
# reference the surface model
BIS_Model = "My Model"
# point to the clipping feature class
Clipping_Features = "C:/Data/AOI/AOI.gdb/ClippingFC"
# Define the depth spacing value in meters
Spacing__m_ = 25
# point to where the Depths feature class will be created
Output_Depth_Features = "C:/Data/BIS/MyBIS.gdb/Depths"
# Define the ASCII file name and where it will get written to
Output_ASCII_File = "C:/Data/Output/Depths2ASCII.txt"
# execute the Extract Depths to ASCII model
arcpy.ExtractDepthstoASCII_bathymetry(BIS_Workspace, BIS_Model, Clipping_Features, Spacing__m_, Output_Depth_Features, Output_ASCII_File)
print "Successfully extracted depths to the ASCII file"
Environments
Licensing Information
- ArcGIS for Desktop Basic: No
- ArcGIS for Desktop Standard: Requires Maritime Bathymetry
- ArcGIS for Desktop Advanced: Requires Maritime Bathymetry