utils.submask#

Back to Module page

Summary#

Signature#

def submask(bigmask, *indarrays)

Input variables#
Name	Type	Default	Description
`bigmask`			Boolean mask that picks out a subset of \`valid’ elements within a set
`\*indarrays`			Each indarray is either a list of indices or a Boolean mask, into the parent set of bigmask, to be retained, subject to validity

Output variables#

Return annotation	Docstring type	Description
`None`		Boolean mask (of length np.count_nonzero(bigmask)) into the set of \`valid’ elements that picks out elements indexed by the union of the indarrays

Docstring#

:param bigmask:
    Boolean mask that picks out a subset of `valid' elements within a set
:param indarrays:
    Each indarray is either a list of indices or a Boolean mask, into the
    parent set of bigmask, to be retained, subject to validity
:return: Boolean mask (of length np.count_nonzero(bigmask)) into the set of
`valid' elements that picks out elements indexed by the union of the
indarrays