add options about custom markers to point2d

[ppurka]

point2d by default doesn't allow customization of markers. The patch below adds this functionality by adding two extra options marker and markeredgecolor.

---

Apply the git branch.

CC: @jasongrout @eviatarbach

Component: graphics

Author: Punarbasu Purkayastha

Branch/Commit: d7d7809

Reviewer: Karl-Dieter Crisman

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

[ppurka]

Attachment: trac_13576-list_plot_doc.patch.gz

Apply to devel/sage

[ppurka]

Author: Punarbasu Purkayastha

[ppurka]

Work Issues: add customization options to point

[ppurka]

Changed work issues from add customization options to point to none

[ppurka]

Attachment: trac_13576-add_options_to_points.patch.gz

Apply to devel/sage

[kcrisman]

comment:5

Oh, ppurka, I would love you if this works, I always get stuck using line(... linestyle='') for this very thing!

Is there an option for the width of the marker edge? They kind of overwhelm the marker color with the default point size; I have to go to size=60 or so to have it really seem like an edge.

Am I correct in my suspicion that markeredgecolor sort of automatically implies faceted=True in mpl internally? At least, the plots look like it, and faceted=False does nothing when I use markeredgecolor. The markeredgecolor seems to govern the color of the facet; I assume this is right, but the quite different names might make one think they control two different things.

In general I really like this patch, though, including the careful small local improvements that have nothing to do with the ticket but which are still valuable. Passes tests, so... answer my questions and you might get a positive review. Thanks for looking into this!

[ppurka]

comment:6

I will need some time to recall what this patch is doing, and what other changes I had in mind regarding this.

I do remember that I resisted adding some extra keywords which are synonymous to the keywords in plot, list_plot, etc, and which have the same functionality as other keywords in this function. I think size is the same as markersize, color keyword is missing, markeredgecolor and faceted control the same thing, except the second is a boolean, and so on. Essentially, a bunch of inconsistencies on the Sage interface side mainly because the keywords used are the same as the mpl scatter command. It is really jarring that many different plot commands have different keywords for achieving the same effect.

Do you think it will be useful to either deprecate some keywords or add other keywords like color, markersize, etc which are similar to the keywords used in plot, list_plot, line, etc?

[kcrisman]

Reviewer: Karl-Dieter Crisman

[kcrisman]

comment:7

Do you think it will be useful to either deprecate some keywords or add other keywords like color, markersize, etc which are similar to the keywords used in plot, list_plot, line, etc?

Maybe. I wonder whether Jason might have some comments.

[jasongrout]

comment:8

I actually just added marker options to points the other day in my personal copy of Sage so I could do some plots that I wanted to do :).

I think someone ought to go through each plotting function and make a comprehensive sweep to clean up options and make things more consistent. Right now, it's very confusing.

[ppurka]

comment:9

Ok then, let's defer the cleanup to a different ticket - #13828 to be precise.

[ppurka]

comment:10

Replying to @kcrisman:

Oh, ppurka, I would love you if this works, I always get stuck using line(... linestyle='') for this very thing!

Actually, it is true that line(... linestyle='') is more powerful than point (mpl's scatter). Many options are not present in the scatter command.

Is there an option for the width of the marker edge? They kind of overwhelm the marker color with the default point size; I have to go to size=60 or so to have it really seem like an edge.

There is no such option for scatter/point. But there is the option markeredgewidth for plot/line.

[kcrisman]

comment:11

What I am hearing here is that there is no point in using mol's scatter instead of whatever we use for line2d. What does scatter have (speed, flexibility, something else) that mpl lines.Iine2D doesn't have?

[ppurka]

comment:12

Replying to @kcrisman:

What I am hearing here is that there is no point in using mol's scatter instead of whatever we use for line2d. What does scatter have (speed, flexibility, something else) that mpl lines.Iine2D doesn't have?

Right. This could be best answered by mpl. Other than the cmap argument, which we don't use in point2d, I don't see how scatter is better than line2d.

Also, #13830 is relevant for any cleanup.

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

7542143

add additional marker information to plot()

[sagetrac-git]

Changed commit from 9305db7 to 7542143

[ppurka]

Changed work issues from marker, check list of markers to none

[ppurka]

comment:30

1. The information about marker was already present in points. The documentation asks users to look at points.option to find the information about allowed options. points.option does mention marker and was already asking the reader to look at plot for more information.

2. The marker list in plot was mostly complete. Added a few more.

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

1493a78

fix documentation for scatter_plot and points

[sagetrac-git]

Changed commit from 7542143 to 1493a78

[rwst]

Work Issues: rebase

[sagetrac-git]

Changed commit from 1493a78 to d7d7809

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

d7d7809

merge develop (sage-6.2) on to current ticket

[ppurka]

comment:36

Thanks for checking the ticket. The changes from develop have been merged on to current ticket.

[ppurka]

Changed work issues from rebase to none

[kcrisman]

comment:38

Eventually we'll need to unify scatter plot and point, I think there is even a ticket for this...

I would love to add more examples sometime.

sage: plot(x^2,marker="$x^2$",markeredgecolor='red')

Hilarious!

Anyway, I'm happy with this.

[vbraun]

Changed branch from u/ppurka/ticket/13576 to d7d7809