pybacktrack.DecompactedWell

class pybacktrack.DecompactedWell(surface_unit)

Class containing the decompacted well data at a specific age.

paleo_longitude

Longitude of the well location reconstructed to the age of the surface of this decompacted well (in degrees).

Added in version 1.5.

Type:: float

paleo_latitude

Latitude of the well location reconstructed to the age of the surface of this decompacted well (in degrees).

Added in version 1.5.

Type:: float

surface_unit

Top stratigraphic unit in this decompacted well.

Type:: pybacktrack.StratigraphicUnit

total_compacted_thickness

Total compacted thickness of all stratigraphic units.

Type:: float

total_decompacted_thickness

Total decompacted thickness of all decompacted stratigraphic units.

Type:: float

tectonic_subsidence

Tectonic subsidence (in metres).

Note

This attribute is only available when backtracking (not backstripping). For example, it is available if pybacktrack.backtrack_well() or pybacktrack.backtrack_and_write_well() has been called.

Type:: float, optional

min_water_depth

Minimum water depth (in metres).

Note

This attribute is only available when backstripping (not backtracking). For example, it is available if pybacktrack.backstrip_well() or pybacktrack.backstrip_and_write_well() has been called.

Added in version 1.2.

Type:: float, optional

max_water_depth

Maximum water depth (in metres).

Note

This attribute is only available when backstripping (not backtracking). For example, it is available if pybacktrack.backstrip_well() or pybacktrack.backstrip_and_write_well() has been called.

Added in version 1.2.

Type:: float, optional

sea_level

Sea level in metres (positive for a sea-level rise and negative for a sea-level fall, relative to present day).

Note

This attribute is only available if a sea model was specified when backtracking or backstripping (for example, if sea_level_model was specified in pybacktrack.backtrack_well() or pybacktrack.backstrip_well()).

See also

pybacktrack.Well.decompact()

Methods

`__init__`(surface_unit)	Create a decompacted well whose top stratigraphic unit is `surface_unit`.
`add_decompacted_unit`(stratigraphic_unit, ...)	Add a decompacted stratigraphic unit.
`get_age`()
`get_average_decompacted_density`()
`get_dynamic_topography`([...])	Returns the dynamic topography elevation relative to present day, or `default_dynamic_topography` if a dynamic topography model was not specified (when backtracking).
`get_min_max_tectonic_subsidence`()	Returns the minimum and maximum tectonic subsidence obtained directly from subsidence model (if backtracking) or indirectly from minimum and maximum water depth and sea level (if backstripping).
`get_min_max_tectonic_subsidence_from_water_depth`(...)	Returns the minimum and maximum tectonic subsidence obtained from specified minimum and maximum water depths (and optional sea level).
`get_min_max_water_depth`()	Returns the minimum and maximum water depth obtained directly from minimum and maximum water depth (if backstripping) or indirectly from tectonic subsidence model and sea level (if backtracking).
`get_sea_level`([default_sea_level])	Returns the sea level relative to present day, or `default_sea_level` if a sea level model was not specified (when either backtracking or backstripping).
`get_sediment_isostatic_correction`()
`get_tectonic_subsidence`()	Returns the tectonic subsidence obtained directly from subsidence model (if backtracking) or indirectly from average of minimum and maximum water depth and sea level (if backstripping).
`get_water_depth`()	Returns the water depth obtained directly from average of minimum and maximum water depth (if backstripping) or indirectly from tectonic subsidence model and sea level (if backtracking).
`get_water_depth_from_tectonic_subsidence`(...)	Returns the water depth of this decompacted well from the specified tectonic subsidence (and optional sea level).

add_decompacted_unit(stratigraphic_unit, decompacted_thickness, decompacted_density)

Add a decompacted stratigraphic unit.

Parameters:

stratigraphic_unit (pybacktrack.StratigraphicUnit) – Stratigraphic unit referenced by decompacted stratigraphic unit.
decompacted_thickness (float) – Decompacted thickness.
decompacted_density (float) – Decompacted density.

Notes

Stratigraphic units should be decompacted from top of well column to bottom.

get_age()

Returns:: Age of the surface of the decompacted column of the well.
Return type:: float

get_average_decompacted_density()

Returns:: Average density of the entire decompacted column of the well.
Return type:: float

get_dynamic_topography(default_dynamic_topography=0.0)

Returns the dynamic topography elevation relative to present day, or default_dynamic_topography if a dynamic topography model was not specified (when backtracking).

Returns:: Dynamic topography elevation relative to present day.
Return type:: float

Notes

Note

Returns dynamic topography relative to present day.

Returns the dynamic_topography attribute if a dynamic_topography_model was specified to pybacktrack.backtrack_well() or pybacktrack.backtrack_and_write_well(), otherwise returns default_dynamic_topography.

Note

