map2loop.fault_orientation.FaultOrientation

class map2loop.fault_orientation.FaultOrientation

Bases: ABC

Base Class of Fault Orientation assigner to force structure of FaultOrientation

Parameters:

ABC (ABC) – Derived from Abstract Base Class

Initialiser of for orientation assigner

__init__()

Initialiser of for orientation assigner

Methods

__init__()	Initialiser of for orientation assigner
calculate(fault_trace, fault_orientations, ...)	Execute fault orientation assigned method (abstract method)
type()	Getter for subclass type label

abstract calculate(fault_trace: GeoDataFrame, fault_orientations: DataFrame, map_data: MapData) → DataFrame

Execute fault orientation assigned method (abstract method)

Parameters:

• faults (pandas.DataFrame) – the data frame of the faults to add throw values to

• fault_orientation (pandas.DataFrame) – data frame with fault orientations to assign to faults

• map_data (map2loop.MapData) – a catchall so that access to all map data is available

Returns:

pandas.DataFrame – fault orientations assigned to a fault label

type()

Getter for subclass type label

Returns:

str – Name of subclass