{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This window optimizes for the narrowest main lobe width for a given order " }, { "__type": "ParamRef", "__tag": 4071, "name": "M" }, { "__type": "Text", "__tag": 4046, "value": " and sidelobe equiripple attenuation " }, { "__type": "ParamRef", "__tag": 4071, "name": "at" }, { "__type": "Text", "__tag": 4046, "value": ", using Chebyshev polynomials. It was originally developed by Dolph to optimize the directionality of radio antenna arrays." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Unlike most windows, the Dolph-Chebyshev is defined in terms of its frequency response:" } ] }, { "__type": "Math", "__tag": 4058, "value": "W(k) = \\frac{\\cos\\{M \\cos^{-1}[\\beta \\cos(\\frac{\\pi k}{M})]\\}}\n{\\cosh[M \\cosh^{-1}(\\beta)]}" }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "where" } ] }, { "__type": "Math", "__tag": 4058, "value": "\\beta = \\cosh \\left [\\frac{1}{M}\\cosh^{-1}(10^\\frac{A}{20}) \\right ]" }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "and 0 <= abs(k) <= M-1. A is the attenuation in decibels (" }, { "__type": "ParamRef", "__tag": 4071, "name": "at" }, { "__type": "Text", "__tag": 4046, "value": ")." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The time domain window is then generated using the IFFT, so power-of-two " }, { "__type": "ParamRef", "__tag": 4071, "name": "M" }, { "__type": "Text", "__tag": 4046, "value": " are the fastest to generate, and prime number " }, { "__type": "ParamRef", "__tag": 4071, "name": "M" }, { "__type": "Text", "__tag": 4046, "value": " are the slowest." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The equiripple condition in the frequency domain creates impulses in the time domain, which appear at the ends of the window." } ] }, { "__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": "chebwin", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal.windows._windows:chebwin" }, "kind": "module" }, { "__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 ⛔ 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": [], "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": "w", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The window, with the maximum value always normalized to 1" } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Return a Dolph-Chebyshev window." } ] } ], "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": "M", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of points in the output window. If zero, an empty array is returned. An exception is thrown when it is negative." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "at", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Attenuation (in dB)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "sym", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When True (default), generates a symmetric window, for use in filter design. When False, generates a periodic window, for use in spectral analysis." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "xp", "annotation": "array_namespace, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Optional array namespace. Should be compatible with the array API standard, or supported by array-api-compat. Default: " }, { "__type": "InlineCode", "__tag": 4051, "value": "numpy" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "device: any", "annotation": "", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "optional device specification for output. Should match one of the supported device specification in " }, { "__type": "InlineCode", "__tag": 4051, "value": "xp" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "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": "/scipy/signal/windows/_windows.py", "item_line": 1559, "item_type": "function", "aliases": [ "scipy.signal.windows.chebwin" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "Plot the window and its frequency response:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy import signal\nfrom scipy.fft import fft, fftshift\nimport matplotlib.pyplot as plt\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "window = signal.windows.chebwin(51, at=100)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "plt.plot(window)\nplt.title(\"Dolph-Chebyshev window (100 dB)\")\nplt.ylabel(\"Amplitude\")\nplt.xlabel(\"Sample\")\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "plt.figure()\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "A = fft(window, 2048) / (len(window)/2.0)\nfreq = np.linspace(-0.5, 0.5, len(A))\nresponse = 20 * np.log10(np.abs(fftshift(A / abs(A).max())))\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "plt.plot(freq, response)\nplt.axis([-0.5, 0.5, -120, 0])\nplt.title(\"Frequency response of the Dolph-Chebyshev window (100 dB)\")\nplt.ylabel(\"Normalized magnitude [dB]\")\nplt.xlabel(\"Normalized frequency [cycles per sample]\")\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "M", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "at", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "sym", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "xp", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "device", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "chebwin" }, "references": [ ".. [1] C. Dolph, \"A current distribution for broadside arrays which", " optimizes the relationship between beam width and side-lobe level\",", " Proceedings of the IEEE, Vol. 34, Issue 6", ".. [2] Peter Lynch, \"The Dolph-Chebyshev Window: A Simple Optimal Filter\",", " American Meteorological Society (April 1997)", " http://mathsci.ucd.ie/~plynch/Publications/Dolph.pdf", ".. [3] F. J. Harris, \"On the use of windows for harmonic analysis with the", " discrete Fourier transforms\", Proceedings of the IEEE, Vol. 66,", " No. 1, January 1978" ], "qa": "scipy.signal.windows._windows:chebwin", "arbitrary": [], "local_refs": [ "M", "at", "device: any", "sym", "w", "xp" ] }