map2loop.project.ThrowCalculatorAlpha#

class map2loop.project.ThrowCalculatorAlpha#

Bases: ThrowCalculator

ThrowCalculator class which estimates fault throw values based on units, basal_contacts and stratigraphic order

Initialiser for alpha version of the throw calculator

Methods

`__init__`()	Initialiser for alpha version of the throw calculator
`compute`(faults, stratigraphic_order, ...)	Execute throw calculator method takes fault data, basal_contacts and stratigraphic order and attempts to estimate fault throw.
`type`()	Getter for subclass type label

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

Execute throw calculator method takes fault data, basal_contacts and stratigraphic order and attempts to estimate fault throw.

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