Square plots #4310

insertroar · 2015-04-04T21:29:32Z

Implemented feature suggested in #3742 .
Added square parameter to the axis method, which sets equal limits and equal scale on both axes.
Test case with image comparison included.

tacaswell · 2015-04-05T01:16:27Z

lib/matplotlib/axes/_base.py

+                    self.set_autoscale_on(False)
+                    xlim = self.get_xlim()
+                    ylim = self.get_ylim()
+                    minlim = min(xlim[0], ylim[0])


Would in be better to change the limits to

edge_size = max(np.diff(xlim), np.diff(ylim)) ax.set_xlim([xliml[0], xlim[0] + edge_size]) ax.set_ylim([ylim[0], ylim[0] + edges_size])

Which would let you get a square area, but with the lower left any where is dataspace, not just on the x==y diagonal.

tacaswell · 2015-04-05T01:20:29Z

This will also need to be documented in https://github.com/matplotlib/matplotlib/tree/master/doc/users/whats_new

Looks like a good start!

tacaswell · 2015-04-11T01:30:23Z

This needs to be re-based.

insertroar · 2015-04-12T22:35:20Z

Done, re-based, is there anything else to add to it?

tacaswell · 2015-04-13T01:12:22Z

doc/users/whats_new/square_plot_feature.rst

+Square plot:
+
+Added implementation of square plot feature that sets the axes of a plot
+to have the same maximum difference between them, and set the scale to be


This is very awkwardly worded, maybe say xmax-xmin == ymax-ymin?

tacaswell · 2015-04-13T01:19:28Z

@efiring thoughts?

efiring · 2015-04-13T19:37:01Z

I also thought about zoom/pan; my conclusion is that enforcing 'square' when zooming and panning is much more trouble than it is worth. I don't see a use case for it. It seems to me that 'square' is something one specifies in a script for a final plot, not something that matters when zooming and panning. There, maintaining the aspect ratio does matter, and this is already handled.

tacaswell · 2015-04-13T21:15:34Z

Sounds reasonable 👍 On this from me (modulo documentation issues).

tacaswell · 2015-04-15T18:14:55Z

lib/matplotlib/axes/_base.py

-        and the aspect ratio of the plot. For details, see
-        :func:`~matplotlib.pyplot.axis`.
+        Call signature::
+


As you are re-writing this, can you convert it to numpydoc format as well?

No problem, I wasn't aware you're encouraging this format, and it's not clear from the current docstrings. Before I commit, is this ok? Seeing as the function only takes in optional arguments, I wasn't sure if to include a 'Parameters' section or to put both *v and **kwargs in 'Other parameters'

"""Set axis properties Convenience method for manipulating axis properties such as the x and y view limits and the aspect ratio of the plot. For details, see :func:`~matplotlib.pyplot.axis`. Parameters ---------- *v Axis toggle, aspect ratio and limits properties. Other parameters ---------------- **kwargs Axis limit properties *kwargs* are passed on to :meth:`set_xlim` and :meth:`set_ylim` Returns ------- v : list of axis limits ``(xmin, xmax, ymin, ymax)``. """

Not quite, I think you will need to escape those *s with backslashes, and also I don't think you need :meth: or :func:, though I may have got that wrong.

Before you commit you can check it works by switching to the matplotlib/doc folder and running make.py html which will generate the doc and place it in doc/build/html, note it will take a few minutes to do it the first time, following runs it will only build the files that have changed.

All of the docstrings should be numpydoc formatted, we just have a huge backlog to get through (and updating docstrings is even less sexy than triaging bugs).

Looking at this more cloesly this function does not fit well with numpydoc as it uses patterns that the numpy developers don't use.

So, please correct me if I am wrong, but it looks like there should never be more than one arg as the logic is

if len(v) == 1 and isinstance(str, v[0]): # parse string elif not len(v): # look work for kwargs else: v = v[0] assert len(v) == 4 # do stuff with the vector

so I think a docstring like

