{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Yields": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Methods": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "An array class with possibly masked values." } ] } ], "title": [], "level": 0, "target": null }, "Receives": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warnings": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Attributes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "data", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input data." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "mask", "annotation": "sequence, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Mask. Must be convertible to an array of booleans with the same shape as " }, { "__type": "ParamRef", "__tag": 4071, "name": "data" }, { "__type": "Text", "__tag": 4046, "value": ". True indicates a masked (i.e. invalid) data." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "dtype", "annotation": "dtype, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Data type of the output. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "dtype" }, { "__type": "Text", "__tag": 4046, "value": " is None, the type of the data argument (" }, { "__type": "InlineCode", "__tag": 4051, "value": "data.dtype" }, { "__type": "Text", "__tag": 4046, "value": ") is used. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "dtype" }, { "__type": "Text", "__tag": 4046, "value": " is not None and different from " }, { "__type": "InlineCode", "__tag": 4051, "value": "data.dtype" }, { "__type": "Text", "__tag": 4046, "value": ", a copy is performed." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "copy", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether to copy the input data (True), or to use a reference instead. Default is False." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "subok", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether to return a subclass of " }, { "__type": "CrossRef", "__tag": 4002, "value": "MaskedArray", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.ma:MaskedArray" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " if possible (True) or a plain " }, { "__type": "CrossRef", "__tag": 4002, "value": "MaskedArray", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.ma:MaskedArray" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ". Default is True." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "ndmin", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Minimum number of dimensions. Default is 0." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "fill_value", "annotation": "scalar, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Value used to fill in the masked values when necessary. If None, a default based on the data-type is used." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "keep_mask", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether to combine " }, { "__type": "ParamRef", "__tag": 4071, "name": "mask" }, { "__type": "Text", "__tag": 4046, "value": " with the mask of the input data, if any (True), or to use only " }, { "__type": "ParamRef", "__tag": 4071, "name": "mask" }, { "__type": "Text", "__tag": 4046, "value": " for the output (False). Default is True." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "hard_mask", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether to use a hard mask or not. With a hard mask, masked values cannot be unmasked. Default is False." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "shrink", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether to force compression of an empty mask. Default is True." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "order", "annotation": "{'C', 'F', 'A'}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Specify the order of the array. If order is 'C', then the array will be in C-contiguous order (last-index varies the fastest). If order is 'F', then the returned array will be in Fortran-contiguous order (first-index varies the fastest). If order is 'A' (default), then the returned array may be in any order (either C-, Fortran-contiguous, or even discontiguous), unless a copy is required, in which case it will be C-contiguous." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Masked values of True exclude the corresponding element from any computation." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Construction " } ] }, { "__type": "Code", "__tag": 4050, "value": "x = MaskedArray(data, mask=nomask, dtype=None, copy=False, subok=True,\n ndmin=0, fill_value=None, keep_mask=True, hard_mask=None,\n shrink=True, order=None)", "execution_status": null } ], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Attributes", "Methods", "Returns", "Yields", "Receives", "Other Parameters", "Raises", "Warns", "Warnings", "Notes" ], "item_file": "build-install/usr/lib/python3.14/site-packages/numpy/ma/core.py", "item_line": 6843, "item_type": "function", "aliases": [ "numpy.ma.array" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\n", "execution_status": "none" }, { "__type": "Text", "__tag": 4046, "value": "\nThe ``mask`` can be initialized with an array of boolean values\nwith the same shape as ``data``.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "data = np.arange(6).reshape((2, 3))\nnp.ma.MaskedArray(data, mask=[[False, True, False],\n [False, False, True]])\n", "execution_status": "none" }, { "__type": "Text", "__tag": 4046, "value": "\nAlternatively, the ``mask`` can be initialized to homogeneous boolean\narray with the same shape as ``data`` by passing in a scalar\nboolean value:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.ma.MaskedArray(data, mask=False)\n", "execution_status": "none" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "np.ma.MaskedArray(data, mask=True)\n", "execution_status": "none" }, { "__type": "Text", "__tag": 4046, "value": "\n.. note::\n The recommended practice for initializing ``mask`` with a scalar\n boolean value is to use ``True``/``False`` rather than\n ``np.True_``/``np.False_``. The reason is :attr:`nomask`\n is represented internally as ``np.False_``.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.False_ is np.ma.nomask\n", "execution_status": "none" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "data", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "dtype", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "copy", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "order", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "mask", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "fill_value", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "keep_mask", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "hard_mask", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "shrink", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "subok", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "ndmin", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "array" }, "references": null, "qa": "numpy.ma.core:array", "arbitrary": [], "local_refs": [ "copy", "data", "dtype", "fill_value", "hard_mask", "keep_mask", "mask", "ndmin", "order", "shrink", "subok" ] }