{"name":"napari-padbound","display_name":"padbound","visibility":"public","icon":"","categories":[],"schema_version":"0.2.1","on_activate":null,"on_deactivate":null,"contributions":{"commands":[{"id":"napari-padbound.make_widget","title":"padbound","python_name":"napari_padbound:PadboundWidget","short_title":null,"category":null,"icon":null,"enablement":null}],"readers":null,"writers":null,"widgets":[{"command":"napari-padbound.make_widget","display_name":"padbound","autogenerate":false}],"sample_data":null,"themes":null,"menus":{},"submenus":null,"keybindings":null,"configuration":[]},"package_metadata":{"metadata_version":"2.4","name":"napari-padbound","version":"0.3.0","dynamic":null,"platform":null,"supported_platform":null,"summary":"A napari plugin for padbound","description":"# napari-padbound\n\n[![License BSD-3](https://img.shields.io/pypi/l/napari-padbound.svg?color=green)](https://github.com/uermel/napari-padbound/raw/main/LICENSE)\n[![PyPI](https://img.shields.io/pypi/v/napari-padbound.svg?color=green)](https://pypi.org/project/napari-padbound)\n[![Python Version](https://img.shields.io/pypi/pyversions/napari-padbound.svg?color=green)](https://python.org)\n[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-padbound)](https://napari-hub.org/plugins/napari-padbound)\n\nA [napari] plugin for controlling image annotation workflows with MIDI controllers via [padbound].\n\nUse physical pads, knobs, faders, and buttons to navigate slices, select labels, adjust brush size, zoom, undo/redo, and more — with real-time LED feedback showing your current label colors on the controller.\n\n## Features\n\n- **Auto-detection** — Automatically finds and connects to any [padbound]-supported MIDI controller\n- **Smart control mapping** — Automatically assigns available hardware controls to napari functions based on controller capabilities\n- **Slice navigation** — Coarse and fine navigation through 3D+ data volumes via faders or knobs\n- **Slice stepping** — Increment/decrement slices one at a time via navigation buttons\n- **Zoom control** — Logarithmic zoom mapping (0.01x–10x) via knobs or faders\n- **Brush size control** — Logarithmic brush size adjustment (1–100px) for label painting\n- **Label selection** — Select labels by pressing pads; pad 1 is the eraser, remaining pads map to labels 1, 2, 3, ...\n- **LED color feedback** — Pads display actual label colors from the napari colormap, with the selected label pulsing (on RGB-capable controllers)\n- **Dimension rolling** — Cycle through dimension views (XY, YZ, XZ) via navigation buttons\n- **Undo/redo** — Transport buttons for edit history on the active Labels layer\n- **Graceful degradation** — Three feedback strategies (RGB color, binary toggle, none) adapt automatically to controller capabilities\n\n## Supported Controllers\n\nAny controller with a [padbound] plugin works automatically. Currently supported:\n\n| Controller | Best for | Key controls |\n|---|---|---|\n| **AKAI APC mini MK2** | Full RGB feedback, many faders | 64 RGB pads, 9 faders, 17 buttons |\n| **AKAI LPD8 MK2** | Compact RGB + knobs | 8 RGB pads, 8 knobs, 4 banks |\n| **AKAI MPD218** | Velocity-sensitive pads | 16 pads, 6 encoders, 3 banks |\n| **PreSonus ATOM** | RGB pads + encoders + buttons | 16 RGB pads, 4 encoders, 20 buttons |\n| **Synido TempoPad P16** | RGB pads + transport | 16 RGB pads, 4 encoders, 6 buttons |\n| **Behringer X-Touch Mini** | Encoders with LED rings | 16 pads, 8 encoders, 1 fader |\n| **Xjam** | Budget option, multi-bank | 16 pads, 6 knobs, 3 banks |\n\n## How Control Mapping Works\n\nThe plugin automatically discovers available controls and assigns them by priority:\n\n**Continuous controls** (assigned in order: faders first, then knobs, then encoders):\n1. First control → **Coarse slice** (full range of the data volume)\n2. Second control → **Fine slice** (±64 slices around the coarse position)\n3. Third control → **Brush size** (logarithmic, 1–100px)\n4. Fourth control → **Zoom** (logarithmic, 0.01x–10x)\n\n**Pads** → **Label selection** (pad 1 = eraser, pad 2+ = labels)\n\n**Navigation buttons** → Up/Down = slice step, Left/Right = dimension roll\n\n**Transport buttons** → Stop = undo, Play = redo\n\nThe widget displays the detected controller and its mapped controls so you can see what each physical control does.\n\n## Installation\n\n```bash\npip install napari-padbound\n```\n\nFor development:\n\n```bash\ngit clone https://github.com/uermel/napari-padbound.git\ncd napari-padbound\npip install -e \".[dev,testing]\"\n```\n\n## Usage\n\n1. Connect a supported MIDI controller via USB\n2. Open [napari]\n3. Go to **Plugins > padbound** to open the widget\n4. Load a 3D image and create a Labels layer\n5. Use your controller to navigate slices, select labels, and annotate\n\nThe widget shows the connected controller name and the mapping of physical controls to napari functions. If no controller is detected, the widget will indicate this.\n\n## Development\n\n```bash\n# Linting\nruff check src/\nruff format src/\nblack src/\n\n# Run tests\npytest\n```\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nDistributed under the terms of the [BSD-3] license, napari-padbound is free and open source software.\n\n## Issues\n\nIf you encounter any problems, please [file an issue] along with a detailed description.\n\n[napari]: https://github.com/napari/napari\n[padbound]: https://github.com/uermel/padbound\n[BSD-3]: http://opensource.org/licenses/BSD-3-Clause\n[file an issue]: https://github.com/uermel/napari-padbound/issues\n","description_content_type":"text/markdown","keywords":null,"home_page":null,"download_url":null,"author":null,"author_email":"\"Utz H. Ermel\" ","maintainer":null,"maintainer_email":null,"license":null,"classifier":["Development Status :: 3 - Alpha","Framework :: napari","Intended Audience :: Developers","License :: OSI Approved :: BSD License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.9","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Topic :: Scientific/Engineering :: Image Processing"],"requires_dist":["magicgui","napari","numpy","padbound>=0.3.0","qtpy","black; extra == 'dev'","pre-commit; extra == 'dev'","ruff; extra == 'dev'","napari; extra == 'testing'","pyqt5; extra == 'testing'","pytest; extra == 'testing'","pytest-cov; extra == 'testing'","pytest-qt; extra == 'testing'","tox; extra == 'testing'"],"requires_python":">=3.9","requires_external":null,"project_url":["Bug Tracker, https://github.com/uermel/napari-padbound/issues","Documentation, https://github.com/uermel/napari-padbound#README.md","Source Code, https://github.com/uermel/napari-padbound"],"provides_extra":["dev","testing"],"provides_dist":null,"obsoletes_dist":null},"npe1_shim":false}