Update filter docs

audiomentations/augmentations/band_pass_filter.py

@@ -31,10 +31,10 @@ def __init__(
         :param max_rolloff: Maximum filter roll-off (in dB/octave)
             Must be a multiple of 6
         :param zero_phase: Whether filtering should be zero phase.
-            When this is set to `True` it will not affect the phase of the
+            When this is set to `True`, it will not affect the phase of the
             input signal but will sound 3 dB lower at the cutoff frequency
             compared to the non-zero phase case (6 dB vs 3 dB). Additionally,
-            it is 2 times slower than in the non-zero phase case. If you
+            it is twice as slow as the non-zero phase case. If you
             absolutely want no phase distortions (e.g. want to augment an
             audio file with lots of transients, like a drum track), set
             this to `True`.

audiomentations/augmentations/band_stop_filter.py

@@ -36,12 +36,12 @@ def __init__(
         :param max_rolloff: Maximum filter roll-off (in dB/octave)
             Must be a multiple of 6
         :param zero_phase: Whether filtering should be zero phase.
-            When this is set to `true` it will not affect the phase of the
+            When this is set to `True`, it will not affect the phase of the
             input signal but will sound 3 dB lower at the cutoff frequency
             compared to the non-zero phase case (6 dB vs 3 dB). Additionally,
-            it is 2 times slower than in the non-zero phase case. If you
+            it is twice as slow as the non-zero phase case. If you
             absolutely want no phase distortions (e.g. want to augment a
-            drum track), set this to `true`.
+            drum track), set this to `True`.
         :param p: The probability of applying this transform
         """
         super().__init__(

audiomentations/augmentations/high_pass_filter.py

@@ -26,12 +26,12 @@ def __init__(
         :param max_rolloff: Maximum filter roll-off (in dB/octave)
             Must be a multiple of 6
         :param zero_phase: Whether filtering should be zero phase.
-            When this is set to `true` it will not affect the phase of the
+            When this is set to `True`, it will not affect the phase of the
             input signal but will sound 3 dB lower at the cutoff frequency
             compared to the non-zero phase case (6 dB vs. 3 dB). Additionally,
-            it is 2 times slower than in the non-zero phase case. If you
+            it is twice as slow as the non-zero phase case. If you
             absolutely want no phase distortions (e.g. want to augment a
-            drum track), set this to `true`.
+            drum track), set this to `True`.
         :param p: The probability of applying this transform
         """
         super().__init__(

audiomentations/augmentations/low_pass_filter.py

@@ -26,12 +26,12 @@ def __init__(
         :param max_rolloff: Maximum filter roll-off (in dB/octave)
             Must be a multiple of 6
         :param zero_phase: Whether filtering should be zero phase.
-            When this is set to `true` it will not affect the phase of the
+            When this is set to `True`, it will not affect the phase of the
             input signal but will sound 3 dB lower at the cutoff frequency
             compared to the non-zero phase case (6 dB vs. 3 dB). Additionally,
-            it is 2 times slower than in the non-zero phase case. If you
+            it is twice as slow as the non-zero phase case. If you
             absolutely want no phase distortions (e.g. want to augment a
-            drum track), set this to `true`.
+            drum track), set this to `True`.
         :param p: The probability of applying this transform
         """
         super().__init__(

docs/waveform_transforms/band_pass_filter.md

@@ -46,19 +46,19 @@ augmented_sound = transform(my_waveform_ndarray, sample_rate=48000)
 [`max_bandwidth_fraction`](#max_bandwidth_fraction){ #max_bandwidth_fraction }: `float` • range: [0.0, 2.0]
 :   :octicons-milestone-24: Default: `1.99`. Maximum bandwidth relative to center frequency
 
-[`min_rolloff`](#min_rolloff){ #min_rolloff }: `float` • unit: Decibels/octave
+[`min_rolloff`](#min_rolloff){ #min_rolloff }: `int` • unit: Decibels/octave
 :   :octicons-milestone-24: Default: `12`. Minimum filter roll-off (in dB/octave).
-    Must be a multiple of 6
+    Must be a multiple of 6 (or 12 if `zero_phase` is `True`)
 
-[`max_rolloff`](#max_rolloff){ #max_rolloff }: `float` • unit: Decibels/octave
+[`max_rolloff`](#max_rolloff){ #max_rolloff }: `int` • unit: Decibels/octave
 :   :octicons-milestone-24: Default: `24`. Maximum filter roll-off (in dB/octave)
-    Must be a multiple of 6
+    Must be a multiple of 6 (or 12 if `zero_phase` is `True`)
 
 [`zero_phase`](#zero_phase){ #zero_phase }: `bool`
 :   :octicons-milestone-24: Default: `False`. Whether filtering should be zero phase.
-    When this is set to `True` it will not affect the phase of the input signal but will
+    When this is set to `True`, it will not affect the phase of the input signal but will
     sound 3 dB lower at the cutoff frequency compared to the non-zero phase case (6 dB
-    vs. 3 dB). Additionally, it is 2 times slower than in the non-zero phase case. If
+    vs. 3 dB). Additionally, it is twice as slow as the non-zero phase case. If
     you absolutely want no phase distortions (e.g. want to augment an audio file with
     lots of transients, like a drum track), set this to `True`.
 

docs/waveform_transforms/band_stop_filter.md

@@ -36,24 +36,24 @@ can hear that the timbre is different in the transformed sound than in the origi
 :   :octicons-milestone-24: Default: `4000.0`. Maximum center frequency in hertz
 
 [`min_bandwidth_fraction`](#min_bandwidth_fraction){ #min_bandwidth_fraction }: `float`
-:   :octicons-milestone-24: Default: `0.5`. Minimum bandwidth relative to center frequency
+:   :octicons-milestone-24: Default: `0.5`. Minimum bandwidth fraction relative to center frequency
 
 [`max_bandwidth_fraction`](#max_bandwidth_fraction){ #max_bandwidth_fraction }: `float`
-:   :octicons-milestone-24: Default: `1.99`. Maximum bandwidth relative to center frequency
+:   :octicons-milestone-24: Default: `1.99`. Maximum bandwidth fraction relative to center frequency
 
-[`min_rolloff`](#min_rolloff){ #min_rolloff }: `float` • unit: Decibels/octave
+[`min_rolloff`](#min_rolloff){ #min_rolloff }: `int` • unit: Decibels/octave
 :   :octicons-milestone-24: Default: `12`. Minimum filter roll-off (in dB/octave).
-    Must be a multiple of 6
+    Must be a multiple of 6 (or 12 if `zero_phase` is `True`)
 
-[`max_rolloff`](#max_rolloff){ #max_rolloff }: `float` • unit: Decibels/octave
+[`max_rolloff`](#max_rolloff){ #max_rolloff }: `int` • unit: Decibels/octave
 :   :octicons-milestone-24: Default: `24`. Maximum filter roll-off (in dB/octave)
-    Must be a multiple of 6
+    Must be a multiple of 6 (or 12 if `zero_phase` is `True`)
 
 [`zero_phase`](#zero_phase){ #zero_phase }: `bool`
 :   :octicons-milestone-24: Default: `False`. Whether filtering should be zero phase.
-    When this is set to `True` it will not affect the phase of the input signal but will
+    When this is set to `True`, it will not affect the phase of the input signal but will
     sound 3 dB lower at the cutoff frequency compared to the non-zero phase case (6 dB
-    vs. 3 dB). Additionally, it is 2 times slower than in the non-zero phase case. If
+    vs. 3 dB). Additionally, it is twice as slow as the non-zero phase case. If
     you absolutely want no phase distortions (e.g. want to augment an audio file with
     lots of transients, like a drum track), set this to `True`.
 

docs/waveform_transforms/high_pass_filter.md

@@ -15,17 +15,17 @@ Can also be set for zero-phase filtering (will result in a 6 dB drop at cutoff).
 
 [`min_rolloff`](#min_rolloff){ #min_rolloff }: `float` • unit: Decibels/octave
 :   :octicons-milestone-24: Default: `12`. Minimum filter roll-off (in dB/octave).
-    Must be a multiple of 6
+    Must be a multiple of 6 (or 12 if `zero_phase` is `True`)
 
 [`max_rolloff`](#max_rolloff){ #max_rolloff }: `float` • unit: Decibels/octave
 :   :octicons-milestone-24: Default: `24`. Maximum filter roll-off (in dB/octave).
-    Must be a multiple of 6
+    Must be a multiple of 6 (or 12 if `zero_phase` is `True`)
 
 [`zero_phase`](#zero_phase){ #zero_phase }: `bool`
 :   :octicons-milestone-24: Default: `False`. Whether filtering should be zero phase.
-    When this is set to `True` it will not affect the phase of the input signal but will
+    When this is set to `True`, it will not affect the phase of the input signal but will
     sound 3 dB lower at the cutoff frequency compared to the non-zero phase case (6 dB
-    vs. 3 dB). Additionally, it is 2 times slower than in the non-zero phase case. If
+    vs. 3 dB). Additionally, it is twice as slow as the non-zero phase case. If
     you absolutely want no phase distortions (e.g. want to augment an audio file with
     lots of transients, like a drum track), set this to `True`.
 

docs/waveform_transforms/low_pass_filter.md

@@ -13,19 +13,19 @@ Can also be set for zero-phase filtering (will result in a 6 dB drop at cutoff).
 [`max_cutoff_freq`](#max_cutoff_freq){ #max_cutoff_freq }: `float` • unit: hertz
 :   :octicons-milestone-24: Default: `7500.0`. Maximum cutoff frequency
 
-[`min_rolloff`](#min_rolloff){ #min_rolloff }: `float` • unit: Decibels/octave
+[`min_rolloff`](#min_rolloff){ #min_rolloff }: `int` • unit: Decibels/octave
 :   :octicons-milestone-24: Default: `12`. Minimum filter roll-off (in dB/octave).
-    Must be a multiple of 6
+    Must be a multiple of 6 (or 12 if `zero_phase` is `True`)
 
-[`max_rolloff`](#max_rolloff){ #max_rolloff }: `float` • unit: Decibels/octave
+[`max_rolloff`](#max_rolloff){ #max_rolloff }: `int` • unit: Decibels/octave
 :   :octicons-milestone-24: Default: `24`. Maximum filter roll-off (in dB/octave)
-    Must be a multiple of 6
+    Must be a multiple of 6 (or 12 if `zero_phase` is `True`)
 
 [`zero_phase`](#zero_phase){ #zero_phase }: `bool`
 :   :octicons-milestone-24: Default: `False`. Whether filtering should be zero phase.
-    When this is set to `True` it will not affect the phase of the input signal but will
+    When this is set to `True`, it will not affect the phase of the input signal but will
     sound 3 dB lower at the cutoff frequency compared to the non-zero phase case (6 dB
-    vs. 3 dB). Additionally, it is 2 times slower than in the non-zero phase case. If
+    vs. 3 dB). Additionally, it is twice as slow as the non-zero phase case. If
     you absolutely want no phase distortions (e.g. want to augment an audio file with
     lots of transients, like a drum track), set this to `True`.