BIS To Mosaic Dataset (Bathymetry Tools)

Summary

Creates a mosaic dataset from a Bathymetric Information System (BIS).

Usage

The mosaic dataset must be created in an enterprise or file geodatabase.
The output mosaic dataset must be created in a workspace other than the database provided as Input BIS Workspace parameter value.
The name of the mosaic dataset must be in accordance with the limits of the geodatabase or underlying database; for example, the name cannot start with a number.
When no coordinate system is provided for the Coordinate System parameter, WGS84 Web Mercator (auxiliary sphere) will be used by default.
When the Force overview tiles parameter is checked, overviews will be created at all levels; otherwise, overviews will only be created above the raster pyramid levels.
The Honor BIS Dataset Status parameter is hidden unless the input BIS workspace includes the field in its schema.

Label	Explanation	Data type
Input BIS Workspace	The enterprise or file geodatabase where the BIS workspace is located.	Workspace
Output Mosaic Dataset	The output mosaic dataset.	Mosaic Dataset
Coordinate System	The coordinate system that will be used for all items in the mosaic dataset. If no coordinate system is provided, WGS84 Web Mercator (auxiliary sphere) will be used by default.	Coordinate System
Query File (Optional)	The model or rule file that will be used to define the datasets and sorting order that will be applied to the rasters included in the output mosaic dataset. Model file (`.model`)—Defines the data that will be exported from the BIS. Only the specified rasters will be exported to the mosaic dataset. Rule file (`.rule`)—Defines the sorting order rules for the output data. All rasters in the BIS will be exported to the mosaic dataset. If no query file is provided, all rasters in the BIS will be exported.	File
Create overviews (Optional)	Specifies whether overviews for a mosaic dataset will be defined and generated. Checked—Overviews will be defined and generated. Unchecked—Overviews will not be defined or generated. This is the default.	Boolean
Force overview tiles (Optional)	Specifies whether overviews will be created at all levels or only above existing pyramid levels. Checked—Overviews will be created at all levels. Unchecked—Overviews will only be created above the raster pyramid levels. This is the default.	Boolean
Area of Interest (Optional)	The polygon feature layer that defines the geographic area to process. Area of interest polygons are used to select intersecting datasets from the input BIS workspace, which are then exported to the output mosaic dataset.	Polygon Feature Layer
Honor BIS_Dataset_Status Field (Optional)	Specifies whether the export will honor the `BIS_Dataset_Status` field in the input BIS workspace. Checked—Only items with a status of '0 - Active' and '2 - Locked' in the `BIS_Dataset_Status` field will be exported; items with a value of '1 - Inactive' will not be exported. Unchecked—The `BIS_Dataset_Status` field will be ignored for export purposes. This is the default.	Boolean

arcpy.bathymetry.BISToMosaicDataset(in_bis_workspace, out_mosaic, coordinate_system, {in_query_file}, {create_overviews}, {force_overview_tiles}, {area_of_interest}, {honor_bis_dataset_status})

Name	Explanation	Data type
in_bis_workspace	The enterprise or file geodatabase where the BIS workspace is located.	Workspace
out_mosaic	The output mosaic dataset.	Mosaic Dataset
coordinate_system	The coordinate system that will be used for all items in the mosaic dataset. If no coordinate system is provided, WGS84 Web Mercator (auxiliary sphere) will be used by default.	Coordinate System
in_query_file (Optional)	The model or rule file that will be used to define the datasets and sorting order that will be applied to the rasters included in the output mosaic dataset. Model file (`.model`)—Defines the data that will be exported from the BIS. Only the specified rasters will be exported to the mosaic dataset. Rule file (`.rule`)—Defines the sorting order rules for the output data. All rasters in the BIS will be exported to the mosaic dataset. If no query file is provided, all rasters in the BIS will be exported.	File
create_overviews (Optional)	Specifies whether overviews for a mosaic dataset will be defined and generated. `CREATE_OVERVIEWS`—Overviews will be defined and generated. `NO_OVERVIEWS`—Overviews will not be defined or generated. This is the default.	Boolean
force_overview_tiles (Optional)	Specifies whether overviews will be created at all levels or only above existing pyramid levels. `FORCE_OVERVIEW_TILES`—Overviews will be created at all levels. `NO_FORCE_OVERVIEW_TILES`—Overviews will only be created above the raster pyramid levels. This is the default.	Boolean
area_of_interest (Optional)	The polygon feature layer that defines the geographic area to process. Area of interest polygons are used to select intersecting datasets from the input BIS workspace, which are then exported to the output mosaic dataset.	Polygon Feature Layer
honor_bis_dataset_status (Optional)	Specifies whether the export will honor the `BIS_Dataset_Status` field in the input BIS workspace. `HONOR_BIS_DATASET_STATUS`—Only items with a status of '0 - Active' and '2 - Locked' in the `BIS_Dataset_Status` field will be exported; items with a value of '1 - Inactive' will not be exported. `NO_HONOR_BIS_DATASET_STATUS`—The `BIS_Dataset_Status` field will be ignored for export purposes. This is the default.	Boolean

Code sample

BISToMosaicDataset example (stand-alone script)

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

import arcpy

# Identify tool parameters
bis_workspace = r"C:\Data\BIS.gdb"
out_mosaic = r"C:\Data\Target.gdb\OutputMosaic"
coordinate_system = ""
rule_file = r"C:\Data\sort.rule"
create_overviews = "NO_OVERVIEWS"
force_overview_tiles = "NO_FORCE_OVERVIEW_TILES"
area_of_interest = ""
honor_bis_dataset_status = "NO_HONOR_BIS_DATASET_STATUS"

# Run the tool
out_mosaic = arcpy.bathymetry.BISToMosaicDataset(bis_workspace, out_mosaic, coordinate_system, rule_file, create_overviews, force_overview_tiles, area_of_interest, honor_bis_dataset_status)

Environments

Output CONFIG Keyword, Pyramid, Raster Statistics, Extent, Geographic Transformations

Licensing information