Skip to content

Commit

Permalink
Document contour colormap norms
Browse files Browse the repository at this point in the history
  • Loading branch information
josephmure committed Jun 5, 2024
1 parent c07b5b9 commit f99c97a
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions python/src/DrawableImplementation_doc.i.in
Original file line number Diff line number Diff line change
Expand Up @@ -1148,11 +1148,18 @@ Returns
validNorms : :class:`~openturns.Description`
List of the valid norms of contour drawables.

Notes
-----
These norms are strings that can be passed as the *norm* parameter
of a Matplotlib
`contour <https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.contour.html>`_
object, except *rank* which scales the colormap based on the ranks of the data values.

Examples
--------
>>> import openturns as ot
>>> print(ot.Drawable.GetValidNorms()[:2])
[asinh,linear]
>>> print(ot.Drawable.GetValidNorms())
[asinh,linear,log,logit,symlog,rank]
"
%enddef
%feature("docstring") OT::DrawableImplementation::GetValidNorms
Expand Down

0 comments on commit f99c97a

Please sign in to comment.