{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "See " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.fft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " for definitions and conventions used." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Zero-padding, analogously with " }, { "__type": "CrossRef", "__tag": 4002, "value": "ifft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:ifft" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", is performed by appending zeros to the input along the specified dimension. Although this is the common approach, it might lead to surprising results. If another form of zero padding is desired, it must be performed before " }, { "__type": "CrossRef", "__tag": 4002, "value": "ifftn", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:ifftn" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " is called." } ] } ], "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": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "s" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "axes" }, { "__type": "Text", "__tag": 4046, "value": " have different length." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "IndexError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If an element of " }, { "__type": "ParamRef", "__tag": 4071, "name": "axes" }, { "__type": "Text", "__tag": 4046, "value": " is larger than than the number of axes of " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "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": "out", "annotation": "complex ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The truncated or zero-padded input, transformed along the axes indicated by " }, { "__type": "ParamRef", "__tag": 4071, "name": "axes" }, { "__type": "Text", "__tag": 4046, "value": ", or by a combination of " }, { "__type": "ParamRef", "__tag": 4071, "name": "s" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": ", as explained in the parameters section above." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Compute the N-dimensional inverse discrete Fourier Transform." } ] } ], "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": "a", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input array, can be complex." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "s", "annotation": "sequence of ints, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Shape (length of each transformed axis) of the output (" }, { "__type": "InlineCode", "__tag": 4051, "value": "s[0]" }, { "__type": "Text", "__tag": 4046, "value": " refers to axis 0, " }, { "__type": "InlineCode", "__tag": 4051, "value": "s[1]" }, { "__type": "Text", "__tag": 4046, "value": " to axis 1, etc.). This corresponds to " }, { "__type": "InlineCode", "__tag": 4051, "value": "n" }, { "__type": "Text", "__tag": 4046, "value": " for " }, { "__type": "InlineCode", "__tag": 4051, "value": "ifft(x, n)" }, { "__type": "Text", "__tag": 4046, "value": ". Along any axis, if the given shape is smaller than that of the input, the input is cropped. If it is larger, the input is padded with zeros." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionchanged", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionchanged 2.0" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If it is " }, { "__type": "InlineCode", "__tag": 4051, "value": "-1" }, { "__type": "Text", "__tag": 4046, "value": ", the whole input is used (no padding/trimming)." } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "s" }, { "__type": "Text", "__tag": 4046, "value": " is not given, the shape of the input along the axes specified by " }, { "__type": "ParamRef", "__tag": 4071, "name": "axes" }, { "__type": "Text", "__tag": 4046, "value": " is used. See notes for issue on " }, { "__type": "CrossRef", "__tag": 4002, "value": "ifft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:ifft" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " zero padding." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "deprecated", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "deprecated 2.0" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "s" }, { "__type": "Text", "__tag": 4046, "value": " is not " }, { "__type": "InlineCode", "__tag": 4051, "value": "None" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "ParamRef", "__tag": 4071, "name": "axes" }, { "__type": "Text", "__tag": 4046, "value": " must not be " }, { "__type": "InlineCode", "__tag": 4051, "value": "None" }, { "__type": "Text", "__tag": 4046, "value": " either." } ] } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "deprecated", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "deprecated 2.0" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "ParamRef", "__tag": 4071, "name": "s" }, { "__type": "Text", "__tag": 4046, "value": " must contain only " }, { "__type": "InlineCode", "__tag": 4051, "value": "int" }, { "__type": "Text", "__tag": 4046, "value": " s, not " }, { "__type": "InlineCode", "__tag": 4051, "value": "None" }, { "__type": "Text", "__tag": 4046, "value": " values. " }, { "__type": "InlineCode", "__tag": 4051, "value": "None" }, { "__type": "Text", "__tag": 4046, "value": " values currently mean that the default value for " }, { "__type": "InlineCode", "__tag": 4051, "value": "n" }, { "__type": "Text", "__tag": 4046, "value": " is used in the corresponding 1-D transform, but this behaviour is deprecated." } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "axes", "annotation": "sequence of ints, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Axes over which to compute the IFFT. If not given, the last " }, { "__type": "InlineCode", "__tag": 4051, "value": "len(s)" }, { "__type": "Text", "__tag": 4046, "value": " axes are used, or all axes if " }, { "__type": "ParamRef", "__tag": 4071, "name": "s" }, { "__type": "Text", "__tag": 4046, "value": " is also not specified. Repeated indices in " }, { "__type": "ParamRef", "__tag": 4071, "name": "axes" }, { "__type": "Text", "__tag": 4046, "value": " means that the inverse transform over that axis is performed multiple times." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "deprecated", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "deprecated 2.0" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "s" }, { "__type": "Text", "__tag": 4046, "value": " is specified, the corresponding " }, { "__type": "ParamRef", "__tag": 4071, "name": "axes" }, { "__type": "Text", "__tag": 4046, "value": " to be transformed must be explicitly specified too." } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "norm", "annotation": "{\"backward\", \"ortho\", \"forward\"}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Normalization mode (see " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.fft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "). Default is \"backward\". Indicates which direction of the forward/backward pair of transforms is scaled and with what normalization factor." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 1.20.0" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The \"backward\", \"forward\" values were added." } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "out", "annotation": "complex ndarray, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If provided, the result will be placed in this array. It should be of the appropriate shape and dtype for all axes (and hence is incompatible with passing in all but the trivial " }, { "__type": "InlineCode", "__tag": 4051, "value": "s" }, { "__type": "Text", "__tag": 4046, "value": ")." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 2.0.0" } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This function computes the inverse of the N-dimensional discrete Fourier Transform over any number of axes in an M-dimensional array by means of the Fast Fourier Transform (FFT). In other words, " }, { "__type": "InlineCode", "__tag": 4051, "value": "ifftn(fftn(a)) == a" }, { "__type": "Text", "__tag": 4046, "value": " to within numerical accuracy. For a description of the definitions and conventions used, see " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.fft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The input, analogously to " }, { "__type": "CrossRef", "__tag": 4002, "value": "ifft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:ifft" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", should be ordered in the same way as is returned by " }, { "__type": "CrossRef", "__tag": 4002, "value": "fftn", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:fftn" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", i.e. it should have the term for zero frequency in all axes in the low-order corner, the positive frequency terms in the first half of all axes, the term for the Nyquist frequency in the middle of all axes and the negative frequency terms in the second half of all axes, in order of decreasingly negative frequency." } ] } ], "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/fft/_pocketfft.py", "item_line": 887, "item_type": "_ArrayFunctionDispatcher", "aliases": [ "numpy.fft.ifftn" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\na = np.eye(4)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.fft.ifftn(np.fft.fftn(a, axes=(0,)), axes=(1,))\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nCreate and plot an image with band-limited frequency content:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import matplotlib.pyplot as plt\nn = np.zeros((200,200), dtype=complex)\nn[60:80, 20:40] = np.exp(1j*np.random.uniform(0, 2*np.pi, (20, 20)))\nim = np.fft.ifftn(n).real\nplt.imshow(im)\nplt.show()\n", "execution_status": "success" }, { "__type": "Figure", "__tag": 4024, "value": { "__type": "RefInfo", "__tag": 4000, "module": "numpy", "version": "2.4.3", "kind": "assets", "path": "fig-57dcb1cba5eb584e.png" } } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "fftn", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:fftn" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The forward " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "n" } ] }, { "__type": "Text", "__tag": 4046, "value": "-dimensional FFT, of which " }, { "__type": "InlineRole", "__tag": 4003, "value": "ifftn", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " is the inverse." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "ifft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:ifft" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The one-dimensional inverse FFT." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "ifft2", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:ifft2" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The two-dimensional inverse FFT." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "ifftshift", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:ifftshift" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Undoes " }, { "__type": "InlineRole", "__tag": 4003, "value": "fftshift", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", shifts zero-frequency terms to beginning of array." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "numpy.fft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Overall view of discrete Fourier transforms, with definitions and conventions used." } ] } ], "type": null } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "a", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "s", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "axes", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "norm", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "out", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "ifftn" }, "references": null, "qa": "numpy.fft:ifftn", "arbitrary": [], "local_refs": [ "a", "axes", "norm", "out", "s" ] }