isoutside

openpnm.topotools.generators.tools.isoutside(coords, shape)[source]

Identifies points that lie outside the specified shape

Parameters
  • coords (array_like) – The coordinates which are to be checked

  • shape (array_like) –

    The shape of the domain beyond which points should be trimmed. The argument is treated as follows:

    sphere : If a scalar or single element list is received, it’s treated as the radius [r] of a sphere centered on [0, 0, 0].

    cylinder : If a two-element list is received it’s treated as the radius and height of a cylinder [r, z] whose central axis starts at [0, 0, 0] and extends in the positive z-direction.

    rectangle : If a three element list is received, it’s treated as the outer corner of rectangle [x, y, z] whose opposite corner lies at [0, 0, 0].

Returns

  • An Np-long mask of True values indicating pores that lie outside the

  • domain.