nlcpy.ma.make_mask_none

nlcpy.ma.make_mask_none(newshape, dtype=None)[ソース]

Returns a boolean mask of the given shape, filled with False.

This function returns a boolean ndarray with all entries False, that can be used in common mask manipulations. If a complex dtype is specified, the type of each field is converted to a boolean type.

Parameters

newshapetuple: A tuple indicating the shape of the mask.
dtype{None, dtype}, optional: If None, use a MaskType instance. Otherwise, use a new datatype with the same fields as dtype, converted to boolean types.

Returns

resultndarray: An ndarray of appropriate shape and dtype, filled with False.

参考

make_mask: Creates a boolean mask from an array.

Examples

>>> import nlcpy.ma as ma
>>> ma.make_mask_none((3,))
array([False, False, False])