Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

New data → color pipeline#28658

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.

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

Already on GitHub?Sign in to your account

Merged
tacaswell merged 18 commits intomatplotlib:mainfromtrygvrad:Colorizer-class
Oct 24, 2024
Merged
Show file tree
Hide file tree
Changes from1 commit
Commits
Show all changes
18 commits
Select commitHold shift + click to select a range
1e52ba8
Colorizer class
trygvradAug 2, 2024
9e5620d
Creation of colorizer.py
trygvradAug 6, 2024
b3f5260
updated ColorizingArtist.__init__
trygvradAug 7, 2024
edbe127
simplify to_rgba() by extracting the part relating to RGBA data
trygvradAug 9, 2024
fc9973e
updated class hierarchy for Colorizer
trygvradAug 13, 2024
596daec
colorizer keyword on plotting functions with typing
trygvradAug 13, 2024
21a5a64
changes to keyword parameter ordering
trygvradAug 16, 2024
5755d1b
adjustments based on code review
trygvradAug 21, 2024
a6fe9e8
MNT: adjust inheritance so isinstance(..., cm.ScalarMappable) works
tacaswellAug 21, 2024
dbe8cc3
updated docs with colorizer changes
trygvradAug 21, 2024
9ac2739
updates to colorizer pipeline based on feedback from @QuLogic
trygvradAug 27, 2024
7dd31ad
DOC: fix unrelated xref issues
tacaswellAug 29, 2024
1ecfe95
DOC: add multivariate colormaps to the docs
tacaswellAug 29, 2024
c685f36
DOC: fix colorizer related xrefs
tacaswellAug 29, 2024
676a31f
DOC: auto-generate ScalarMappable in conf.py
tacaswellAug 29, 2024
c3cad60
Corrections based on feedback from @QuLogic
trygvradSep 6, 2024
269ace9
MNT: Touch up rebase to use 'register' for docstring interpolations
ksundenOct 11, 2024
336a9ba
fix missing refererence linenos
ksundenOct 23, 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
PrevPrevious commit
NextNext commit
DOC: auto-generate ScalarMappable in conf.py
This is a hack, but not the _worst_ hack.
  • Loading branch information
@tacaswell@ksunden
tacaswell authored andksunden committedOct 18, 2024
commit676a31fb8a66f7b15b0ff81490d87d20cf9b570a
1 change: 1 addition & 0 deletionsdoc/api/.gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
scalarmappable.gen_rst
51 changes: 1 addition & 50 deletionsdoc/api/cm_api.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,53 +7,4 @@
:undoc-members:
:show-inheritance:


.. class:: ScalarMappable(colorizer, **kwargs)
:canonical: matplotlib.colorizer._ScalarMappable

.. attribute:: colorbar
.. method:: changed

Call this whenever the mappable is changed to notify all the
callbackSM listeners to the 'changed' signal.

.. method:: set_array(A)

Set the value array from array-like *A*.


:Parameters:

**A** : array-like or None
The values that are mapped to colors.

The base class `.ScalarMappable` does not make any assumptions on
the dimensionality and shape of the value array *A*.



.. method:: set_cmap(A)

Set the colormap for luminance data.


:Parameters:

**cmap** : `.Colormap` or str or None
..


.. method:: set_clim(vmin=None, vmax=None)

Set the norm limits for image scaling.


:Parameters:

**vmin, vmax** : float
The limits.

For scalar data, the limits may also be passed as a
tuple (*vmin*, *vmax*) as a single positional argument.

.. ACCEPTS: (vmin: float, vmax: float)
.. include:: scalarmappable.gen_rst
54 changes: 53 additions & 1 deletiondoc/conf.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,7 +29,6 @@

import matplotlib


# debug that building expected version
print(f"Building Documentation for Matplotlib: {matplotlib.__version__}")

Expand DownExpand Up@@ -852,6 +851,58 @@ def linkcode_resolve(domain, info):
extensions.append('sphinx.ext.viewcode')


def generate_ScalarMappable_docs():

import matplotlib.colorizer
from numpydoc.docscrape_sphinx import get_doc_object
from pathlib import Path
import textwrap
from sphinx.util.inspect import stringify_signature
target_file = Path(__file__).parent / 'api' / 'scalarmappable.gen_rst'
with open(target_file, 'w') as fout:
fout.write("""
.. class:: ScalarMappable(colorizer, **kwargs)
:canonical: matplotlib.colorizer._ScalarMappable

""")
for meth in [
matplotlib.colorizer._ScalarMappable.autoscale,
matplotlib.colorizer._ScalarMappable.autoscale_None,
matplotlib.colorizer._ScalarMappable.changed,
"""
.. attribute:: colorbar

The last colorbar associated with this ScalarMappable. May be None.
""",
matplotlib.colorizer._ScalarMappable.get_alpha,
matplotlib.colorizer._ScalarMappable.get_array,
matplotlib.colorizer._ScalarMappable.get_clim,
matplotlib.colorizer._ScalarMappable.get_cmap,
"""
.. property:: norm
""",
matplotlib.colorizer._ScalarMappable.set_array,
matplotlib.colorizer._ScalarMappable.set_clim,
matplotlib.colorizer._ScalarMappable.set_cmap,
matplotlib.colorizer._ScalarMappable.set_norm,
matplotlib.colorizer._ScalarMappable.to_rgba,
]:
if isinstance(meth, str):
fout.write(meth)
else:
name = meth.__name__
sig = stringify_signature(inspect.signature(meth))
docstring = textwrap.indent(
str(get_doc_object(meth)),
' '
).rstrip()
fout.write(f"""
.. method:: {name}{sig}
{docstring}

""")


# -----------------------------------------------------------------------------
# Sphinx setup
# -----------------------------------------------------------------------------
Expand All@@ -865,3 +916,4 @@ def setup(app):
app.connect('autodoc-process-bases', autodoc_process_bases)
if sphinx.version_info[:2] < (7, 1):
app.connect('html-page-context', add_html_cache_busting, priority=1000)
generate_ScalarMappable_docs()
[8]ページ先頭
©2009-2025 Movatter.jp