{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "hfft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:hfft" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "/" }, { "__type": "CrossRef", "__tag": 4002, "value": "ihfft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:ihfft" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " are a pair analogous to " }, { "__type": "CrossRef", "__tag": 4002, "value": "rfft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:rfft" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "/" }, { "__type": "CrossRef", "__tag": 4002, "value": "irfft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:irfft" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", but for the opposite case: here the signal has Hermitian symmetry in the time domain and is real in the frequency domain. So here it's " }, { "__type": "CrossRef", "__tag": 4002, "value": "hfft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:hfft" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " for which you must supply the length of the result if it is to be odd." } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "even: " }, { "__type": "InlineCode", "__tag": 4051, "value": "ihfft(hfft(a, 2*len(a) - 2)) == a" }, { "__type": "Text", "__tag": 4046, "value": ", within roundoff error," } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "odd: " }, { "__type": "InlineCode", "__tag": 4051, "value": "ihfft(hfft(a, 2*len(a) - 1)) == a" }, { "__type": "Text", "__tag": 4046, "value": ", within roundoff error." } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The correct interpretation of the hermitian input depends on the length of the original data, as given by " }, { "__type": "ParamRef", "__tag": 4071, "name": "n" }, { "__type": "Text", "__tag": 4046, "value": ". This is because each input shape could correspond to either an odd or even length signal. By default, " }, { "__type": "CrossRef", "__tag": 4002, "value": "hfft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:hfft" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " assumes an even output length which puts the last entry at the Nyquist frequency; aliasing with its symmetric counterpart. By Hermitian symmetry, the value is thus treated as purely real. To avoid losing information, the shape of the full signal " }, { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "must" } ] }, { "__type": "Text", "__tag": 4046, "value": " be given." } ] } ], "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": "IndexError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "axis" }, { "__type": "Text", "__tag": 4046, "value": " is not a valid axis 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": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The truncated or zero-padded input, transformed along the axis indicated by " }, { "__type": "ParamRef", "__tag": 4071, "name": "axis" }, { "__type": "Text", "__tag": 4046, "value": ", or the last one if " }, { "__type": "ParamRef", "__tag": 4071, "name": "axis" }, { "__type": "Text", "__tag": 4046, "value": " is not specified. The length of the transformed axis is " }, { "__type": "ParamRef", "__tag": 4071, "name": "n" }, { "__type": "Text", "__tag": 4046, "value": ", or, if " }, { "__type": "ParamRef", "__tag": 4071, "name": "n" }, { "__type": "Text", "__tag": 4046, "value": " is not given, " }, { "__type": "InlineCode", "__tag": 4051, "value": "2*m - 2" }, { "__type": "Text", "__tag": 4046, "value": " where " }, { "__type": "InlineCode", "__tag": 4051, "value": "m" }, { "__type": "Text", "__tag": 4046, "value": " is the length of the transformed axis of the input. To get an odd number of output points, " }, { "__type": "ParamRef", "__tag": 4071, "name": "n" }, { "__type": "Text", "__tag": 4046, "value": " must be specified, for instance as " }, { "__type": "InlineCode", "__tag": 4051, "value": "2*m - 1" }, { "__type": "Text", "__tag": 4046, "value": " in the typical case," } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Compute the FFT of a signal that has Hermitian symmetry, i.e., 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": "a", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The input array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "n", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Length of the transformed axis of the output. For " }, { "__type": "ParamRef", "__tag": 4071, "name": "n" }, { "__type": "Text", "__tag": 4046, "value": " output points, " }, { "__type": "InlineCode", "__tag": 4051, "value": "n//2 + 1" }, { "__type": "Text", "__tag": 4046, "value": " input points are necessary. If the input is longer than this, it is cropped. If it is shorter than this, it is padded with zeros. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "n" }, { "__type": "Text", "__tag": 4046, "value": " is not given, it 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 the axis specified by " }, { "__type": "ParamRef", "__tag": 4071, "name": "axis" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "axis", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Axis over which to compute the FFT. If not given, the last axis is used." } ] } ] }, { "__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": "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." } ] }, { "__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": [], "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": 529, "item_type": "_ArrayFunctionDispatcher", "aliases": [ "numpy.fft.hfft" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nsignal = np.array([1, 2, 3, 4, 3, 2])\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.fft.fft(signal)\nnp.fft.hfft(signal[:4]) # Input first half of signal\nnp.fft.hfft(signal, 6) # Input entire signal and truncate\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "signal = np.array([[1, 1.j], [-1.j, 2]])\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.conj(signal.T) - signal # check Hermitian symmetry\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "freq_spectrum = np.fft.hfft(signal)\nfreq_spectrum\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "ihfft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:ihfft" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The inverse of " }, { "__type": "InlineRole", "__tag": 4003, "value": "hfft", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "rfft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.fft:rfft" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Compute the one-dimensional FFT for real input." } ] } ], "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": "n", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "axis", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "-1" }, { "__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": "hfft" }, "references": null, "qa": "numpy.fft:hfft", "arbitrary": [], "local_refs": [ "a", "axis", "n", "norm", "out" ] }