Skip to content

snap_to_surface builtin

snap_to_surface(drillholes, surface, *, column=None)

Moves each collar's elevation onto a surface; the hole moves with it.

Parameters:

Name Type Description Default
drillholes Drillholes
required
surface Mesh or BlockModel

A surface such as topography; where it overlaps itself in plan, the highest elevation counts. A 2D block model's cell centers, lifted to column, make the surface, as in grid_surface.

required
column str

Elevation column of a block model surface.

None

Returns:

Name Type Description
drillholes Drillholes

A copy with every hole shifted vertically by its collar's offset.

report Table

hole, z_before, z_after and shift per hole. Holes the surface does not cover keep their elevation, with a null shift, and a UserWarning names them.

used in