gempy.add_surface_points

gempy.add_surface_points(geo_model: GeoModel, x: Sequence[float], y: Sequence[float], z: Sequence[float], elements_names: Sequence[str], nugget: Sequence[float] | None = None) → StructuralFrame[source]

Add surface points to the geological model.

This function adds surface points to the specified geological elements in the model. The points are grouped by element names, and optional nugget values can be specified for each point.

Parameters:

  • geo_model (GeoModel) – The geological model to which the surface points will be added.

  • x (Sequence[float]) – Sequence of x-coordinates for the surface points.

  • y (Sequence[float]) – Sequence of y-coordinates for the surface points.

  • z (Sequence[float]) – Sequence of z-coordinates for the surface points.

  • elements_names (Sequence[str]) – Sequence of element names corresponding to each surface point.

  • nugget (Optional[Sequence[float]]) – Sequence of nugget values for each surface point. If not provided, a default value will be used for all points.

Returns:

The updated structural frame of the geological model.

Return type:

StructuralFrame

Raises:

ValueError – If the length of the nugget sequence does not match the lengths of the other input sequences.