{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For a 1-D signal " }, { "__type": "InlineCode", "__tag": 4051, "value": "x" }, { "__type": "Text", "__tag": 4046, "value": " to have a real spectrum, it must satisfy the Hermitian property " } ] }, { "__type": "Code", "__tag": 4050, "value": "x[i] == np.conj(x[-i]) for all i", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This generalizes into higher dimensions by reflecting over each axis in turn " } ] }, { "__type": "Code", "__tag": 4050, "value": "x[i, j, k, ...] == np.conj(x[-i, -j, -k, ...]) for all i, j, k, ...", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This should not be confused with a Hermitian matrix, for which the transpose is its own conjugate " } ] }, { "__type": "Code", "__tag": 4050, "value": "x[i, j] == np.conj(x[j, i]) for all i, j", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The default value of " }, { "__type": "ParamRef", "__tag": 4071, "name": "s" }, { "__type": "Text", "__tag": 4046, "value": " assumes an even output length in the final transformation axis. When performing the final complex to real transformation, the Hermitian symmetry requires that the last imaginary component along that axis must be 0 and so it is ignored. To avoid losing information, the correct length of the real input " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "must" } ] }, { "__type": "Text", "__tag": 4046, "value": " be given." } ] }, { "__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": "InlineRole", "__tag": 4003, "value": "hfftn", "domain": null, "role": null, "inventory": null }, { "__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": "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": [ { "__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 the number of axes of " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__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": "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": "x" }, { "__type": "Text", "__tag": 4046, "value": ", as explained in the parameters section above. The length of each transformed axis is as given by the corresponding element of " }, { "__type": "ParamRef", "__tag": 4071, "name": "s" }, { "__type": "Text", "__tag": 4046, "value": ", or the length of the input in every axis except for the last one if " }, { "__type": "ParamRef", "__tag": 4071, "name": "s" }, { "__type": "Text", "__tag": 4046, "value": " is not given. In the final transformed axis the length of the output when " }, { "__type": "ParamRef", "__tag": 4071, "name": "s" }, { "__type": "Text", "__tag": 4046, "value": " is not given is " }, { "__type": "InlineCode", "__tag": 4051, "value": "2*(m-1)" }, { "__type": "Text", "__tag": 4046, "value": " where " }, { "__type": "InlineCode", "__tag": 4051, "value": "m" }, { "__type": "Text", "__tag": 4046, "value": " is the length of the final transformed axis of the input. To get an odd number of output points in the final axis, " }, { "__type": "ParamRef", "__tag": 4071, "name": "s" }, { "__type": "Text", "__tag": 4046, "value": " must be specified." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Compute the N-D FFT of Hermitian symmetric complex input, i.e., a signal with a real spectrum." } ] } ], "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": "Input array." } ] } ] }, { "__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.). " }, { "__type": "ParamRef", "__tag": 4071, "name": "s" }, { "__type": "Text", "__tag": 4046, "value": " is also the number of input points used along this axis, except for the last axis, where " }, { "__type": "InlineCode", "__tag": 4051, "value": "s[-1]//2+1" }, { "__type": "Text", "__tag": 4046, "value": " points of the input are used. Along any axis, if the shape indicated by " }, { "__type": "ParamRef", "__tag": 4071, "name": "s" }, { "__type": "Text", "__tag": 4046, "value": " is smaller than that of the input, the input is cropped. If it is larger, the input is padded with zeros. 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 axes is used. Except for the last axis which is taken to be " }, { "__type": "InlineCode", "__tag": 4051, "value": "2*(m-1)" }, { "__type": "Text", "__tag": 4046, "value": " where " }, { "__type": "InlineCode", "__tag": 4051, "value": "m" }, { "__type": "Text", "__tag": 4046, "value": " is the length of the input along that axis." } ] } ] }, { "__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 inverse FFT. If not given, the last " }, { "__type": "InlineRole", "__tag": 4003, "value": "len(s)", "domain": null, "role": null, "inventory": null }, { "__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." } ] } ] }, { "__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": "fft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.fft" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "). Default is \"backward\"." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "overwrite_x", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, the contents of " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": " can be destroyed; the default is False. See " }, { "__type": "CrossRef", "__tag": 4002, "value": "fft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.fft" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " for more details." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "workers", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum number of workers to use for parallel computation. If negative, the value wraps around from " }, { "__type": "InlineCode", "__tag": 4051, "value": "os.cpu_count()" }, { "__type": "Text", "__tag": 4046, "value": ". See " }, { "__type": "CrossRef", "__tag": 4002, "value": "fft", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "*", "kind": "api", "path": "scipy.fft._basic:fft" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " for more details." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "plan", "annotation": "object, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This argument is reserved for passing in a precomputed plan provided by downstream FFT vendors. It is currently not used in SciPy." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 1.5.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 N-D discrete Fourier Transform for a Hermitian symmetric complex input over any number of axes in an M-D array by means of the Fast Fourier Transform (FFT). In other words, " }, { "__type": "InlineCode", "__tag": 4051, "value": "ihfftn(hfftn(x, s)) == x" }, { "__type": "Text", "__tag": 4046, "value": " to within numerical accuracy. (" }, { "__type": "InlineCode", "__tag": 4051, "value": "s" }, { "__type": "Text", "__tag": 4046, "value": " here is " }, { "__type": "InlineCode", "__tag": 4051, "value": "x.shape" }, { "__type": "Text", "__tag": 4046, "value": " with " }, { "__type": "InlineCode", "__tag": 4051, "value": "s[-1] = x.shape[-1] * 2 - 1" }, { "__type": "Text", "__tag": 4046, "value": ", this is necessary for the same reason " }, { "__type": "InlineCode", "__tag": 4051, "value": "x.shape" }, { "__type": "Text", "__tag": 4046, "value": " would be necessary for " }, { "__type": "InlineRole", "__tag": 4003, "value": "irfft", "domain": null, "role": null, "inventory": null }, { "__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/fft/_basic.py", "item_line": 1357, "item_type": "_Function", "aliases": [ "scipy.fft.hfftn" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import scipy.fft\nimport numpy as np\nx = np.ones((3, 2, 2))\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "scipy.fft.hfftn(x)\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "fft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.fft" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The 1-D FFT, with definitions and conventions used." } ] } ], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "ihfftn", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "ihfftn" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The inverse N-D FFT with real spectrum. Inverse of " }, { "__type": "InlineRole", "__tag": 4003, "value": "hfftn", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "rfft", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "rfft" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Forward FFT of real input." } ] } ], "type": "func" } ], "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": "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": "overwrite_x", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "workers", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "plan", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "hfftn" }, "references": null, "qa": "scipy.fft._basic:hfftn", "arbitrary": [], "local_refs": [ "axes", "norm", "out", "overwrite_x", "plan", "s", "workers", "x" ] }