voxel51/fiftyone

[FR] Map plugin enhancements

Open

#1994 opened on Aug 11, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (4,021 stars) (400 forks)batch import
appenhancementgood first issue

Description

Enhancement requests for the (awesome) map plugin introduced in #1976:

ESC handling

Currently, pressing ESC when any component of the App is in focus (grid, sidebar, etc) will cause the map's location to be reset. Ideally the map would only be reset when the map has focus.

For example, the user might have selected a sample but then wants to press ESC to clear the selection. Currently both the selection and the map will be reset simultaneously.

On a related note, while in the middle of defining a selection region, pressing ESC currently simultaneously resets the selection (good) but also resets the map's view (ideally this would require a second ESC).

Geo-based queries

Map lasso selections are currently encoded via select() stages. But, it would be more natural and space-efficient to express them using the geo_within() query defined by the selection area that the user inputted. Example geo_within() usage.

A second, related optimization would be to combine multiple searches into a single stage. IE if I perform three selections and then press the bookmark icon, I'd like to see only a single GeoWithin stage added to my view bar. Currently I will see multiple Select() stages added. The merging of multiple selections into a single stage could be implemented independent of whether Select() or GeoWithin() is used to represent the query. this is already done, at least for the current Select() based implementation

Contributor guide

Tech stack
javascriptreactpython
Domain
full stack
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with FiftyOne map pluginBasic JavaScript event handlingUnderstanding of geo spatial queries in FiftyOne
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Start by examining the map plugin implementation referenced in PR #1976. For ESC handling, investigate how ESC key events are currently handled globally and modify to only reset map when map is focused. For geo based queries, study the existing select() stage implementation and explore how geo within() can be used instead. Look at the view bar logic to ensure multiple selections are merged into a single GeoWithin stage. Test with sample data to verify behavior.