If no positional or kwargs are given, returns the current axes limits are returned with no side effects. If a positional argument is passed the keyword arguments are ignored. If no positional argument is passed, the keyword arguments are used. Parameters ---------- v : list of float or {'on', 'off', 'equal', 'tight', 'scaled', 'normal', 'auto', 'image', 'square'} Optional positional argument Value to set the axis settings to. If a list it is interpreted as [xmin, xmax, ymin, ymax]. If a string INSERT TABLE HERE emit : bool, optional Passed to set_{x,y}lim functions, if observers are notified of axis limit change xmin, ymin, xmax, ymax : float, optional The axis limits to be set

er, forget

Returns ------- xmin, xmax, ymin, ymax : float The axis limits

tacaswell · 2015-04-19T20:13:00Z

lib/matplotlib/axes/_base.py

+        Parameters
+        ----------
+        v : list of float or {'on', 'off', 'equal', 'tight', 'scaled',\
+         'normal', 'auto', 'image', 'square'}


If you build the docs does this look ok?

Yes, the \ puts everything on one line. The only thing is the table size:

The table looks fine to me size wise. There are a lot of options so it
needs lot of descriptions.

On Sun, Apr 19, 2015 at 5:39 PM basharovV notifications@github.com wrote:

In lib/matplotlib/axes/_base.py
#4310 (comment):

Convenience method for manipulating the x and y view limits

and the aspect ratio of the plot. For details, see

:func:`~matplotlib.pyplot.

axis`.

