From fdf320117e414ab934951219811eeaf725efc1c7 Mon Sep 17 00:00:00 2001 From: lynnschmittwilken Date: Tue, 23 Apr 2024 12:29:46 +0200 Subject: [PATCH] doc: extended noise doc on intensity range --- stimupy/noises/binaries.py | 3 ++- stimupy/noises/narrowbands.py | 3 ++- stimupy/noises/naturals.py | 7 +++++-- stimupy/noises/whites.py | 3 ++- 4 files changed, 11 insertions(+), 5 deletions(-) diff --git a/stimupy/noises/binaries.py b/stimupy/noises/binaries.py index 0ad10cc..7006ea1 100644 --- a/stimupy/noises/binaries.py +++ b/stimupy/noises/binaries.py @@ -25,7 +25,8 @@ def binary( shape : Sequence[Number, Number], Number, or None (default) shape [height, width] of grating, in pixels intensity_range : Sequence[Number, Number] - minimum and maximum intensity value; default: (0, 1) + minimum and maximum intensity value; default: (0, 1). + be aware that not every instance has mean=(max-min)/2. Returns ------- diff --git a/stimupy/noises/narrowbands.py b/stimupy/noises/narrowbands.py index 9921f08..5c7c125 100644 --- a/stimupy/noises/narrowbands.py +++ b/stimupy/noises/narrowbands.py @@ -33,7 +33,8 @@ def narrowband( bandwidth : float bandwidth of the noise in octaves intensity_range : Sequence[Number, Number] - minimum and maximum intensity value; default: (0, 1) + minimum and maximum intensity value; default: (0, 1). + be aware that not every instance has mean=(max-min)/2. pseudo_noise : bool if True, generate pseudo-random noise with ideal power spectrum. diff --git a/stimupy/noises/naturals.py b/stimupy/noises/naturals.py index bff07c1..d43fe69 100644 --- a/stimupy/noises/naturals.py +++ b/stimupy/noises/naturals.py @@ -32,7 +32,8 @@ def one_over_f( exponent exponent used to create 1 / (f**exponent) noise intensity_range : Sequence[Number, Number] - minimum and maximum intensity value; default: (0, 1) + minimum and maximum intensity value; default: (0, 1). + be aware that not every instance has mean=(max-min)/2. pseudo_noise : bool if True, generate pseudo-random noise with ideal power spectrum. @@ -109,7 +110,8 @@ def pink( shape : Sequence[Number, Number], Number, or None (default) shape [height, width] of grating, in pixels intensity_range : Sequence[Number, Number] - minimum and maximum intensity value; default: (0, 1) + minimum and maximum intensity value; default: (0, 1). + be aware that not every instance has mean=(max-min)/2. pseudo_noise : bool if True, generate pseudo-random noise with ideal power spectrum @@ -147,6 +149,7 @@ def brown( shape [height, width] of grating, in pixels intensity_range : Sequence[Number, Number] minimum and maximum intensity value; default: (0, 1) + be aware that not every instance has mean=(max-min)/2. pseudo_noise : bool if True, generate pseudo-random noise with ideal power spectrum diff --git a/stimupy/noises/whites.py b/stimupy/noises/whites.py index 8412086..cb54297 100644 --- a/stimupy/noises/whites.py +++ b/stimupy/noises/whites.py @@ -27,7 +27,8 @@ def white( shape : Sequence[Number, Number], Number, or None (default) shape [height, width] of grating, in pixels intensity_range : Sequence[Number, Number] - minimum and maximum intensity value; default: (0, 1) + minimum and maximum intensity value; default: (0, 1). + be aware that not every instance has mean=(max-min)/2. pseudo_noise : bool if True, generate pseudo-random noise with ideal power spectrum