feature: Use unit in label by giulioungaretti · Pull Request #495 · microsoft/Qcodes

giulioungaretti · 2017-02-14T15:50:05Z

Use units for plotting. Pyqtgraph uses units in a clever way!

Needs #494 to be 100% great.

giulioungaretti · 2017-02-14T15:51:23Z

@MerlinSmiles this is what we talked about, opinions ?
@QCoDeS/core opinions ?

🦄

giulioungaretti · 2017-02-14T15:58:16Z

This clearly does not work as intended with multi dimensional parameters.

MerlinSmiles · 2017-02-14T15:59:29Z

@giulioungaretti Yes, thats exactly the thing
and does not need #494 to be perfect, if a parameter does not have a unit it wont show up.
And you will have issues with multi dimensions [volt, current] ... but that is an issue with how you kind of try to plot an datasomethin that has two sets of data.

MerlinSmiles · 2017-02-14T16:01:22Z

I have no idea where the dataset and stuff is now. previously it was that an array in the dataset got the units from the parameter, if it was a list it would just have a list. which ofc is wrong.

giulioungaretti · 2017-02-14T16:06:54Z

@MerlinSmiles yep. it's pretty much still the same spaghetti.

giulioungaretti · 2017-02-14T16:12:50Z

something that we have to keep in mind for #476 !

AdriaanRol · 2017-02-15T13:36:05Z

@giulioungaretti I really love this feature. However, I generally use the QCoDeS plotting independently. Would it be possible to allow specifying custom units using xlabel and ylabel (as per the docstring)

I am suggesting something allowing the following syntax

PyQtPlotObj.add(x=x, y=np.sin(x), xlabel=('Time', 's'), ylabel=('Amplitude', 'V'))

From what I can tell this would be a trivial addition to this PR that would greatly improve the plotting API.

giulioungaretti · 2017-02-15T15:44:08Z

@AdriaanRol sure!

giulioungaretti · 2017-02-20T16:36:19Z

@AdriaanRol ✔️

AdriaanRol · 2017-02-21T08:57:50Z

@giulioungaretti, If I read your changes correctly, this change would not allow using the labels in the "old" simple way, i.e.,:

xlabel=('label', 'unit'), is usable (+1) but it is no longer be possible to use xlabel='label', while the default PyQtGraph API does allow this in both ways.

Would it be possible to default the unit to None if no unit is specified or otherwise just passing the arguments on to PyQtGraph directly? I think this would be good both for keeping the API as simple as possible to use as well as for backwards compatibility.

In any case I'd be happy to use this either way

giulioungaretti · 2017-02-21T12:12:12Z

@AdriaanRol

