@@ -1315,23 +1315,22 @@ def firwin_2d(hsize, window, *, fc=None, fs=2, circular=False, pass_zero=True, s
1315
1315
The sampling frequency of the signal. Default is 2.
1316
1316
circular : bool, optional
1317
1317
Whether to create a circularly symmetric 2-D window. Default is False.
1318
- pass_zero : {True, False, 'bandpass', 'lowpass', 'highpass', 'bandstop'}, optional
1319
- If True, the gain at the frequency 0 (i.e., the "DC gain") is 1.
1320
- If False, the DC gain is 0. Can also be a string argument for the
1321
- desired filter type (equivalent to ``btype`` in IIR design functions).
1322
-
1323
- .. versionadded:: 1.3.0
1324
- Support for string arguments.
1318
+ pass_zero : This parameter is passed to the `firwin` function for each scalar frequency axis.
1319
+ Hence, if ``True``, the DC gain, i.e., the gain at frequency (0, 0), is 1.
1320
+ If ``False``, the DC gain is 0 at frequency (0, 0) if `circular` is ``True``.
1321
+ If `circular` is ``False`` the frequencies (0, f1) and (f0, 0) will have gain 0.
1322
+ It can also be a string argument for the desired filter type
1323
+ (equivalent to ``btype`` in IIR design functions).
1325
1324
scale : bool, optional
1326
- Set to True to scale the coefficients so that the frequency
1327
- response is exactly unity at a certain frequency.
1325
+ This parameter is passed to the `firwin` function for each scalar frequency axis.
1326
+ Set to ``True`` to scale the coefficients so that the frequency
1327
+ response is exactly unity at a certain frequency on one frequency axis.
1328
1328
That frequency is either:
1329
-
1330
- - 0 (DC) if the first passband starts at 0 (i.e. pass_zero
1331
- is True)
1329
+
1330
+ - 0 (DC) if the first passband starts at 0 (i.e. pass_zero is ``True``)
1332
1331
- `fs/2` (the Nyquist frequency) if the first passband ends at
1333
- `fs/2` (i.e the filter is a single band highpass filter);
1334
- center of first passband otherwise
1332
+ `fs/2` (i.e the filter is a single band highpass filter);
1333
+ center of first passband otherwise
1335
1334
1336
1335
Returns
1337
1336
-------
0 commit comments