"""Set axis properties.

If no positional or kwargs are given, returns the current

axes limits are returned with no side effects.

If a positional argument is passed the keyword arguments are ignored.

If no positional argument is passed, the keyword arguments are used.

Parameters

v : list of float or {'on', 'off', 'equal', 'tight', 'scaled',\

'normal', 'auto', 'image', 'square'}

Yes, the \ puts everything on one line. The only thing is the table size:
[image: axis_doc]
https://cloud.githubusercontent.com/assets/8410950/7221487/d00fd61c-e6ba-11e4-91d2-dbca6173cf28.png

—
Reply to this email directly or view it on GitHub
https://github.com/matplotlib/matplotlib/pull/4310/files#r28657228.

Sorry, I was referring to the actual padding in the table. It's not consistent with the other tables, but that's just an aesthetic thing.

efiring · 2015-04-20T03:25:24Z

I don't want to bog you down in documentation fixups that are peripheral to your PR; feel free to ignore my comments.

tacaswell · 2015-04-20T03:59:56Z

Particularity when the text is very close to what I wrote...

On Sun, Apr 19, 2015 at 11:25 PM Eric Firing notifications@github.com
wrote:

I don't want to bog you down in documentation fixups that are peripheral
to your PR; feel free to ignore my comments.

—
Reply to this email directly or view it on GitHub
#4310 (comment)
.

basharovV · 2015-04-20T04:37:06Z

Thanks for the input! Regarding the PR - yes this is a bit off-track but that doesn't mean I should ignore your comments.

WeatherGod · 2015-04-20T14:26:59Z

lib/matplotlib/pyplot.py

+    changes the limit ranges (*xmax*-*xmin*) and (*ymax*-*ymin*) of
+    the *x* and *y* axes to be the same, and have the same scaling,
+    resulting in a square plot.
+


isn't axis()'s docstring in pyplot autogenerated

It's outside the autogenerated part, running boilerplate.py doesn't affect it.

You are two for two in confusing devs on this!

Which does raise the question why isn't this part of boilerplate generated
code?

On Mon, Apr 20, 2015, 18:40 basharovV notifications@github.com wrote:

In lib/matplotlib/pyplot.py
#4310 (comment):

@@ -1406,6 +1406,12 @@ def axis(_v, *_kwargs):
as kwargs selectively to alter just those limits without changing
the others.

>>> axis('square')

changes the limit ranges (xmax-xmin) and (ymax-ymin) of

the x and y axes to be the same, and have the same scaling,

resulting in a square plot.

It's outside the autogenerated part, running boilerplate.py doesn't affect
it.

—
Reply to this email directly or view it on GitHub
https://github.com/matplotlib/matplotlib/pull/4310/files#r28736156.

The boilerplate generation is applied only to plotting functions. It adds thegca(), the hold kwarg, and the draw_if_interactive. There are many functions that are only in pyplot. If I remember correctly, axis started out as pyplot-only but was added to Axes later. Certainly boilerplate.py could be modified to handle more Axes methods, but I don't think there is any point in doing anything like that until various other major changes settle down.

efiring · 2015-05-14T06:26:51Z

Is this waiting for anything more to be done? It looks to me like it is ready to merge.

WeatherGod · 2015-05-14T12:55:51Z

I thought what remained was to synchronize the pyplot docstring and the axes docstring

efiring · 2015-05-14T18:04:25Z

I think that the way this PR handles the pyplot docstring is fine. It modifies it in accord with its present style to take into account the new kwarg. This looks to me like it will be much more helpful to the user, especially the new user, than simply duplicating the opaque numpydoc docstring from Axes.

ENH: 'square' argument to `Axes.axis`

tacaswell · 2015-06-16T02:02:08Z

@insertroar Thank you

tacaswell added the status: needs review label Apr 4, 2015

insertroar changed the title ~~Added square plot parameter to axes~~ Square plots Apr 4, 2015

tacaswell reviewed Apr 5, 2015
View reviewed changes

tacaswell added this to the next point release milestone Apr 5, 2015

tacaswell added status: needs revision and removed status: needs review labels Apr 5, 2015

Yunfei Yang and others added 4 commits April 12, 2015 17:21

Added square plot parameter to axes

d6848b1

Made changes to square plot as suggested.

3f6dd49

Create square_plot_feature.rst

bb45d27

Resolved conflicts

53a2d2c

insertroar force-pushed the master branch from 1d2a8a1 to 53a2d2c Compare April 12, 2015 21:43

tacaswell reviewed Apr 13, 2015
View reviewed changes

basharovV added 2 commits April 14, 2015 18:52

Edited documentation, modified square plot test

ee5ccc7

Removed whitespace

7b73d0a

tacaswell reviewed Apr 15, 2015
View reviewed changes

Changed docstring to numpydoc format

c982755

tacaswell added status: needs review and removed status: needs revision labels Apr 19, 2015

tacaswell reviewed Apr 19, 2015
View reviewed changes

Edited docstring as suggested

50af626

WeatherGod reviewed Apr 20, 2015
View reviewed changes

tacaswell added a commit that referenced this pull request Jun 16, 2015

Merge pull request #4310 from insertroar/master

42a852d

ENH: 'square' argument to `Axes.axis`

tacaswell merged commit 42a852d into matplotlib:master Jun 16, 2015

tacaswell removed the status: needs review label Jun 16, 2015

tacaswell mentioned this pull request Feb 15, 2016

Square plots #3742

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Square plots #4310

Square plots #4310

insertroar commented Apr 4, 2015

tacaswell Apr 5, 2015

tacaswell commented Apr 5, 2015

tacaswell commented Apr 11, 2015

insertroar commented Apr 12, 2015

tacaswell Apr 13, 2015

tacaswell commented Apr 13, 2015

efiring commented Apr 13, 2015

tacaswell commented Apr 13, 2015

tacaswell Apr 15, 2015

basharovV Apr 19, 2015

OceanWolf Apr 19, 2015

tacaswell Apr 19, 2015

tacaswell Apr 19, 2015

tacaswell Apr 19, 2015

tacaswell Apr 19, 2015

basharovV Apr 19, 2015

tacaswell Apr 19, 2015

basharovV Apr 19, 2015

efiring commented Apr 20, 2015

tacaswell commented Apr 20, 2015

basharovV commented Apr 20, 2015

WeatherGod Apr 20, 2015

basharovV Apr 20, 2015

tacaswell Apr 20, 2015

efiring May 14, 2015

efiring commented May 14, 2015

WeatherGod commented May 14, 2015

efiring commented May 14, 2015

tacaswell commented Jun 16, 2015

Square plots #4310

Square plots #4310

Conversation

insertroar commented Apr 4, 2015

Choose a reason for hiding this comment

tacaswell commented Apr 5, 2015

tacaswell commented Apr 11, 2015

insertroar commented Apr 12, 2015

Choose a reason for hiding this comment

tacaswell commented Apr 13, 2015

efiring commented Apr 13, 2015

tacaswell commented Apr 13, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

efiring commented Apr 20, 2015

tacaswell commented Apr 20, 2015

basharovV commented Apr 20, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

efiring commented May 14, 2015

WeatherGod commented May 14, 2015

efiring commented May 14, 2015

tacaswell commented Jun 16, 2015