Skip to content

Block Model Operations🍋

compute_block_proportion_by_gridded_surface(block_model, surface, surface_z_prop, block_proportion_name, block_elevation_name, proportion_above=True, block_discretization=(1, 1, 1)) 🍋

Compute the block model proportion above or below a surface and the average surface elevation given a block discretization.

Parameters:

Name Type Description Default
block_model BlockModel

BlockModel on which to perform the calculation.

required
surface GriddedSurface

GriddedSurface used to test against above/below.

required
surface_z_prop str

GriddedSurface property carrying the Z-elevation.

required
block_proportion_name str

name of the new property that will contain the block proportion above/below the surface given the block discretization.

required
block_elevation_name str

name of the new property that will contain the average surface elevation given the block discretization.

required
proportion_above bool

set to True to compute the proportion above the surface, otherwise proportion below will be computed.

True
block_discretization Tuple[int, int, int]

number of block subdivisions points used to perform the calculation. Default discretization of (1, 1, 1) means block centers will be used.

(1, 1, 1)

compute_block_proportion_by_gridded_surface_and_polygon(block_model, polygon, surface, surface_z_prop, block_proportion_name, proportion_above=True, block_discretization=(1, 1, 1)) 🍋

Compute the block model proportion above or below a surface and the average surface elevation given a block discretization.

Parameters:

Name Type Description Default
block_model BlockModel

BlockModel on which to perform the calculation.

required
polygon GISObject

GISObject used to test against inside/outside.

required
surface GriddedSurface

GriddedSurface used to test against above/below.

required
surface_z_prop str

GriddedSurface property carrying the Z-elevation.

required
block_proportion_name str

name of the new property that will contain the block proportion above/below the surface given the block discretization.

required
proportion_above bool

set to True to compute the proportion above the surface, otherwise proportion below will be computed.

True
block_discretization Tuple[int, int, int]

number of block subdivisions points used to perform the calculation. Default discretization of (1, 1, 1) means block centers will be used.

(1, 1, 1)

compute_block_proportion_inside_polygon(block_model, polygon, block_proportion_name, block_discretization=(1, 1)) 🍋

Compute the block model proportion inside/outside a polygon given a block discretization.

Parameters:

Name Type Description Default
block_model BlockModel

BlockModel on which to perform the calculation.

required
polygon GISObject

GISObject used to test against inside/outside.

required
block_proportion_name str

name of the new property that will contain the block proportion above/below the surface given the block discretization.

required
block_discretization Tuple[int, int]

number of block horizontal subdivisions points used to perform the calculation. Default discretization of (1, 1) means block centers will be used.

(1, 1)

compute_block_proportion_inside_solid(grid_object, solid, block_proportion_name, block_discretization=(1, 1, 1)) 🍋

Compute the block model proportion inside/outside a solid given a block discretization.

Parameters:

Name Type Description Default
grid_object GridObject

BlockModel on which to perform the calculation.

required
solid Solid

Solid used to test against inside/outside.

required
block_proportion_name str

name of the new property that will contain the block proportion inside/outside the solid given the block discretization.

required
block_discretization Tuple[int, int, int]

number of block horizontal subdivisions points used to perform the calculation. Default discretization of (1, 1, 1) means block centers will be used.

(1, 1, 1)

Last update: 2023-05-23