Skip to main content

English | 日本語

dollar_one_recognizer

A Python 3 implementation of the $1 Unistroke Recognizer.

License Python

詳しい日本語の解説は GitHub 上の README.ja.md にあります。

What is this

The $1 Unistroke Recognizer is a lightweight single-stroke gesture recognition algorithm by Wobbrock, Wilson, and Li (UIST '07). It needs no machine-learning training: register just one template per shape and it works. It resamples the input stroke to a fixed number of points, normalizes rotation, scale, and position, then picks the nearest registered template.

Input is a plain list of points [[x, y], ...], so the coordinates can come from a mouse, touch input, or a tracker such as OpenCV optical flow / color / fingertip tracking — just append each frame's (x, y) and pass the list in.

This repository contains the recognizer itself, packaged as dollar_one_recognizer_py/, plus two small Tkinter demo apps: export_gesture_app.py (draw and save gesture templates) and recognize_app.py (match a drawn stroke against saved templates).

Install

pip install dollar-one-recognizer-py

To also try the Tkinter demo apps, clone the repository instead:

git clone https://github.com/yuzujelly2222/dollar_one_recognizer_python.git
cd dollar_one_recognizer_python
pip install -r requirements.txt

Dependencies are numpy (geometry) and pillow (PNG I/O for the demo apps).

Usage

from dollar_one_recognizer_py import dollar_one_recognizer

# Register templates — one example stroke per shape is enough
line_template = [[x, x] for x in range(0, 101, 5)]
check_template = [[0, 30], [30, 0], [90, 60]]

recognizer = dollar_one_recognizer(
    size=250,
    templates=[line_template, check_template],
    templates_name=["line", "checkmark"],
    n=64,
)

# Raw points to recognize (e.g. collected from a mouse drag)
query = [[x, x * 0.9 + 2] for x in range(0, 101, 4)]

best_points, best_name, score = recognizer.recognize(query)
print(best_name, score)  # -> line 0.96...

Try the GUI demos:

python export_gesture_app.py   # draw and save to gestures/ as CSV + PNG
python recognize_app.py        # auto-load gestures/ and test recognition

How it works

$1 applies four steps to the input points and returns the nearest template:

  1. Resample (_resample) to n (default 64) evenly spaced points, absorbing differences in drawing speed.
  2. Rotate (_rotate_to_zero) so the angle from the centroid to the first point is zero.
  3. Scale & translate (_scale_to_square -> _translate_to_origin) into a size x size square (default 250) centered at the origin.
  4. Match (recognize) against each template, searching +/-45 degrees for the rotation that minimizes the average point-to-point distance (Golden Section Search), and return the closest. The distance is converted to a 0-1 score.

The Protractor enhancement (a closed-form optimal angle instead of the search) is not included in this implementation. See README.ja.md on GitHub for a fuller walkthrough.

API

Only the members below are part of the public API; the geometry helpers are prefixed with _ and are internal.

Member Description
__init__(size, templates, templates_name, n) Initialize with a list of template strokes and their names
add_template(points, name) Add one more template
recognize(points) Normalize a raw stroke, match all templates, return (best_points, best_name, score)

License & citation

Distributed under the New BSD License — see LICENSE.

This is an independent implementation based on the pseudocode from the paper below. The original authors and copyright holders exist separately from this port.

Wobbrock, J.O., Wilson, A.D. and Li, Y. (2007). Gestures without libraries, toolkits or training: A $1 recognizer for user interface prototypes. Proceedings of the ACM Symposium on User Interface Software and Technology (UIST '07), pp. 159-168.

Official site (algorithm, pseudocode, reference implementation): https://depts.washington.edu/acelab/proj/dollar/index.html

Metadata

Release files for dollar-one-recognizer-py 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dollar-one-recognizer-py 1.0.0
File Size Uploaded
dollar_one_recognizer_py-1.0.0.tar.gz 11.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for dollar-one-recognizer-py 1.0.0
File Interpreter ABI Platform
dollar_one_recognizer_py-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 22.8 kB

Release files / dollar_one_recognizer_py-1.0.0.tar.gz

Download URL dollar_one_recognizer_py-1.0.0.tar.gz
Size 11.5 kB
Tags Source
SHA-256 checksum
How to use checksums
b3b90b917cf5d5efb1cf55b1112cbe653c43b4038a33753ae078dcf9aa07626e
BLAKE2b-256 checksum
How to use checksums
5c987bd22eab389953bd0bdcde9796c87803e7155ccbb1a4f98854bfa59f83b6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.9

Release files / dollar_one_recognizer_py-1.0.0-py3-none-any.whl

Download URL dollar_one_recognizer_py-1.0.0-py3-none-any.whl
Size 11.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0db2fb656470a78cd4851ed68d904f523795e4e8dcef9028578295c7e0ca6bbd
BLAKE2b-256 checksum
How to use checksums
12fcc763b7533136adc68b4772b2db60a43d0fedf3da09cfcfd0bb9a72cd1460
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.9

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page