Opened 16 months ago

Last modified 15 months ago

#24331 new enhancement

Document undocumented behaviour(s) of the 3D plotting functions

Reported by: charpent Owned by:
Priority: major Milestone: sage-8.2
Component: graphics Keywords:
Cc: egourgoulhon Merged in:
Authors: Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: #23696 Stopgaps:

Description

It turns out that our 3D plotting infrastructures has some nice, but undocumented features :

  • plot3d and friends accept float("NaN") values as value of a plotted function, and leave the corresponding face(s) unplotted : this gives a rectangular hole un the surface ;
  • the same functions accept a2-element list (or tuple ?) [<point function>, <colormap>]as a value for the color keyword argument ; this allows to compute a color value as a function of the point.

As far as I know, this latter point is documented only for parametric surfaces ; the first one is not documented at all.

The point of this ticket is to document these abilities, thus (hopefully) avoiding to lose them in any future upgrade (somewhat needed...) of our 3D infrastructure, and allowing to write new utilities explicitly using them.

Change History (3)

comment:1 Changed 16 months ago by chapoton

Some documentation for color functions was added after 8.0. Please wait for the doc of 8.1 to see where. This is still very minimal.

comment:2 Changed 16 months ago by egourgoulhon

  • Cc egourgoulhon added

comment:3 Changed 15 months ago by charpent

  • Dependencies set to #23696

We'll wait on a probable upgrade of matplotlib : the undocumented features might change ;-).

Note: See TracTickets for help on using tickets.