map_pores¶
- LegacyMixin.map_pores(pores, origin, filtered=True)[source]¶
Given a list of pore on a target object, finds indices of those pores on the calling object
- Parameters
pores (array_like) – The indices of the pores on the object specifiedin
origin
origin (Base) – The object corresponding to the indices given in
pores
filtered (bool (default is
True
)) – IfTrue
then a ndarray of indices is returned with missing indices removed, otherwise a named-tuple containing both theindices
and a booleanmask
withFalse
indicating which locations were not found.
- Returns
Pore indices on the calling object corresponding to the same pores
on the
origin
object. Can be an array or a tuple containing anarray and a mask, depending on the value of
filtered
.
See also
pores
,map_throats