bond_number

bond_number(im: ndarray[Any, dtype[_ScalarType_co]], delta_rho: float, g: float, sigma: float, voxel_size: float, source: str = 'lt', method: str = 'median', mask: bool = False)[source]

Computes the Bond number for an image

Parameters:
  • im (ndarray) – The image of the domain with True values indicating the phase of interest space

  • delta_rho (float) – The difference in the density of the non-wetting and wetting phase

  • g (float) – The gravitational constant for the system

  • sigma (float) – The surface tension of the fluid pair

  • voxel_size (float) – The size of the voxels

  • source (str) –

    The source of the pore size values to use when computing the characteristic length R. Options are:

    Option

    Description

    dt

    Uses the distance transform

    lt

    Uses the local thickness

  • method (str) –

    The method to use for finding the characteristic length R from the values in source. Options are:

    Option

    Description

    mean

    The arithmetic mean (using numpy.mean)

    min (or amin)

    The minimum value (using numpy.amin)

    max (or amax)

    The maximum value (using numpy.amax)

    mode

    The mode of the values (using scipy.stats.mode)

    gmean

    The geometric mean of the values (using scipy.stats.gmean)

    hmean

    The harmonic mean of the values (using scipy.stats.hmean)

    pmean

    The power mean of the values (using scipy.stats.pmean)

  • mask (bool) – If True then the distance values in source are masked by the skeleton before computing the average value using the specified method.