combine_proportions builtin

combine_proportions(
    coords, vertical, areal, *, elevation=None
)

Category proportions in 3D from a vertical proportion curve and areal proportion maps: at each target, the curve at its height times the areal proportions over the global ones, rescaled to sum 1. Areal proportions equal to the global ones everywhere give back the curve.

Parameters:

Name	Type	Description	Default
coords	(array_like, PointSet or BlockModel)	Target locations, e.g. BlockModel cells.	required
vertical	Table	A curve from vertical_proportions: elevation, weight and one column per category. The global proportions are its weighted mean. It is linear between slice centers and constant beyond the ends.	required
areal	Table or array_like	Areal proportions at the targets, e.g. Trend.predict of a categorical trend at their x and y: a Table with the curve's category columns, or an (n, k) array in the curve's order. A row with a NaN keeps the curve alone.	required
elevation	array_like or str	Height of each target, as in vertical_proportions; default the z coordinate.	None

Returns:

Type	Description
Table	One column per category, each in [0, 1], summing to 1 in every row; proportions= of SIS and Plurigaussian.

used in

• local proportions