Keyboard shortcuts for assigning flags

[ghylander]

Is your feature request related to a problem? Please describe.
I'd like to be able to create shortcuts to quickly start a polygon tool or assign a flag to the image, and to advance to the next image or to go back to the previous image.

Describe the solution you'd like
Either pre-defined or user-definable keyboard shortcuts for labelme functions

[wkentaro]

You can edit ~/.labelmerc file and add shortcuts there.
Here are predefined ones:

labelme/labelme/config/default_config.yaml

Lines 71 to 106 in f8097a4

	shortcuts:
	close: Ctrl+W
	open: Ctrl+O
	open_dir: Ctrl+U
	quit: Ctrl+Q
	save: Ctrl+S
	save_as: Ctrl+Shift+S
	save_to: null
	delete_file: Ctrl+Delete
	open_next: [D, Ctrl+Shift+D]
	open_prev: [A, Ctrl+Shift+A]
	zoom_in: [Ctrl++, Ctrl+=]
	zoom_out: Ctrl+-
	zoom_to_original: Ctrl+0
	fit_window: Ctrl+F
	fit_width: Ctrl+Shift+F
	create_polygon: Ctrl+N
	create_rectangle: Ctrl+R
	create_circle: null
	create_line: null
	create_point: null
	create_linestrip: null
	edit_polygon: Ctrl+J
	delete_polygon: Delete
	duplicate_polygon: Ctrl+D
	copy_polygon: Ctrl+C
	paste_polygon: Ctrl+V
	undo: Ctrl+Z
	undo_last_point: Ctrl+Z
	add_point_to_edge: Ctrl+Shift+P
	edit_label: Ctrl+E
	toggle_keep_prev_mode: Ctrl+P
	remove_selected_point: [Meta+H, Backspace]

[ghylander]

that's amazing to know, I had a look at the docs/tried hitting some keys but did not try 'ctrl+key' combinations
Should i close it or do you prefer to keep it open until docs are ready?

[ghylander]

I've been reading the source code to try and add a shortcut to quickly assign flags, but I'm having some trouble

If I understood it correctly, I have to add the shortcut names to and key combinations to the ~/.labelmerc file:

  assign_flag_1: P
  assign_flag_2: N

Then, in app.py, I have to create the action(s), which I have initially written as:

        assign_flag_1 = action(
            self.tr("&Assign flag"),
            self.assignFlag(1),
            shortcuts["assign_flag_1"],
            "edit",
            self.tr("Assigns flag 1 to the current image"),
        )
        assign_flag_2 = action(
            self.tr("&Assign flag"),
            self.assignFlag(2),
            shortcuts["assign_flag_2"],
            "edit",
            self.tr("Assigns flag 2 to the current image"),
        )

And in app.py as well, I define the assignFlag function, def assignFlag(self, flag_n):, and this is where I got stuck. I've been trying to read the existing functions (such as editLabel), but I'm having trouble understanding it.

[SizheAn]

I've been reading the source code to try and add a shortcut to quickly assign flags, but I'm having some trouble

If I understood it correctly, I have to add the shortcut names to and key combinations to the ~/.labelmerc file:

  assign_flag_1: P
  assign_flag_2: N

Then, in app.py, I have to create the action(s), which I have initially written as:

        assign_flag_1 = action(
            self.tr("&Assign flag"),
            self.assignFlag(1),
            shortcuts["assign_flag_1"],
            "edit",
            self.tr("Assigns flag 1 to the current image"),
        )
        assign_flag_2 = action(
            self.tr("&Assign flag"),
            self.assignFlag(2),
            shortcuts["assign_flag_2"],
            "edit",
            self.tr("Assigns flag 2 to the current image"),
        )

And in app.py as well, I define the assignFlag function, def assignFlag(self, flag_n):, and this is where I got stuck. I've been trying to read the existing functions (such as editLabel), but I'm having trouble understanding it.

Hi, any luck in shortcuts for assigning the flags?

[owardlaw]

Having the same issue

[jeremia49]

I've tried to implement the shortcut for assigning flag, you can look at my commits below :
jeremia49@d9ac5d8

I wonder why I can't use numeric keys for the shortcut key so I changed the config file to use alphabetical keys and it works.
jeremia49@06380c9

[agentmorris]

In case it's helpful to the next person... I was also curious why numeric shortcuts didn't work... alt+0 and ctrl+0 worked fine, for example, but just "0" did not work. I don't have a great explanation, but I have a fix; in qt.py, I explicitly cast integer-valued shortcut strings to QtKey codes, by changing this:

if shortcut is not None:
        if isinstance(shortcut, (list, tuple)):
            a.setShortcuts(shortcut)
        else:
            a.setShortcut(shortcut)

...to this:

if shortcut is not None:
        try:
            val = int(shortcut)
            assert val >= 0 and val <=9, 'Invalid numeric shortcut: {}'.format(shortcut)
            shortcut = QKeySequence(val+QtCore.Qt.Key_0)
        except Exception:
            pass
        if isinstance(shortcut, (list, tuple)):
            a.setShortcuts(shortcut)
        else:
            a.setShortcut(shortcut)

...and voila, fixed.