Skip to content

Commit 4539d18

Browse files
committed
🚸 Add id for motion_estimate_filter_valid_options
1 parent a0cfa9d commit 4539d18

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/_sources/user/func.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Initial Preprocessing
2929
#. **filter_bandwidth - [float]:** Notch filter only. Manually select the bandwidth for the notch filter. Mutually exclusive with `breathing_rate_min` and `breathing_rate_max`. Use this to manually design the filter.
3030
#. **lowpass_cutoff - [float]:** Lowpass filter only. Manually select the cutoff frequency for the lowpass filter. Mutually exclusive with `breathing_rate_min` and `breathing_rate_max`. Use this to manually design the filter.
3131

32+
3233
.. _func_init_without_gui:
3334

3435
Configuration Without the GUI
@@ -39,6 +40,9 @@ The following nested key/value pairs that will be set to these defaults if not d
3940
:language: YAML
4041
:lines: 602-619,815-847,855-936
4142

43+
44+
.. _motion_estimate_filter_valid_options:
45+
4246
For ``motion_estimate_filter``, if ``breathing_rate_min`` and ``breathing_rate_max`` are provided, the filter design attributes (``center_frequency``, ``filter_bandwidth``, ``lowpass_cutoff``) are automatically configured. But if you provide these directly, you don't need the breathing rates. If all all parameters are provided, the filter design attributes will be ignored in favor of the ``breathing_rate_*`` attributes. A configuration must match at least one row in the following table:
4347

4448
======= =============== ====================== ====================== ==================== ==================== ==================

0 commit comments

Comments
 (0)