Overlays

subsurfaceio.reference_figure.overlays

Builders for annotation overlays drawn on reference figures.

Functions:

Name	Description
`atterberg_overlays`	Build flow-curve and liquid-limit overlays for an Atterberg chart.
`sieve_overlays`	Build D-value marker overlays for a sieve analysis chart.

atterberg_overlays

atterberg_overlays(
    *,
    liquid_limit_blows: list[float] | ndarray | None = None,
    water_content: list[float] | ndarray | None = None,
    liquid_limit: float | None = None
) -> tuple[Overlay, ...]

Build flow-curve and liquid-limit overlays for an Atterberg chart.

Parameters:

Name	Type	Description	Default
`liquid_limit_blows`	`list[float] \| ndarray \| None`	Blow counts for the flow-curve fit, or `None`.	`None`
`water_content`	`list[float] \| ndarray \| None`	Water contents paired with `liquid_limit_blows`.	`None`
`liquid_limit`	`float \| None`	Liquid limit marker ordinate, or `None` to omit.	`None`

Returns:

Type	Description
`tuple[Overlay, ...]`	Overlay traces for the values that were provided.

sieve_overlays

sieve_overlays(
    *,
    diameter_at_60_percent_finer: float | None = None,
    diameter_at_50_percent_finer: float | None = None,
    diameter_at_30_percent_finer: float | None = None,
    diameter_at_10_percent_finer: float | None = None
) -> tuple[Overlay, ...]

Build D-value marker overlays for a sieve analysis chart.

Parameters:

Name	Type	Description	Default
`diameter_at_60_percent_finer`	`float \| None`	D60 particle diameter, or `None` to omit.	`None`
`diameter_at_50_percent_finer`	`float \| None`	D50 particle diameter, or `None` to omit.	`None`
`diameter_at_30_percent_finer`	`float \| None`	D30 particle diameter, or `None` to omit.	`None`
`diameter_at_10_percent_finer`	`float \| None`	D10 particle diameter, or `None` to omit.	`None`

Returns:

Type	Description
`tuple[Overlay, ...]`	Overlay traces for the diameters that were provided.