Dynamic topography is elevation which is opposite to tectonic subsidence in that an increase in dynamic topography results in a decrease in tectonic subsidence.

Note

default_dynamic_topography can be set to None

Added in version 1.2.

get_min_max_tectonic_subsidence()

Returns the minimum and maximum tectonic subsidence obtained directly from subsidence model (if backtracking) or indirectly from minimum and maximum water depth and sea level (if backstripping).

Returns:

min_tectonic_subsidence (float) – Minimum tectonic subsidence (unloaded water depth) of this decompacted well.
max_tectonic_subsidence (float) – Maximum tectonic subsidence (unloaded water depth) of this decompacted well.

Notes

When backtracking, the tectonic subsidence is obtained directly from the tectonic_subsidence attribute. In this case the minimum and maximum tectonic subsidence are the same.

When backstripping, the tectonic subsidence is obtained indirectly from the min_water_depth and max_water_depth attributes and optional sea_level attribute (if a sea level model was specified).

Added in version 1.2.

get_min_max_tectonic_subsidence_from_water_depth(min_water_depth, max_water_depth, sea_level=None)

Returns the minimum and maximum tectonic subsidence obtained from specified minimum and maximum water depths (and optional sea level).

Parameters:

min_water_depth (float) – Minimum water depth.
max_water_depth (float) – Maximum water depth.
sea_level (float, optional) – Sea level relative to present day (positive to sea-level rise and negative for sea-level fall).

Returns:

min_tectonic_subsidence (float) – Minimum tectonic subsidence (unloaded water depth) of this decompacted well from its minimum water depth.
max_tectonic_subsidence (float) – Maximum tectonic subsidence (unloaded water depth) of this decompacted well from its maximum water depth.

Notes

Optional sea level fluctuation is included if specified.

get_min_max_water_depth()

Returns the minimum and maximum water depth obtained directly from minimum and maximum water depth (if backstripping) or indirectly from tectonic subsidence model and sea level (if backtracking).

Returns:

min_water_depth (float) – Minimum water depth of this decompacted well.
max_water_depth (float) – Maximum water depth of this decompacted well.

Notes

When backstripping, the minimum and maximum water depths are obtained directly from the min_water_depth and max_water_depth attributes.

When backtracking, the water depth is obtained indirectly from the tectonic_subsidence attribute and optional sea_level attribute (if a sea level model was specified). In this case the minimum and maximum water depths are the same.

Added in version 1.2.

get_sea_level(default_sea_level=0.0)

Returns the sea level relative to present day, or default_sea_level if a sea level model was not specified (when either backtracking or backstripping).

Returns:: Sea level relative to present day (positive to sea-level rise and negative for sea-level fall).
Return type:: float

Notes

Returns the sea_level attribute if a sea_level_model was specified to pybacktrack.backtrack_well() or pybacktrack.backstrip_well(), otherwise returns default_sea_level.

Note

default_sea_level can be set to None

Added in version 1.2.

get_sediment_isostatic_correction()

Returns:: Isostatic correction of this decompacted well.
Return type:: float

Notes

The returned correction can be added to a known water depth to obtain the deeper isostatically compensated, sediment-free water depth (tectonic subsidence). Or the correction could be subtracted from a known tectonic subsidence (unloaded water depth) to get the depth at sediment/water interface.

get_tectonic_subsidence()

Returns the tectonic subsidence obtained directly from subsidence model (if backtracking) or indirectly from average of minimum and maximum water depth and sea level (if backstripping).

Returns:: Tectonic subsidence (unloaded water depth) of this decompacted well.
Return type:: float

Notes

When backtracking, the tectonic subsidence is obtained directly from the tectonic_subsidence attribute.

When backstripping, the tectonic subsidence is obtained indirectly from the min_water_depth and max_water_depth attributes and optional sea_level attribute (if a sea level model was specified).

Added in version 1.2.

get_water_depth()

Returns the water depth obtained directly from average of minimum and maximum water depth (if backstripping) or indirectly from tectonic subsidence model and sea level (if backtracking).

Returns:: Water depth of this decompacted well.
Return type:: float

Notes

When backstripping, the water depth is obtained directly as an average of the min_water_depth and max_water_depth attributes.

When backtracking, the water depth is obtained indirectly from the tectonic_subsidence attribute and optional sea_level attribute (if a sea level model was specified).

Added in version 1.2.

get_water_depth_from_tectonic_subsidence(tectonic_subsidence, sea_level=None)

Returns the water depth of this decompacted well from the specified tectonic subsidence (and optional sea level).

Parameters:

tectonic_subsidence (float) – Tectonic subsidence.
sea_level (float, optional) – Sea level relative to present day (positive to sea-level rise and negative for sea-level fall).

Returns:

Water depth of this decompacted well from its tectonic subsidence (unloaded water depth).

Return type:

float

Notes

Optional sea level fluctuation (relative to present day) is included if specified.