find_h¶

find_h(saturation, position=None, srange=[0.01, 0.99])[source]¶

Given a saturation profile, compute the height between given bounds

Parameters:

saturation (array_like) – A list of saturation values as function of position
position (array_like, optional) – A list of positions corresponding to each saturation. If not provided then each value in saturation is assumed to be separated by 1 voxel.
srange (list) – The minimum and maximum value of saturation to consider as the start and end of the profile

Returns:

Attribute	Description
zmax	The position where the saturation first exceeds smax
zmin	The position where the saturation first exceeds smin
smax	The value defining the start of the saturation profile
smin	The value defining the end of the saturation profile
h	The total distance in voxels between zmax and zmin
valid	A flag indicating whether the requested saturation difference (between smin and smax) was found.

Return type:

A dataclass-like object with the following attributes

See also

Notes

The satn_profile function can be used to obtain the saturation and position from an image, such as a displacement map produced by drainage or imbibition.

Examples

Click here to view online example.