flatten_mask(mask)

Parameters

mask : array_like

Input array, which will be interpreted as booleans.

Returns

flattened_mask : ndarray of bools

The flattened input.

Returns a completely flattened version of the mask, where nested fields are collapsed.

Examples

This example is valid syntax, but we were not able to check execution

>>> mask = np.array([0, 0, 1])
... np.ma.flatten_mask(mask)
array([False, False,  True])

This example is valid syntax, but we were not able to check execution

>>> mask = np.array([(0, 0), (0, 1)], dtype=[('a', bool), ('b', bool)])
... np.ma.flatten_mask(mask)
array([False, False, False,  True])

This example is valid syntax, but we were not able to check execution

>>> mdtype = [('a', bool), ('b', [('ba', bool), ('bb', bool)])]
... mask = np.array([(0, (0, 0)), (0, (0, 1))], dtype=mdtype)
... np.ma.flatten_mask(mask)
array([False, False, False, False, False,  True])

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them

---

GitHub : /numpy/ma/core.py#1753
type: <class 'function'>
Commit: