{ "__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": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "ValueError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Raised if some values are missing and " }, { "__type": "ParamRef", "__tag": 4071, "name": "allow_masked" }, { "__type": "Text", "__tag": 4046, "value": " is False." } ] } ] } ] } ], "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": "Estimate the covariance matrix." } ] } ], "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": "x", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A 1-D or 2-D array containing multiple variables and observations. Each row of " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": " represents a variable, and each column a single observation of all those variables. Also see " }, { "__type": "ParamRef", "__tag": 4071, "name": "rowvar" }, { "__type": "Text", "__tag": 4046, "value": " below." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "y", "annotation": "array_like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "An additional set of variables and observations. " }, { "__type": "ParamRef", "__tag": 4071, "name": "y" }, { "__type": "Text", "__tag": 4046, "value": " has the same shape as " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "rowvar", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "rowvar" }, { "__type": "Text", "__tag": 4046, "value": " is True (default), then each row represents a variable, with observations in the columns. Otherwise, the relationship is transposed: each column represents a variable, while the rows contain observations." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "bias", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Default normalization (False) is by " }, { "__type": "InlineCode", "__tag": 4051, "value": "(N-1)" }, { "__type": "Text", "__tag": 4046, "value": ", where " }, { "__type": "InlineCode", "__tag": 4051, "value": "N" }, { "__type": "Text", "__tag": 4046, "value": " is the number of observations given (unbiased estimate). If " }, { "__type": "ParamRef", "__tag": 4071, "name": "bias" }, { "__type": "Text", "__tag": 4046, "value": " is True, then normalization is by " }, { "__type": "InlineCode", "__tag": 4051, "value": "N" }, { "__type": "Text", "__tag": 4046, "value": ". This keyword can be overridden by the keyword " }, { "__type": "InlineCode", "__tag": 4051, "value": "ddof" }, { "__type": "Text", "__tag": 4046, "value": " in numpy versions >= 1.5." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "allow_masked", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, masked values are propagated pair-wise: if a value is masked in " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": ", the corresponding value is masked in " }, { "__type": "ParamRef", "__tag": 4071, "name": "y" }, { "__type": "Text", "__tag": 4046, "value": ". If False, raises a " }, { "__type": "InlineRole", "__tag": 4003, "value": "ValueError", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " exception when some values are missing." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "ddof", "annotation": "{None, int}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If not " }, { "__type": "InlineCode", "__tag": 4051, "value": "None" }, { "__type": "Text", "__tag": 4046, "value": " normalization is by " }, { "__type": "InlineCode", "__tag": 4051, "value": "(N - ddof)" }, { "__type": "Text", "__tag": 4046, "value": ", where " }, { "__type": "InlineCode", "__tag": 4051, "value": "N" }, { "__type": "Text", "__tag": 4046, "value": " is the number of observations; this overrides the value implied by " }, { "__type": "InlineCode", "__tag": 4051, "value": "bias" }, { "__type": "Text", "__tag": 4046, "value": ". The default value is " }, { "__type": "InlineCode", "__tag": 4051, "value": "None" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Except for the handling of missing data this function does the same as " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.cov", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:cov" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ". For more details and examples, see " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.cov", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:cov" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "By default, masked values are recognized as such. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "y" }, { "__type": "Text", "__tag": 4046, "value": " have the same shape, a common mask is allocated: if " }, { "__type": "InlineCode", "__tag": 4051, "value": "x[i,j]" }, { "__type": "Text", "__tag": 4046, "value": " is masked, then " }, { "__type": "InlineCode", "__tag": 4051, "value": "y[i,j]" }, { "__type": "Text", "__tag": 4046, "value": " will also be masked. Setting " }, { "__type": "ParamRef", "__tag": 4071, "name": "allow_masked" }, { "__type": "Text", "__tag": 4046, "value": " to False will raise an exception if values are missing in either of the input arrays." } ] } ], "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": "/numpy/ma/extras.py", "item_line": 1580, "item_type": "function", "aliases": [ "numpy.ma.cov" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nx = np.ma.array([[0, 1], [1, 1]], mask=[0, 1, 0, 1])\ny = np.ma.array([[1, 0], [0, 1]], mask=[0, 0, 1, 1])\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.ma.cov(x, y)\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "numpy.cov", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:cov" }, "kind": "module" }, "descriptions": [], "type": null } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "x", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "y", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "rowvar", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "bias", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "allow_masked", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "ddof", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "cov" }, "references": null, "qa": "numpy.ma.extras:cov", "arbitrary": [], "local_refs": [ "allow_masked", "bias", "ddof", "rowvar", "x", "y" ] }