vertical_proportions builtin

vertical_proportions(
    coords,
    categories,
    *,
    size,
    elevation=None,
    weights=None,
    scheme=None,
)

Vertical proportion curve: the weighted proportion of each category in slices of height.

Parameters:

Name	Type	Description	Default
coords	(array_like, PointSet or BlockModel)	Sample locations, shape (n, 2) or (n, 3), or a container.	required
categories	array_like or str	Category label of each sample, or the column of coords holding them; null labels are skipped.	required
size	float	Slice thickness; slices start at multiples of it.	required
elevation	array_like or str	Height of each sample, e.g. stratigraphic height above a base surface, or the column of coords holding it; default the z coordinate.	None
weights	array_like or str	Declustering weights or lengths, or the column of coords holding them.	None
scheme	Categories	Order and names of the categories, which encode the labels; default the order of Categories.from_values.	None

Returns:

Type	Description
Table	One row per slice holding data, bottom up: elevation, the slice center, weight, the weight in it, and the proportion of each category, one column per name, summing to 1.

used in

• local proportions