map2loop.throw_calculator.ThrowCalculator

class map2loop.throw_calculator.ThrowCalculator

Bases: ABC

Base Class of Throw Calculator used to force structure of ThrowCalculator

Parameters:

ABC (ABC) – Derived from Abstract Base Class

Initialiser of for Sorter

__init__()

Initialiser of for Sorter

Methods

__init__()	Initialiser of for Sorter
compute(faults, stratigraphic_order, ...)	Execute throw calculator method (abstract method)
type()	Getter for subclass type label

abstract compute(faults: DataFrame, stratigraphic_order: list, basal_contacts: GeoDataFrame, map_data: MapData) → DataFrame

Execute throw calculator method (abstract method)

Parameters:

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

• stratigraphic_order (list) – a list of unit names sorted from youngest to oldest

• basal_contacts (geopandas.GeoDataFrame) – basal contact geo data with locations and unit names of the contacts (columns must contain [“ID”,”basal_unit”,”type”,”geometry”])

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

Returns:

pandas.DataFrame – fault data frame with throw values (avgDisplacement and avgDownthrowDir) filled in

type()

Getter for subclass type label

Returns:

str – Name of subclass