Add Data To BIS (Bathymetry)

Summary

Registers raster and feature class data to a Bathymetric Information System (BIS).

Usage

• The Target Workspace parameter value must be a workspace that contains a BIS.

• Inputs can be datasets, spatial data types, or workspaces. Nonspatial data types, such as tables, are not valid inputs.

• Multiple datasets can be added to the BIS at the same time; however, datasets with elevation values should share the same Vertical Units and Directionality parameter values. The vertical units and directionality values that are provided will be used for all datasets added at once.

• You must have read access to both the input workspace and the target workspace to add data to the BIS.

• Refresh the layers in the List By Data Source tab of the Contents pane to see datasets added by other users when adding data to an enterprise geodatabase BIS.

Parameters

Dialog

Label	Explanation	Data Type
Target Workspace	The enterprise or file geodatabase where the BIS is located.	Workspace
Input Data	The input workspaces, datasets, layers, or feature classes that contain the data that will be added to the target BIS.	Workspace; Feature Layer; Image Service; Raster Layer; Mosaic Layer; Layer File; ServerConnection; TIN Layer
Input Types (Optional)	Specifies the types of data that will be included from any workspaces provided in the Input Data parameter. All data types are included by default. Feature Class—Feature classes will be included. Feature Service—Feature services will be included. Image Service—Image services will be included. Layer File—Layer files will be included. Map Service—Map services will be included. Mosaic Dataset—Mosaic datasets will be included. Raster Dataset—Raster datasets will be included. Scene Layer Package—Scene layer packages will be included. TIN—TIN datasets will be included.	String
Include Subfolders (Optional)	Specifies whether the contents of a workspace subfolder will be added to the BIS. This parameter is not applicable to file or enterprise geodatabases. Checked—Valid data found in the subfolders will be added to the BIS. Unchecked— Subfolder contents will not be added to the BIS. This is the default.	Boolean
Footprint Type (Optional)	Specifies whether the footprint will be the full extent of the dataset or a convex hull representing the minimum bounding box for all features. Envelope— The footprint will be the full extent of the dataset. This is the default. Convex Hull— The footprint will be a convex polygon representing the minimum bounding box for all features.	String
Vertical Units	Specifies the vertical units that will be used for the depth data. Meters— The vertical units will be meters. Feet— The vertical units will be feet. US Survey Feet— The vertical units will be U.S. Survey feet. Fathoms— The vertical units will be fathoms.	String
Directionality (Optional)	Specifies the directionality of the elevation data. Positive Up—The directionality of elevation data will be positive up. Positive Down—The directionality of elevation data will be positive down.	String
BAG Metadata Mapping File (Optional)	The metadata mapping file that contains the XML element tree mapping information for Bathymetric Attributed Grid (BAG) internal metadata. This metadata mapping file can be used if the add_bag_metadata_fields.py script has first been run on the BIS. Both the Python script and the mapping file are in the ArcGIS Bathymetry product data files at <installation location>\ArcGIS Bathymetry\Product Files\<version>\BAGSupport. If the BAG metadata mapping file is used, internal BAG metadata will be extracted from input BAGs and the values will be populated in the BIS Catalog.	File
Update Overviews (Optional)	Specifies whether overviews and statistics for a mosaic dataset will be calculated and updated. Checked—Overviews and statistics will be calculated and updated. This is the default. Unchecked—Overviews and statistics will not be calculated and updated.	Boolean

Derived Output

Label	Explanation	Data Type
Updated BIS	The updated BIS workspace.	Workspace

Python

arcpy.bathymetry.AddDataToBIS(target_workspace, in_data, {input_types}, {include_subfolders}, {footprint_type}, vertical_units, {directionality}, {in_bag_metadata_mapping_file}, {update_overviews})

