Skip to content

Gridded Surface Operations🍋

compute_surface_elevation_intersection(obj, grid_object, z_prop, new_property_name, ignore_warnings=False) 🍋

Compute the grid object elevation at the intersection between the given object and the given Gridded Surface.

Parameters:

Name Type Description Default
obj GeoRefObject

object to intersect the grid object with.

required
grid_object GridObject

Gridded Surface from which elevation is computed.

required
z_prop Union[str, List[Tuple[str, str]]]

Gridded Surface properties representing the elevations. Either a single property name or a list of (property, region) names. Note that in the latter case, regions must be mutually exclusive otherwise result is undefined.

required
new_property_name str

name of the new property created on the given object.

required
ignore_warnings bool

ignore warnings of points outside the grid boundaries.

False