{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When using \"same\" mode with even-length inputs, the outputs of " }, { "__type": "InlineRole", "__tag": 4003, "value": "correlate", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "CrossRef", "__tag": 4002, "value": "correlate2d", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "correlate2d" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " differ: There is a 1-index offset between them." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "Array API Standard Support" } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "correlate2d", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "correlate2d" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " has experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variable " }, { "__type": "InlineCode", "__tag": 4051, "value": "SCIPY_ARRAY_API=1" }, { "__type": "Text", "__tag": 4046, "value": " and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported." } ] }, { "__type": "Code", "__tag": 4050, "value": "==================== ==================== ====================\nLibrary CPU GPU\n==================== ==================== ====================\nNumPy ✅ n/a \nCuPy n/a ✅ \nPyTorch ✅ ⛔ \nJAX ✅ ✅ \nDask ⚠️ computes graph n/a \n==================== ==================== ====================", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The JAX backend only supports " }, { "__type": "InlineCode", "__tag": 4051, "value": "boundary=\"fill\"" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "fillvalue=0" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "See " }, { "__type": "InlineRole", "__tag": 4003, "value": "dev-arrayapi", "domain": null, "role": "ref", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for more information." } ] } ] } ], "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": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "correlate2d", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A 2-dimensional array containing a subset of the discrete linear cross-correlation of " }, { "__type": "ParamRef", "__tag": 4071, "name": "in1" }, { "__type": "Text", "__tag": 4046, "value": " with " }, { "__type": "ParamRef", "__tag": 4071, "name": "in2" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Cross-correlate two 2-dimensional arrays." } ] } ], "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": "in1", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "First input." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "in2", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Second input. Should have the same number of dimensions as " }, { "__type": "ParamRef", "__tag": 4071, "name": "in1" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "mode", "annotation": "str {'full', 'valid', 'same'}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A string indicating the size of the output:" } ] }, { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "full" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The output is the full discrete linear cross-correlation of the inputs. (Default)" } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "valid" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The output consists only of those elements that do not rely on the zero-padding. In 'valid' mode, either " }, { "__type": "ParamRef", "__tag": 4071, "name": "in1" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "ParamRef", "__tag": 4071, "name": "in2" }, { "__type": "Text", "__tag": 4046, "value": " must be at least as large as the other in every dimension." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "same" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The output is the same size as " }, { "__type": "ParamRef", "__tag": 4071, "name": "in1" }, { "__type": "Text", "__tag": 4046, "value": ", centered with respect to the 'full' output." } ] } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "boundary", "annotation": "str {'fill', 'wrap', 'symm'}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A flag indicating how to handle boundaries:" } ] }, { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "fill" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "pad input arrays with fillvalue. (default)" } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "wrap" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "circular boundary conditions." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "symm" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "symmetrical boundary conditions." } ] } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "fillvalue", "annotation": "scalar, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Value to fill pad input arrays with. Default is 0." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Cross correlate " }, { "__type": "ParamRef", "__tag": 4071, "name": "in1" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "in2" }, { "__type": "Text", "__tag": 4046, "value": " with output size determined by " }, { "__type": "ParamRef", "__tag": 4071, "name": "mode" }, { "__type": "Text", "__tag": 4046, "value": ", and boundary conditions determined by " }, { "__type": "ParamRef", "__tag": 4071, "name": "boundary" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "fillvalue" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "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": "/scipy/signal/_signaltools.py", "item_line": 1829, "item_type": "function", "aliases": [ "scipy.signal.correlate2d" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "Use 2D cross-correlation to find the location of a template in a noisy\nimage:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy import signal, datasets, ndimage\nrng = np.random.default_rng()\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "face = datasets.face(gray=True) - datasets.face(gray=True).mean()\nface = ndimage.zoom(face[30:500, 400:950], 0.5) # extract the face\ntemplate = np.copy(face[135:165, 140:175]) # right eye\ntemplate -= template.mean()\nface = face + rng.standard_normal(face.shape) * 50 # add noise\ncorr = signal.correlate2d(face, template, boundary='symm', mode='same')\ny, x = np.unravel_index(np.argmax(corr), corr.shape) # find the match\n", "execution_status": "unexpected_exception" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "import matplotlib.pyplot as plt\nfig, (ax_orig, ax_template, ax_corr) = plt.subplots(3, 1,\n figsize=(6, 15))\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "ax_orig.imshow(face, cmap='gray')\n", "execution_status": "unexpected_exception" }, { "__type": "Code", "__tag": 4050, "value": "ax_orig.set_title('Original')\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "ax_orig.set_axis_off()\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "ax_template.imshow(template, cmap='gray')\n", "execution_status": "unexpected_exception" }, { "__type": "Code", "__tag": 4050, "value": "ax_template.set_title('Template')\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "ax_template.set_axis_off()\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "ax_corr.imshow(corr, cmap='gray')\n", "execution_status": "unexpected_exception" }, { "__type": "Code", "__tag": 4050, "value": "ax_corr.set_title('Cross-correlation')\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "ax_corr.set_axis_off()\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "ax_orig.plot(x, y, 'ro')\n", "execution_status": "unexpected_exception" }, { "__type": "Code", "__tag": 4050, "value": "fig.show()\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "in1", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "in2", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "mode", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "full" }, { "__type": "SigParam", "__tag": 4030, "name": "boundary", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "fill" }, { "__type": "SigParam", "__tag": 4030, "name": "fillvalue", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "correlate2d" }, "references": null, "qa": "scipy.signal._signaltools:correlate2d", "arbitrary": [], "local_refs": [ "boundary", "correlate2d", "fillvalue", "in1", "in2", "mode" ] }