gempy.core.data_modules.stack.Faults

class gempy.core.data_modules.stack.Faults(series_fault=None, rel_matrix=None)[source]

Class that encapsulate faulting related content. Mainly, which surfaces/surfaces are faults. The fault network —i.e. which faults offset other faults—and fault types—finite vs infinite.

Parameters
  • series_fault (str, list[str]) – Name of the series which are faults

  • rel_matrix (numpy.array[bool]) – 2D Boolean array with boolean logic. Rows affect (offset) columns

df

Pandas data frame containing the series as index and if they are faults or not (otherwise they are lithologies) and in case of being fault if is finite

Type

pn.core.frame.DataFrames

faults_relations_df

Pandas data frame containing the offsetting relations between each fault and the rest of the series (either other faults or lithologies)

Type

pn.core.frame.DataFrames

n_faults

Number of faults in the object

Type

int

Examples using Faults

Methods

__init__([series_fault, rel_matrix])

Initialize self.

count_faults(list_of_names)

Read the string names of the surfaces to detect automatically the number of df if the name fault is on the name.

set_default_faults_relations([offset_faults])

set_fault_relation([rel_matrix])

Method to set the df that offset a given sequence and therefore also another fault.

set_is_fault([series_fault, toggle, …])

Set a flag to the series that are faults.

set_is_finite_fault([series_finite, toggle])

Toggles given series’ finite fault property.

__init__(series_fault=None, rel_matrix=None)[source]

Initialize self. See help(type(self)) for accurate signature.

set_is_fault(series_fault: Union[str, list, numpy.ndarray] = None, toggle=False, offset_faults=False)[source]

Set a flag to the series that are faults.

Parameters
  • series_fault (str, list[str]) – Name of the series which are faults

  • toggle (bool) – if True, passing a name which is already True will set it False.

  • offset_faults (bool) – If True by default faults offset other faults

Returns

gempy.core.data_modules.stack.Faults

set_is_finite_fault(series_finite: Union[str, list, numpy.ndarray] = None, toggle=False)[source]

Toggles given series’ finite fault property.

Parameters
  • series_finite (str, list[str]) – Name of the series which are finite

  • toggle (bool) – if True, passing a name which is already True will set it False.

Returns

gempy.core.data_modules.stack.Faults

set_fault_relation(rel_matrix=None)[source]

Method to set the df that offset a given sequence and therefore also another fault.

Parameters

rel_matrix (numpy.array[bool]) – 2D Boolean array with boolean logic. Rows affect (offset) columns

Returns

gempy.core.data_modules.stack.Faults.faults_relations_df

static count_faults(list_of_names)[source]

Read the string names of the surfaces to detect automatically the number of df if the name fault is on the name.