add colorbar option to contour_plots

[jasongrout]

This patch adds the option of creating a color bar on a filled contour plot. See the doctests in the patch for examples.

CC: @kcrisman @sagetrac-wcauchois @robert-marik

Component: graphics

Author: Jason Grout

Reviewer: Robert Mařík

Merged: sage-4.4.alpha2

Issue created by migration from https://trac.sagemath.org/ticket/8368

[jasongrout]

comment:1

This ticket depends on #8366.

[jasongrout]

comment:2

(update makes colorbars work even when fill=False)

[sagetrac-mhampton]

comment:4

One thing I don't like about this is that you can't easily get a 1:1 aspect ratio plot - using figsize = [a,a] makes the overall figure square but not the plotted region.

[jasongrout]

comment:5

Replying to @sagetrac-mhampton:

One thing I don't like about this is that you can't easily get a 1:1 aspect ratio plot - using figsize = [a,a] makes the overall figure square but not the plotted region.

Of course. If you want the aspect ratio to be 1, then use the aspect_ratio=1 argument, which controls the aspect ratio. The figsize option controls the "figure size", i.e., the size of the entire figure.

[jasongrout]

apply instead of previous patch (rebased for the new #8366)

[sagetrac-mhampton]

comment:6

Attachment: trac-8368-colorbars.patch.gz

Replying to @jasongrout:

Replying to @sagetrac-mhampton:

One thing I don't like about this is that you can't easily get a 1:1 aspect ratio plot - using figsize = [a,a] makes the overall figure square but not the plotted region.

Of course. If you want the aspect ratio to be 1, then use the aspect_ratio=1 argument, which controls the aspect ratio. The figsize option controls the "figure size", i.e., the size of the entire figure.

OK. I think I got into the habit of using figsize before aspect_ratio worked. I will check the rebased version as soon as I can.

[robert-marik]

comment:7

Thanks for rebasing, I got the following errors. (But I do not switch the 'needs_review' flag unless somebody confirms this issue.)

...
      File "/mnt/usb1/scratch/marik/sage-4.3.5-sage.math.washington.edu-x86_64-Linux/local/lib/python/site-packages/sage/plot/contour_plot.py", line 193, in _render_on_subplot
        if options['colorbar']:
    KeyError: 'colorbar'
**********************************************************************
...
----------------------------------------------------------------------
The following tests failed:

        sage -t  "devel/sage/sage/plot/contour_plot.py"
Total time for all tests: 25.0 seconds

It would be also nice to add :: in between each pair of different examples - this allows to run any of the examples provided in this patch immediately from reference guide.
Robert

[jasongrout]

apply on top of previous patch

[jasongrout]

comment:8

Attachment: trac-8368-fix-options.patch.gz

I fixed both issues in the above patch.

I also doctested contour_plot.py this time!  Things should work now.

[robert-marik]

Reviewer: Robert Mařík

[robert-marik]

comment:9

Installs fine, works as excpected, tests passed now, documentation builds fine, positive review and thanks for adding this feature, as well as including my comments.

Positive review.

Release manager: Apply both trac-8368-colorbars.patch and trac-8368-fix-options.patch patches.

[jhpalmieri]

comment:10

Merged into 4.4.alpha2:

• trac-8368-colorbars.patch
• trac-8368-fix-options.patch

[jhpalmieri]

Merged: sage-4.4.alpha2