Analyze BIS (Bathymetry)

Summary

Analyzes a Bathymetric Information System (BIS).

Usage

  • This tool provides validation checks related to BIS elements and their interrelationships.

  • All checks and operations are optional.

  • This tool can be used to delete proxy rasters that have no corresponding point datasets in the BIS.

Parameters

LabelExplanationData Type
BIS

The input BIS.

Workspace
BIS Checks
(Optional)

Specifies the checks that will be performed on the BIS.

  • BIS StructureThe structure of the BIS will be analyzed to ensure it is a valid BIS.
  • BisCatalog LinksThe BisCatalog will be analyzed for broken links.
  • BisBDI LinksThe BisBDI will be analyzed for broken links.
  • BisCatalog/BisBDI SyncThe catalog dataset will be compared to the mosaic dataset to detect entries that do not match.
  • Proxy Raster CheckProxy raster problems will be identified.
String
Repair Operations
(Optional)

Specifies the repair operations that will be performed.

  • Remove Excess Proxy RastersUnused proxy rasters will be deleted.
  • Regenerate BisBDIThe new BisBDI will be created with the rasters and proxy rasters from the BisCatalog. The rasters and proxy rasters will be added with default values. This operation modifies the schema of the BIS. Any existing BisBDI must be deleted before performing this operation. Use the Delete Mosaic Dataset tool to remove the existing BisBDI and verify that the mosaic dataset was deleted before attempting to regenerate the BisBDI.
  • Update OverviewsThe overviews and statistics for the BisBDI mosaic dataset will be calculated and updated.
String

Derived Output

LabelExplanationData Type
Updated BIS

The updated BIS workspace.

Workspace

arcpy.bathymetry.AnalyzeBIS(in_bis, {bis_checks}, {repair_operations})
NameExplanationData Type
in_bis

The input BIS.

Workspace
bis_checks
[bis_checks,...]
(Optional)

Specifies the checks that will be performed on the BIS.

  • BIS_STRUCTUREThe structure of the BIS will be analyzed to ensure it is a valid BIS.
  • BISCATALOG_LINKSThe BisCatalog will be analyzed for broken links.
  • BISBDI_LINKSThe BisBDI will be analyzed for broken links.
  • BISCATALOG_BISBDI_SYNCThe catalog dataset will be compared to the mosaic dataset to detect entries that do not match.
  • PROXY_RASTER_CHECKProxy raster problems will be identified.
String
repair_operations
[repair_operations,...]
(Optional)

Specifies the repair operations that will be performed.

  • REMOVE_EXCESS_PROXY_RASTERSUnused proxy rasters will be deleted.
  • REGENERATE_BISBDIThe new BisBDI will be created with the rasters and proxy rasters from the BisCatalog. The rasters and proxy rasters will be added with default values. This operation modifies the schema of the BIS. Any existing BisBDI must be deleted before performing this operation. Use the Delete Mosaic Dataset tool to remove the existing BisBDI and verify that the mosaic dataset was deleted before attempting to regenerate the BisBDI.
  • UPDATE_OVERVIEWSThe overviews and statistics for the BisBDI mosaic dataset will be calculated and updated.
String

Derived Output

NameExplanationData Type
updated_bis

The updated BIS workspace.

Workspace

Code sample

AnalyzeBIS example (stand-alone script)

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

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

# Identify tool parameters
in_bis = r"C:\Data\BIS.gdb"
bis_checks = "BIS_STRUCTURE;BISCATALOG_LINKS;BISBDI_LINKS;BISCATALOG_BISBDI_SYNC;PROXY_RASTER_CHECK"
repair_operations  = "REMOVE_EXCESS_PROXY_RASTERS"

# Execute the tool
arcpy.bathymetry.AnalyzeBIS(in_bis, bis_checks, repair_operations)
arcpy.CheckInExtension("Bathymetry")

The following stand-alone script demonstrates how to perform repair operations using the AnalyzeBIS function.

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

# Identify tool parameters
in_bis = r"C:\Data\BIS.gdb"
bis_checks = ""
repair_operations  = "REGENERATE_BISBDI;UPDATE_OVERVIEWS"

# Execute the tool
arcpy.bathymetry.AnalyzeBIS(in_bis, bis_checks, repair_operations)
arcpy.CheckInExtension("Bathymetry")

Environments

This tool does not use any geoprocessing environments.

Licensing information

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

Related topics