qc.QtPlot.add(x=data, y=data, labelx=("a", "V"), labely=("b", "V")

where one must pass a tuple of (label, unit).
It does break a bit the old API , but it's a lot less ambiguous than having either a tuple or a string.
But it's a easy change if people feel like it's better. Feedback @QCoDeS/core @QCoDeS/core-contributors >

MerlinSmiles · 2017-02-21T21:19:11Z

@giulioungaretti im with @AdriaanRol here. In the simple way to plot something with add(xdata, ydata, 'x-string', y-string) it would be nice if one isn't forced to write tuples and None units, but just leave them out.

giulioungaretti · 2017-02-22T12:33:24Z

@MerlinSmiles @AdriaanRol the best we can do, give the current way this is handled is:

qc.QtPlot.add(x=data, y=data, xlabel="a", xunit= "V", ylabely="b", yunit= "V")

everything must be a kwarg, not my favourite but that's the way qc plot was give us :D

AdriaanRol · 2017-02-22T12:37:45Z

@giulioungaretti, I'd be fine with that syntax (though there is a funny ylabel*y* ).

That being said, I see no reason why accepting the kwarg to either be a float or a tuple of two floats would not be possible, a simple type check on the value should suffice. (Though at this point I'm happy either way).

I also agree that the API being kwargs only is not optimal, but that is a completely different topic :)

giulioungaretti · 2017-02-23T14:12:02Z

@AdriaanRol @MerlinSmiles @QCoDeS/core ok took more that I thought to fix this, the internals are quite interesting. Would love a review!

AdriaanRol

@giulioungaretti , Looks great to me. Can't wait to start using it 👍

One thing I noticed is that there are no tests for this. Altough testing graphical things is hard, I consider it good practice to just test for errors. As in create the minimal working examples run them in a test and not test if the result is right but just if it does not crash. That seems to catch most accidental breakings of the API in any case.

AdriaanRol · 2017-03-01T16:25:21Z

qcodes/plots/base.py

                self.add_to_plot.
                To use custom labels and units pass for example:
-                    >>> plot.add(x=set, y=amplitude, xlabel=("set", "s"), ylabel= ("Amplitude", "V"))
+                    plot.add(x=set, y=amplitude, 


Good docstring 👍

I guess it would not be possible to make them explicit keyword arguments of the add function that then always get passed on to the relevant subfunction? I think this would improve usability, as the shift-tab functionality would then show this as default keyword arguments.

That being said, I consider that an enhancement that goes beyond the scope of this PR, so maybe for a next time.

@AdriaanRol right now that's unfortunately not possible :( but it soon will !

AdriaanRol · 2017-03-01T16:28:58Z

qcodes/plots/pyqtgraph.py

        """
        for axletter, side in (('x', 'bottom'), ('y', 'left')):
            ax = subplot_object.getAxis(side)
+            # danger: 🍝


why danger? I'd say that if someone wants to overwrite a label (to e.g., more clearly distinguish two voltages) that is intended behaviour.

@AdriaanRol danger as in enter spaghetti code. (The emoji maybe does not render :D )

giulioungaretti · 2017-03-01T17:44:58Z

@AdriaanRol testing wise, this is tricky as you say. I think we'll live with this for now. Then once we have a leaner api, we can actually test the logic without plotting (i.e. making sure we actually have the right data and metadata ) and let the plotting library developers do their testing 🗡

I will then proceed merging soon!

Author: Giulio Ungaretti <[email protected]> feature: Use unit in label (#495)

AdriaanRol mentioned this pull request Feb 15, 2017

Automatic units rescaling in live plot DiCarloLab-Delft/PycQED_py3#115

Closed

giulioungaretti force-pushed the feature/useunits branch from e975040 to d2e4605 Compare February 20, 2017 16:31

AdriaanRol approved these changes Mar 1, 2017

View reviewed changes

giulioungaretti and others added 5 commits March 2, 2017 17:49

feature: Use unit in label

0597d5f

feature: Use units in labels

7a9f750

feature: Introduce kwargs, and fix x axis

e7b1057

fix: Update docstring

6993229

fix: Allow partial kwargs else fall back to data

817433c

giulioungaretti force-pushed the feature/useunits branch from 7e7155a to 817433c Compare March 2, 2017 16:49

giulioungaretti merged commit e95d623 into master Mar 2, 2017

giulioungaretti deleted the feature/useunits branch March 2, 2017 16:54

giulioungaretti pushed a commit that referenced this pull request Mar 2, 2017

Generated gh-pages for commit e95d623

4d38946

Author: Giulio Ungaretti <[email protected]> feature: Use unit in label (#495)

jenshnielsen mentioned this pull request Mar 13, 2017

Fix: restore handling of labels on multi line plots in matplot #521

Merged

Comments

Conversation

giulioungaretti commented Feb 14, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

giulioungaretti commented Feb 14, 2017

Uh oh!

giulioungaretti commented Feb 14, 2017

Uh oh!

MerlinSmiles commented Feb 14, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MerlinSmiles commented Feb 14, 2017

Uh oh!

giulioungaretti commented Feb 14, 2017

Uh oh!

giulioungaretti commented Feb 14, 2017

Uh oh!

AdriaanRol commented Feb 15, 2017

Uh oh!

giulioungaretti commented Feb 15, 2017

Uh oh!

giulioungaretti commented Feb 20, 2017

Uh oh!

AdriaanRol commented Feb 21, 2017

Uh oh!

giulioungaretti commented Feb 21, 2017

Uh oh!

MerlinSmiles commented Feb 21, 2017

Uh oh!

giulioungaretti commented Feb 22, 2017

Uh oh!

AdriaanRol commented Feb 22, 2017

Uh oh!

giulioungaretti commented Feb 23, 2017

Uh oh!

AdriaanRol left a comment

Choose a reason for hiding this comment

Uh oh!

AdriaanRol Mar 1, 2017

Choose a reason for hiding this comment

Uh oh!

giulioungaretti Mar 1, 2017

Choose a reason for hiding this comment

Uh oh!

AdriaanRol Mar 1, 2017

Choose a reason for hiding this comment

Uh oh!

giulioungaretti Mar 1, 2017

Choose a reason for hiding this comment

Uh oh!

giulioungaretti commented Mar 1, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

giulioungaretti commented Feb 14, 2017 •

edited

Loading

MerlinSmiles commented Feb 14, 2017 •

edited

Loading