Add Point Data To BIS (Bathymetry)

Summary

Registers point cloud or elevation point data to a Bathymetric Information System (BIS).

Usage

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

  • Inputs can be LAS, LASD, point feature class (z-enabled and not z-enabled), shapefile, or multipoint features.

  • Multiple inputs can be added to the BIS at the same time; however, these inputs should share the same vertical units, directionality, and cell size properties. The tool applies the input values for these properties to all data added in a single tool run.

  • The Cell Size parameter is used to generate proxy rasters from the point data.

  • Do not combine data types in a single tool run; doing so can cause unexpected results or failure.

  • Proxy rasters are stored in the proxy raster location specified in the BisDetails table.

  • 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

LabelExplanationData Type
Target Workspace

The enterprise or file geodatabase where the BIS is located.

Workspace
Input Data

The input LAS, LASD, point feature class (z-enabled and not z-enabled), shapefile, or multipoint features that will be added to the target workspace.

LAS Dataset Layer; Feature Layer
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

Specifies the directionality of the elevation data.

  • Positive UpThe directionality of the elevation data will be positive up.
  • Positive DownThe directionality of the elevation data will be positive down.
String
Depth Field
(Optional)

The field where the depth is stored. It is either a numeric field or the shape field specified in the Input Data parameter value.

String
Footprint Type
(Optional)

Specifies whether the footprint will be the full extent of the dataset, a convex hull representing the minimum bounding box for all features, or a precise domain representing the approximate boundary of the input dataset.

  • 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.
  • Precise DomainThe footprint will be a polygon that is the approximate boundary of the input dataset.
String
Cell Size
(Optional)

The cell size of the proxy raster. The horizontal unit is the same as that of the input datasets.

If no cell size is specified, additional rules will be used to calculate it from the other inputs.

Double
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

LabelExplanationData Type
Updated BIS

The updated BIS workspace.

Workspace

arcpy.bathymetry.AddPointDataToBIS(target_workspace, in_data, vertical_units, directionality, {depth_field}, {footprint_type}, {cell_size}, {update_overviews})
NameExplanationData Type
target_workspace

The enterprise or file geodatabase where the BIS is located.

Workspace
in_data
[in_data,...]

The input LAS, LASD, point feature class (z-enabled and not z-enabled), shapefile, or multipoint features that will be added to the target workspace.

LAS Dataset Layer; Feature Layer
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

Specifies the directionality of the elevation data.

  • POSITIVE_UPThe directionality of the elevation data will be positive up.
  • POSITIVE_DOWNThe directionality of the elevation data will be positive down.
String
depth_field
(Optional)

The field where the depth is stored. It is either a numeric field or the shape field specified in the in_data parameter value.

String
footprint_type
(Optional)

Specifies whether the footprint will be the full extent of the dataset, a convex hull representing the minimum bounding box for all features, or a precise domain representing the approximate boundary of the input dataset.

  • 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.
  • PRECISE_DOMAINThe footprint will be a polygon that is the approximate boundary of the input dataset.
String
cell_size
(Optional)

The cell size of the proxy raster. The horizontal unit is the same as that of the input datasets.

If no cell size is specified, additional rules will be used to calculate it from the other inputs.

Double
update_overviews
(Optional)

Specifies whether overviews and statistics for a mosaic dataset will be calculated and updated.

  • UPDATE_OVERVIEWSOverviews and statistics will be calculated and updated. This is the default.
  • NOT_UPDATE_OVERVIEWSOverviews and statistics will not be calculated and updated.
Boolean

Derived Output

NameExplanationData Type
updated_bis

The updated BIS workspace.

Workspace

Code sample

AddPointDataToBIS example (stand-alone script)

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

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

# Identify tool parameters
target_workspace = r"C:\BIS.gdb"
in_data = r"C:\Data\surveys.gdb\survey01; C:\Data\surveys.gdb\survey02; C:\Data\surveys.gdb\survey03"
vertical_units = "FEET"
directionality = "POSITIVE_DOWN"
depth_field = "Z_depth"
footprint_type = "ENVELOPE"
cell_size = ""
update_overviews = "UPDATE_OVERVIEWS"

# Execute the tool
updated_bis = arcpy.bathymetry.AddPointDataToBIS(target_workspace, in_data, vertical_units, directionality, depth_field, footprint_type, cell_size, update_overviews)
arcpy.CheckInExtension("Bathymetry")

Licensing information

  • Basic: No
  • Standard: Requires ArcGIS Bathymetry, 3D Analyst
  • Advanced: Requires ArcGIS Bathymetry, 3D Analyst

Related topics