to_mask

Voronoi.to_mask(pores=None, throats=None)

Generates a boolean mask with True values in the given locations

Parameters:

• pores (array_like) – The pore indices where True values will be placed. If pores is given the throats is ignored.

• throats (array_like) – The throat indices where True values will be placed. If pores is given the throats is ignored.

Returns:

mask – A boolean array of length Np is pores was given or Nt if throats was given.

Return type:

ndarray, boolean