Skip to content

Commit

Permalink
Tweak wording in AddColorNoise docs
Browse files Browse the repository at this point in the history
  • Loading branch information
iver56 committed Mar 6, 2024
1 parent b7f5ecf commit ad84b37
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
2 changes: 1 addition & 1 deletion audiomentations/augmentations/add_color_noise.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ def generate_decaying_white_noise(
class AddColorNoise(BaseWaveformTransform):
"""
Adds noise to the input samples with a decaying frequency spectrum resulting in "color" noise.
For more see the Wikipedia article here: https://en.wikipedia.org/wiki/Colors_of_noise
For info, more see the Wikipedia article here: https://en.wikipedia.org/wiki/Colors_of_noise
"""

supports_multichannel = True
Expand Down
5 changes: 2 additions & 3 deletions docs/waveform_transforms/add_color_noise.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@

_To be added in v0.35.0_

Mix in noise with color, additionally weighted by an [A-weighting :octicons-link-external-16:](https://en.wikipedia.org/wiki/A-weighting){target=_blank} curve. When
`f_decay=0` this is equivalent to `AddGaussianNoise`, with an option for weighting it
with an `A-weighting` curve. Otherwise, see: [Colors of Noise :octicons-link-external-16:](https://en.wikipedia.org/wiki/Colors_of_noise){target=_blank}.
Mix in noise with color, optionally weighted by an [A-weighting :octicons-link-external-16:](https://en.wikipedia.org/wiki/A-weighting){target=_blank} curve. When
`f_decay=0`, this is equivalent to `AddGaussianNoise`. Otherwise, see: [Colors of Noise :octicons-link-external-16:](https://en.wikipedia.org/wiki/Colors_of_noise){target=_blank}.


## AddColorNoise API
Expand Down

0 comments on commit ad84b37

Please sign in to comment.