Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extended noise doc #124

Merged
merged 1 commit into from
Apr 23, 2024
Merged

Extended noise doc #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion stimupy/noises/binaries.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------
Expand Down
3 changes: 2 additions & 1 deletion stimupy/noises/narrowbands.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
7 changes: 5 additions & 2 deletions stimupy/noises/naturals.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion stimupy/noises/whites.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading