map2loop.thickness_calculator.ThicknessCalculatorAlpha

class map2loop.thickness_calculator.ThicknessCalculatorAlpha

Bases: ThicknessCalculator

ThicknessCalculator class which estimates unit thickness based on units, basal_contacts and stratigraphic order

Initialiser for alpha version of the thickness calculator

__init__()

Initialiser for alpha version of the thickness calculator

Methods

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

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

Execute thickness calculator method takes unit data, basal_contacts and stratigraphic order and attempts to estimate unit thickness. Note: Thicknesses of the top and bottom units are not possible with this data and so are assigned the average of all other calculated unit thicknesses.

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

type()

Getter for subclass type label

Returns:

str – Name of subclass