BIS To Mosaic Dataset (Bathymetry)

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 parameter value must be a workspace other than the 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.

  • If no coordinate system is provided, WGS84 Web Mercator (auxiliary sphere) will be used by default.

  • If 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.

Parameters

LabelExplanationData 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 defines the datasets and sorting order that will be applied to the rasters included in the output mosaic dataset.

  • Model file (*.model)—Defines the data to 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

arcpy.bathymetry.BISToMosaicDataset(in_bis_workspace, out_mosaic, coordinate_system, {in_query_file}, {create_overviews}, {force_overview_tiles})
NameExplanationData 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 defines the datasets and sorting order that will be applied to the rasters included in the output mosaic dataset.

  • Model file (*.model)—Defines the data to 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_OVERVIEWSOverviews will be defined and generated.
  • NO_OVERVIEWSOverviews 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_TILESOverviews will be created at all levels.
  • NO_FORCE_OVERVIEW_TILESOverviews will only be created above the raster pyramid levels. 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

arcpy.CheckOutExtension("Bathymetry")

# 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"

# Execute the tool
out_mosaic = arcpy.bathymetry.BISToMosaicDataset(bis_workspace, out_mosaic, coordinate_system, rule_file, create_overviews, force_overview_tiles)
arcpy.CheckInExtension("Bathymetry")

Licensing information

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

Related topics