gemgis.postprocessing.clip_fault_of_gempy_model#

gemgis.postprocessing.clip_fault_of_gempy_model(geo_model, fault: str, which: str = 'first', buffer_first: Union[int, float] = None, buffer_last: Union[int, float] = None, i_size: Union[int, float] = 1000, j_size: Union[int, float] = 1000, invert_first: bool = True, invert_last: bool = False) → Union[pyvista.core.pointset.PolyData, List[pyvista.core.pointset.PolyData]]#

Clip fault of a GemPy model.

Parameters

  • geo_model (gp.core.model.Project) – GemPy Model containing the faults.

  • fault (str) – String or list of strings containing the name of faults to be clipped, e.g. faults='Fault1'.

  • which (str, default: 'first') – Parameter to decide which end of the faults to clip. Options include 'first', 'last', or both, e.g. 'which='first'.

  • buffer_first (Union[int, float]) – Int or float value or list of values to clip the fault/s behind the first interface point, e.g. 'buffer_first=500'.

  • buffer_last (Union[int, float]) – Int or float value or list of values to clip the fault/s behind the last interface point, e.g. 'buffer_last=500'.

  • i_size (Union[int, float]) – Size of the plane in the i direction.

  • j_size (Union[int, float]) – Size of the plane in the j direction.

  • invert_first (bool, default: 'True') – Invert clipping for first plane.

  • invert_last (bool, default: 'False') – Invert clipping for second plane.

Returns

Clipped faults.

Return type

pv.core.pointset.PolyData

New in version 1.1.

See also

create_plane_from_interface_and_orientation

Create PyVista plane from GemPy interface and orientations DataFrames.

translate_clipping_plane

Translate clipping plane.

Example