{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.14" } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "In the case that " }, { "__type": "InlineCode", "__tag": 4051, "value": "xi.ndim == 1" }, { "__type": "Text", "__tag": 4046, "value": " a new axis is inserted into the 0 position of the returned array, values_x, so its shape is instead " }, { "__type": "InlineCode", "__tag": 4051, "value": "(1,) + values.shape[ndim:]" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If the input data is such that input dimensions have incommensurate units and differ by many orders of magnitude, the interpolant may have numerical artifacts. Consider rescaling the data before interpolation." } ] } ], "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": "values_x", "annotation": "ndarray, shape xi.shape[:-1] + values.shape[ndim:]", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Interpolated values at " }, { "__type": "ParamRef", "__tag": 4071, "name": "xi" }, { "__type": "Text", "__tag": 4046, "value": ". See notes for behaviour when " }, { "__type": "InlineCode", "__tag": 4051, "value": "xi.ndim == 1" }, { "__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": "Multidimensional interpolation on regular or rectilinear grids." } ] } ], "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": "points", "annotation": "tuple of ndarray of float, with shapes (m1, ), ..., (mn, )", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The points defining the regular grid in n dimensions. The points in each dimension (i.e. every elements of the points tuple) must be strictly ascending or descending." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "values", "annotation": "array_like, shape (m1, ..., mn, ...)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The data on the regular grid in n dimensions. Complex data is accepted." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "xi", "annotation": "ndarray of shape (..., ndim)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The coordinates to sample the gridded data at" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "method", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The method of interpolation to perform. Supported are \"linear\", \"nearest\", \"slinear\", \"cubic\", \"quintic\", \"pchip\", and \"splinef2d\". \"splinef2d\" is only supported for 2-dimensional data." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "bounds_error", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, when interpolated values are requested outside of the domain of the input data, a ValueError is raised. If False, then " }, { "__type": "ParamRef", "__tag": 4071, "name": "fill_value" }, { "__type": "Text", "__tag": 4046, "value": " is used." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "fill_value", "annotation": "number, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If provided, the value to use for points outside of the interpolation domain. If None, values outside the domain are extrapolated. Extrapolation is not supported by method \"splinef2d\"." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Strictly speaking, not all regular grids are supported - this function works on " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "rectilinear" } ] }, { "__type": "Text", "__tag": 4046, "value": " grids, that is, a rectangular grid with even or uneven spacing." } ] } ], "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/interpolate/_rgi.py", "item_line": 645, "item_type": "function", "aliases": [ "scipy.interpolate.interpn" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "Evaluate a simple example function on the points of a regular 3-D grid:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.interpolate import interpn\ndef value_func_3d(x, y, z):\n return 2 * x + 3 * y - z\nx = np.linspace(0, 4, 5)\ny = np.linspace(0, 5, 6)\nz = np.linspace(0, 6, 7)\npoints = (x, y, z)\nvalues = value_func_3d(*np.meshgrid(*points, indexing='ij'))\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nEvaluate the interpolating function at a point\n\n" }, { "__type": "Code", "__tag": 4050, "value": "point = np.array([2.21, 3.12, 1.15])\nprint(interpn(points, values, point))\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nCompare with value at point by function\n\n" }, { "__type": "Code", "__tag": 4050, "value": "value_func_3d(*point)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nSince the function is linear, the interpolation is exact using linear method." } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "LinearNDInterpolator", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.interpolate._interpnd:LinearNDInterpolator" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Piecewise linear interpolant on unstructured data in N dimensions" } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "NearestNDInterpolator", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.interpolate._ndgriddata:NearestNDInterpolator" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Nearest neighbor interpolation on unstructured data in N dimensions" } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "RectBivariateSpline", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.interpolate._fitpack2:RectBivariateSpline" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Bivariate spline approximation over a rectangular mesh" } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "RegularGridInterpolator", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.interpolate._rgi:RegularGridInterpolator" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "interpolation on a regular or rectilinear grid in arbitrary dimensions (" }, { "__type": "InlineRole", "__tag": 4003, "value": "interpn", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " wraps this class)." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "scipy.ndimage.map_coordinates", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.ndimage._interpolation:map_coordinates" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "interpolation on grids with equal spacing (suitable for e.g., N-D image resampling)" } ] } ], "type": null } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "points", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "values", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "xi", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "method", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "linear" }, { "__type": "SigParam", "__tag": 4030, "name": "bounds_error", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "fill_value", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "nan" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "interpn" }, "references": null, "qa": "scipy.interpolate._rgi:interpn", "arbitrary": [], "local_refs": [ "bounds_error", "fill_value", "method", "points", "values", "values_x", "xi" ] }