map2loop.stratigraphic_column.StratigraphicColumn

class map2loop.stratigraphic_column.StratigraphicColumn

Bases: object

A class containing all the fault and fold summaries and relationships

column

List of stratigraphic units in time order

Type:

list

groups

List of stratigraphic groups in time order

Type:

list

stratigraphicUnitColumns

Column names and types for stratigraphic unit summary

Type:

numpy.dtype

stratigraphicUnits

The stratigraphic units

Type:

pandas.DataFrame

lithologyUnitColumns

Column names and types for lithology layer summary

Type:

numpy.dtype

lithologyUnits

The lithology units

Type:

pandas.DataFrame

The initialiser for the stratigraphic units. All attributes are defaulted

__init__()

The initialiser for the stratigraphic units. All attributes are defaulted

Methods

__init__()	The initialiser for the stratigraphic units.
addLithologyUnit(unit)	Add lithology unit to the units list
addStratigraphicUnit(unit)	Add stratigraphic unit to the units list
findLithologyUnit(id)	Find the lithology unit in the units list based on its layerId or name
findStratigraphicUnit(id)	Find the unit in the units list based on its layerId or name
populate(geology_map_data)	Parse the geodataframe data into the stratigraphic units list
set_stratigraphic_unit_parameter_by_name(...)	Set a specific parameter on a specific stratigraphic unit
sort_from_relationship_list(relationshipList)	Sort the stratigraphic column based on the list of name

addLithologyUnit(unit)

Add lithology unit to the units list

Parameters:

fault (pandas.DataFrame or dict) – The unit information to add

addStratigraphicUnit(unit)

Add stratigraphic unit to the units list

Parameters:

fault (pandas.DataFrame or dict) – The unit information to add

findLithologyUnit(id)

Find the lithology unit in the units list based on its layerId or name

Parameters:

id (int or str) – The layerId or name to look for

Returns:

pandas.DataFrame – The sliced data frame containing the requested unit

findStratigraphicUnit(id)

Find the unit in the units list based on its layerId or name

Parameters:

id (int or str) – The layerId or name to look for

Returns:

pandas.DataFrame – The sliced data frame containing the requested unit

populate(geology_map_data: GeoDataFrame)

Parse the geodataframe data into the stratigraphic units list

Parameters:

geology_map_data (geopandas.GeoDataFrame) – The geodataframe with the unit data

set_stratigraphic_unit_parameter_by_name(name: str, parameter: str, value)

Set a specific parameter on a specific stratigraphic unit

Parameters:

• name (str) – The name of the stratigraphic unit

• parameter (str) – The colmn name of the parameters

• value (str or int or float) – The value to set

sort_from_relationship_list(relationshipList: list)

Sort the stratigraphic column based on the list of name

Parameters:

relationshipList (list) – The order of the units by name