Skip to content

Colorbar kwargs default #195

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

Merged
fs446 merged 2 commits into from
Sep 24, 2025
Merged

Colorbar kwargs default #195

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d519b2
add colorbar label defaults if these kwargs are not submitted to leve…
fs446 Sep 16, 2025
fd2e03f
use handling from PR191
fs446 Sep 16, 2025
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
11 changes: 8 additions & 3 deletions sfs/plot2d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ def _plotting_plane(p, grid):

def amplitude(p, grid, *, xnorm=None, cmap='coolwarm_clip',
vmin=-2.0, vmax=2.0, xlabel=None, ylabel=None,
colorbar=True, colorbar_kwargs={}, ax=None, **kwargs):
colorbar=True, colorbar_kwargs=None, ax=None, **kwargs):
"""Two-dimensional plot of sound field (real part).

Parameters
Expand Down Expand Up @@ -319,12 +319,14 @@ def amplitude(p, grid, *, xnorm=None, cmap='coolwarm_clip',
ax.set_xlabel(xlabel)
ax.set_ylabel(ylabel)
if colorbar:
if colorbar_kwargs is None:
colorbar_kwargs = dict(extend='both')
add_colorbar(im, **colorbar_kwargs)
return im


def level(p, grid, *, xnorm=None, power=False, cmap=None, vmax=3, vmin=-50,
**kwargs):
colorbar_kwargs=None, **kwargs):
"""Two-dimensional plot of level (dB) of sound field.

Takes the same parameters as `sfs.plot2d.amplitude()`.
Expand All @@ -339,8 +341,11 @@ def level(p, grid, *, xnorm=None, power=False, cmap=None, vmax=3, vmin=-50,
if xnorm is not None:
p = _util.normalize(p, grid, xnorm)
L = _util.db(p, power=power)
if colorbar_kwargs is None:
colorbar_kwargs = dict(extend='both', label='level / dB')
return amplitude(L, grid=grid, xnorm=None, cmap=cmap,
vmax=vmax, vmin=vmin, **kwargs)
vmax=vmax, vmin=vmin,
colorbar_kwargs=colorbar_kwargs, **kwargs)


def level_contour(p, grid, *, xnorm=None, power=False,
Expand Down
Loading