Skip to content
Snippets Groups Projects

docstring changes

Merged David Schäfer requested to merge docs into develop
Files
2
+ 5
5
@@ -36,11 +36,11 @@ class NoiseMixin:
**kwargs,
) -> "SaQC":
"""
Flag data chunks of length, ``window``, if:
Flag data chunks of length ``window``, if:
1. they excexceed ``thresh`` with regard to ``func``and
1. they excexceed ``thresh`` with regard to ``func`` and
2. all (maybe overlapping) sub-chunks of the data chunks with length ``sub_window``,
`excexceed ``sub_thresh`` with regard to ``func``
exceed ``sub_thresh`` with regard to ``func``
Parameters
----------
@@ -54,11 +54,11 @@ class NoiseMixin:
Window (i.e. chunk) size.
thresh: float
Threshold. A given chunk is flagged, if the return value of ``func` excceeds ``thresh``.
Threshold. A given chunk is flagged, if the return value of ``func`` excceeds ``thresh``.
sub_window: str, default None,
Window size of sub chunks, that are additionally tested for exceeding ``sub_thresh``
with respect to `func`.
with respect to ``func``.
sub_thresh: float, default None
Threshold. A given sub chunk is flagged, if the return value of ``func` excceeds ``sub_thresh``.
Loading