Skip to content

Add documentation for imshow_norm and imshow_alpha #227

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

Open
kbarnhart wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Add documentation for imshow_norm and imshow_alpha #227

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc6b66b
add documentation for imshow_norm and imshow_alpha
kbarnhart Nov 14, 2023
c5c775f
add notes about adding colorbar_tick_labels and colorbar_ticks.
kbarnhart Jan 9, 2024
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
17 changes: 17 additions & 0 deletions doc/ClawPlotItem.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,23 @@ Special attributes for plot_type = '2d_imshow'
frame to frame. Also, if AMR is used, they may vary from patch to patch,
yielding very confusing plots.

.. attribute:: imshow_norm : matplotlib color norm

As an alternative to setting *imshow_cmin* and *imshow_cmax*, provide
a `matplotlib color norm
<https://matplotlib.org/stable/api/colors_api.html#color-norms>`_
to *imshow_norm*. This will be used to normalize the values of q into the
colorspace specified by the colormap. If *imshow_norm* is provided, it
will be used instead of *imshow_cmin* and *imshow_cmax*.

It may be advantageous to also specify *plotitem.colorbar_ticks* and
*plotitem.colorbar_tick_labels* to enforce drawing of colorbar ticks
when using *imshow_norm*.

.. attribute:: imshow_alpha : float

The transparency value (between 0 [transparent] and 1 [opaque]).

.. attribute:: add_colorbar : bool

If True, a colorbar is added to the plot.
Expand Down