napari-point-proofread
https://github.com/LaboratoryOpticsBiosciences/napari-point-proofread
Proofreading Brainbow images with napari
This napari plugin was generated with copier using the napari-plugin-template.
Installation
You can install napari-point-proofread via pip:
pip install napari-point-proofread
If napari is not already installed, you can install napari-point-proofread with napari and Qt via:
pip install "napari-point-proofread[all]"
Beginner Quick Guide (Step-by-Step)
This plugin provides two panels in napari:
- Plugins > Proofread Brainbow > Manual Proofread
- Plugins > Proofread Brainbow > Proofread Predictions (from csv)
1. Open napari and load your data
-
Start napari:
napari
-
Drag and drop your Brainbow image into the viewer (or use File > Open File(s)...).
-
If you have prediction points, also load the CSV file.
2. Open the plugin widgets
- Open Plugins > Proofread Brainbow > Manual Proofread.
- (Optional) Open Plugins > Proofread Brainbow > Proofread Predictions (from csv) if you want to review model predictions.
3. Prepare the image for proofreading
In Manual Proofread:
- Select your image in Image layer.
- Click Convert to RGB (for 4D channel-first/channel-middle data).
- Click Normalize (perc=99) to improve visibility.
- Use Contrast max and ZYX scale sliders as needed.
- (Optional) Click Make grid to create a labeled grid overlay for systematic review.
Tip: In napari layer list, right-click an RGB layer and use Split RGB when needed (often helpful for 3D inspection).
4. Add or edit proofreading points
- Create or select a Points layer.
- In Point Layer Tools, set Point size for better visibility.
- (Optional) Enable Enable class annotation.
- Choose a class number and use Assign class to selected to label points.
5. Review prediction CSV points by confidence (optional)
In Proofread Predictions (from csv):
- Select the loaded prediction points layer.
- Adjust Min probability.
- Click Threshold probability (csv) to create/update a filtered layer (
threshold_prob).
6. Save your corrected points
- Select your final points layer.
- Save as CSV from napari.
- In the save dialog, set Files of type to Proofread Brainbow points (*.csv) (as shown in the image). Otherwise, values that should remain integers (for example, class labels) may not be saved correctly.
Developer Setup
After cloning the repository, you can set up a development environment with conda:
pip
Step 1: Create and activate the corresponding conda environment
conda create -n napari-point-proofread -c conda-forge python=3.11 pip -y
conda activate napari-point-proofread
Step 2: Install requirements with pip
cd napari-point-proofread
pip install -e . --group dev
--group requires pip >= 25.1.
Step 3: Test the plugin by running napari
napari
The plugin should appear under Plugins > Proofread Brainbow
With uv
uv sync
uv run napari
Run the tests with uv run pytest (current environment) or uv run tox (full matrix).
Contributing
Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.
License
Distributed under the terms of the MIT license, "napari-point-proofread" is free and open source software
Issues
If you encounter any problems, please [file an issue] along with a detailed description.
Metadata
Release files for napari-proofread-brainbow 0.3.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| napari_proofread_brainbow-0.3.3.tar.gz | 3.7 MB | With provenance | Details for napari_proofread_brainbow-0.3.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| napari_proofread_brainbow-0.3.3-py3-none-any.whl | Python 3 | none | any | Details for napari_proofread_brainbow-0.3.3-py3-none-any.whl |
Total release size: 3.7 MB
Release files / napari_proofread_brainbow-0.3.3.tar.gz
| Download URL | napari_proofread_brainbow-0.3.3.tar.gz |
|---|---|
| Size | 3.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9d91f0c2b2911992b6df3ecaded60f90ed1273e563466d4e33fda9756e9c7d97
|
|
BLAKE2b-256 checksum How to use checksums |
6de538989adc8eb112b7e7f0e353be15e8b0799eee60fc423cc654189bf65a6e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.
Transparency logRelease files / napari_proofread_brainbow-0.3.3-py3-none-any.whl
| Download URL | napari_proofread_brainbow-0.3.3-py3-none-any.whl |
|---|---|
| Size | 18.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ba5d21526944ce7fe6005922c1535ed43af458ec29a86039b76d286523e184c8
|
|
BLAKE2b-256 checksum How to use checksums |
8cfbcbefee374f8aaaeaffbeb35fc272eebc1702570c54fba771ccb9ff628730
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.
Transparency logSecurity for napari-proofread-brainbow 0.3.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for napari_proofread_brainbow-0.3.3.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.