Add polygon selection

[jfoster17]

Pull Request Template

Description

This adds a polygon/lasso-type selection tool to the image and scatter viewers in glue-jupyter using the MouseInteraction class provided in bqplot_image_gl. Creating subsets from arbitrary regions is a top priority for Alyssa before we show an alpha version of glue-jupyter-lab to the world.

For similarity with other selection tools it would have been nice to get the data back from the LassoSelector (as in this stalled PR), but getting that finished and into a released version of bqplot was probably going to take too long.

I hope that the new testing infrastructure can verify that adding a new default tool to the basic viewers does not mess things up for jdaviz.

[jfoster17]

Tagging @astrofrog and @maartenbreddels for their awareness here

[jfoster17]

Not sure what the CircleCI error here means...

[astrofrog]

Aside from a small comment about the icon below, I couldn't get this to work - for some reason the drag events are just not triggered. If I add 'click' to the events to listen to, then I can check that on_msg gets called when I click, but nothing happens when I click and drag. I'm using MacOS X and I see this on both Safari and Google Chrome.

[astrofrog]

The CircleCI error should be fixed by #372

[astrofrog]

I just tried this out in Jupyter lab and it works nicely! One small difference compared to other tools is that when the selection is being drawn, it is bright yellow while drawing is active, whereas for other selection tools it is a translucent grey. Would it be possible to make this new tool match the behavior of the existing ones?

[jfoster17]

I just tried this out in Jupyter lab and it works nicely! One small difference compared to other tools is that when the selection is being drawn, it is bright yellow while drawing is active, whereas for other selection tools it is a translucent grey. Would it be possible to make this new tool match the behavior of the existing ones?

Done.

[jfoster17]

Do you get any error when trying to use this polygon tool in Notebook? I get:

[E 11:07:22.922 NotebookApp] Uncaught exception, closing connection.
    Traceback (most recent call last):
      File "/Users/jfoster/mambaforge/envs/bqplot-polygon-selection/lib/python3.11/site-packages/tornado/iostream.py", line 695, in _handle_events
        self._handle_write()
      File "/Users/jfoster/mambaforge/envs/bqplot-polygon-selection/lib/python3.11/site-packages/tornado/iostream.py", line 965, in _handle_write
        self._write_buffer.advance(num_bytes)
      File "/Users/jfoster/mambaforge/envs/bqplot-polygon-selection/lib/python3.11/site-packages/tornado/iostream.py", line 182, in advance
        assert 0 < size <= self._size
               ^^^^^^^^^^^^^^^^^^^^^^
    AssertionError
Exception in callback None()

which looks suspiciously similar to the iostream messages reported here.

[astrofrog]

@jfoster17 - when I use notebook I don't see any errors - either in the browser console or in the terminal where I started the notebook from. Clicking and dragging just doesn't do anything.

[Carifio24]

I'm seeing the same thing - works great in lab, but no errors and no functionality in the notebook. I found something that, at least for me, makes it work in both environments, but maybe @astrofrog has a bit more insight into why this would be the case.

So I think the issue might be the MouseInteraction that's set as the tool's interact member (maybe it's related to the comment here?). As it is now, for me all drag events in the notebook are completely silenced with this tool active - it seems that this interaction is eating them up somehow. But if I ditch this interaction (set self.interact = None), this works fine for me in both the notebook and lab. (Why this isn't an issue in lab, I have no clue).

[jfoster17]

Fantastic! Thanks for this breakthrough Jon. Now there are just a few more things to clean up...

[codecov]

Codecov Report

Patch coverage: 29.82% and project coverage change: -0.67 ⚠️

Comparison is base (eff2a12) 87.32% compared to head (b12d66a) 86.65%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #371      +/-   ##
==========================================
- Coverage   87.32%   86.65%   -0.67%     
==========================================
  Files          89       89              
  Lines        4882     4937      +55     
==========================================
+ Hits         4263     4278      +15     
- Misses        619      659      +40     

Impacted Files	Coverage Δ
glue_jupyter/bqplot/scatter/viewer.py	100.00% <ø> (ø)
glue_jupyter/bqplot/common/tools.py	62.07% <28.57%> (-5.34%)	⬇️
glue_jupyter/bqplot/image/viewer.py	87.50% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[jfoster17]

I think this is good-to-go. I rebased to get the CircleCI fix. @astrofrog -- would you like to do another review?

[astrofrog]

Works great in both the scatter and image viewer, thanks! 🎉