map2loop.thickness_calculator.ThicknessCalculator

class map2loop.thickness_calculator.ThicknessCalculator

Bases: ABC

Base Class of Thickness Calculator used to force structure of ThicknessCalculator

Parameters:

ABC (ABC) – Derived from Abstract Base Class

Initialiser of for ThicknessCalculator

__init__()

Initialiser of for ThicknessCalculator

Methods

__init__()	Initialiser of for ThicknessCalculator
compute(units, stratigraphic_order, ...)	Execute thickness calculator method (abstract method)
type()	Getter for subclass type label

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

Execute thickness calculator method (abstract method)

Parameters:

• units (pandas.DataFrame) – the data frame of units to add thicknesses 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”])

• structure_data (pandas.DataFrame) – sampled structural data

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

Returns:

pandas.DataFrame – units dataframe with added thickness column for calculated thickness values

Note:

Geological units’ thicknesses are returned in meters. The thickness is calculated based on the stratigraphic order of the units. If the thickness is not calculated for a given unit, the assigned thickness is -1. For the bottom and top units of the stratigraphic sequence, the assigned thickness is -1.

type()

Getter for subclass type label

Returns:

str – Name of subclass