Name	Explanation	Data Type
target_workspace	The enterprise or file geodatabase where the BIS is located.	Workspace
in_data [in_data,...]	The input workspaces, datasets, layers, or feature classes that contain the data that will be added to the target BIS.	Workspace; Feature Layer; Image Service; Raster Layer; Mosaic Layer; Layer File; ServerConnection; TIN Layer
input_types [input_types,...] (Optional)	Specifies the types of data that will be included from any workspaces provided in the input_data parameter. All data types are included by default. FEATURE_CLASS—Feature classes will be included. FEATURE_SERVICE—Feature services will be included. IMAGE_SERVICE—Image services will be included. LAYER_FILE—Layer files will be included. MAP_SERVICE—Map services will be included. MOSAIC_DATASET—Mosaic datasets will be included. RASTER_DATASET—Raster datasets will be included. SCENE_LAYER_PACKAGE—Scene layer packages will be included. TIN—TIN datasets will be included.	String
include_subfolders (Optional)	Specifies whether the contents of a workspace subfolder will be added to the BIS. This parameter is not applicable to file or enterprise geodatabases. INCLUDE_SUBFOLDERS—Valid data found in the subfolders will be added to the BIS. NOT_INCLUDE_SUBFOLDERS— Subfolder contents will not be added to the BIS. This is the default.	Boolean
footprint_type (Optional)	Specifies whether the footprint will be the full extent of the dataset or a convex hull representing the minimum bounding box for all features. ENVELOPE— The footprint will be the full extent of the dataset. This is the default. CONVEX_HULL— The footprint will be a convex polygon representing the minimum bounding box for all features.	String
vertical_units	Specifies the vertical units that will be used for the depth data. METERS— The vertical units will be meters. FEET— The vertical units will be feet. FEET_US— The vertical units will be U.S. Survey feet. FATHOMS— The vertical units will be fathoms.	String
directionality (Optional)	Specifies the directionality of the elevation data. POSITIVE_UP—The directionality of elevation data will be positive up. POSITIVE_DOWN—The directionality of elevation data will be positive down.	String
in_bag_metadata_mapping_file (Optional)	The metadata mapping file that contains the XML element tree mapping information for Bathymetric Attributed Grid (BAG) internal metadata. This metadata mapping file can be used if the add_bag_metadata_fields.py script has first been run on the BIS. Both the Python script and the mapping file are in the ArcGIS Bathymetry product data files at <installation location>\ArcGIS Bathymetry\Product Files\<version>\BAGSupport. If the BAG metadata mapping file is used, internal BAG metadata will be extracted from input BAGs and the values will be populated in the BIS Catalog.	File
update_overviews (Optional)	Specifies whether overviews and statistics for a mosaic dataset will be calculated and updated. UPDATE_OVERVIEWS—Overviews and statistics will be calculated and updated. This is the default. NOT_UPDATE_OVERVIEWS—Overviews and statistics will not be calculated and updated.	Boolean

Derived Output

Name	Explanation	Data Type
updated_bis	The updated BIS workspace.	Workspace

Code sample

AddDataToBIS example (stand-alone script)

The following stand-alone script demonstrates how to use the AddDataToBIS function.

# Import arcpy module and toolbox
import arcpy
arcpy.CheckOutExtension("Bathymetry")

# Identify tool parameters
target_workspace = r"C:\Data\BIS.gdb"
input_data = r"C:\Data\datasets"
input_types = None
include_subfolders = "NOT_INCLUDE_SUBFOLDERS"
footprint_type = "ENVELOPE"
vertical_units = "METERS"
directionality = "POSITIVE_UP"
bag_metadata_mapping_file = r"C:\ArcGIS Bathymetry\Product Files\version\BAGSupport\bag_metadata_mapping.txt"
update_overviews = "UPDATE_OVERVIEWS"

# Run the tool
updated_bis = arcpy.bathymetry.AddDataToBIS(target_workspace, input_data, input_types, include_subfolders, footprint_type, vertical_units, directionality, bag_metadata_mapping_file, update_overviews)
arcpy.CheckInExtension("Bathymetry")

Environments

Geographic Transformations, Extent, Pyramid, Raster Statistics

Licensing information

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