ArcMap

Add Bathymetry

Summary

Registers one or more bathymetry datasets described in bathymetry dataset properties (.bdprops) files to a BIS geodatabase, where one bathymetry dataset is described per .bdprops file. A .bdprops file is created using the Define Bathymetry geoprocessing tool. This geoprocessing tool performs in the same way as the Add Bathymetry desktop tool with the difference being that it can be invoked via a Python script or a geoprocessing model, like any other geoprocessing tool. This tool performs a number of validation checks to ensure that no incorrect or duplicate datasets are registered with the BIS geodatabase.

Usage

  • Turning off the Generate/update overviews for the Bathymetry Data Index, Update cell size ranges for the Bathymetry Data Index, or Update statistics for the Bathymetry Data Index (requires cell size ranges) parameters could speed up processing, but it also means you must run Diagnose BIS if an error occurs.

  • If the Allow datasets defined using a different BIS workspace to be added here parameter is checked, this tool will allow .bdprops files defined using a different BIS workspace to be added to the BIS workspace defined in the tool, as long as the BIS workspaces have matching extended metadata and collection metadata schemas.

Syntax

arcpy.bathymetry.AddBathymetry(bis_workspace, in_files, {allow_different_bis}, {ignore_errors}, {update_bdi_overviews}, {update_bdi_cell_sizes}, {update_bdi_stats})
ParameterExplanationData Type
bis_workspace

The Bathymetric Information System (BIS) to which the input datasets should be added. This parameter accepts any geodatabase (.gdb) or enterprise database connection file (.sde) that has been registered as a BIS with the latest version.

Workspace
in_files
[in_files,...]

The input bathymetry dataset properties (.bdprops) files that contain information on the bathymetry datasets to be added to the BIS geodatabase. This parameter accepts one or more files.

File
allow_different_bis
(Optional)

Indicates whether the tool should accept bathymetry dataset properties files that were generated using a different BIS geodatabase than the one currently selected in the tool. Turning off this parameter could speed processing, but it also means you must run Diagnose BIS if an error occurs.

  • ALLOW_DIFFERENT_BIS —The tool allows you to use datasets from a different BIS workspace.
  • NOT_ALLOW_DIFFERENT_BIS —The tool does not allow you to use datasets from a different BIS workspace. This is the default.
Boolean
ignore_errors
(Optional)

Indicates whether the tool should ignore failing datasets and continue adding the remaining datasets to the BIS geodatabase.

  • IGNORE_ERRORS —Continue adding datasets even if one or more causes an error.
  • NOT_IGNORE_ERRORS —Stops processing if a dataset causes an error. This is the default.
Boolean
update_bdi_overviews
(Optional)

Indicates whether the tool should update overviews for the Bathymetry Data Index when adding the datasets to the BIS geodatabase. Turning off this parameter could speed processing, but it also means you must run Diagnose BIS if an error occurs.

  • UPDATE_BDI_OVERVIEWS —The tool updates overviews for the BDI when adding datasets. This is the default.
  • NOT_UPDATE_BDI_OVERVIEWS —The tool does not update overviews for the BDI when adding datasets.
Boolean
update_bdi_cell_sizes
(Optional)

Indicates whether the tool should update cell size ranges for the Bathymetry Data Index when adding the datasets to the BIS geodatabase. Turning off this parameter could speed processing, but it also means you must run Diagnose BIS if an error occurs.

  • UPDATE_BDI_CELL_SIZES —The tool updates cell size ranges for the BDI when adding datasets. This is the default.
  • NOT_UPDATE_BDI_CELL_SIZES —The tool does not update cell size ranges for the BDI when adding datasets.
Boolean
update_bdi_stats
(Optional)

Indicates whether the tool should update the statistics for the Bathymetry Data Index when adding the datasets to the BIS geodatabase. Turning off this parameter could speed processing, but it also means you must run Diagnose BIS if an error occurs.

  • UPDATE_BDI_STATS —The tool updates the statistics for the BDI when adding datasets. This is the default.
  • NOT_UPDATE_BDI_STATS —The tool does not update the statistics for the BDI when adding datasets.
Boolean

Code sample

AddBathymetry example (stand-alone script)

The following stand-alone script demonstrates how to use the AddBathymetry tool.

# Name: AddBathymetry_Example.py
# Description: Registers a few bathymetry datasets with the BIS geodatabase
# Requirements: ArcGIS Bathymetry

import arcpy

# check out the extension
arcpy.CheckOutExtension("Bathymetry")

# set up parameters
bis_workspace = r"C:/Data/BIS.gdb"
in_files = r"C:/Data/NewYork.bdprops;C:/Data/Virginia.bdprops;C:/Data/MontereyBay.bdprops"
allow_different_bis = NOT_ALLOW_DIFFERENT_BIS
ignore_errors = NOT_IGNORE_ERRORS
update_bdi_overviews = NOT_UPDATE_BDI_OVERVIEWS
update_bdi_cell_sizes = NOT_UPDATE_BDI_CELL_SIZES
update_bdi_stats = NOT_UPDATE_BDI_STATS

# execute the tool
arcpy.AddBathymetry_bathymetry(bis_workspace, in_files, allow_different_bis, ignore_errors, update_bdi_overviews, update_bdi_cell_sizes, update_bdi_stats)

Environments

Licensing information

  • Basic: No
  • Standard: Requires ArcGIS Bathymetry
  • Advanced: Requires ArcGIS Bathymetry

Related topics