ICRA/README.md

58 lines
1.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# ColorCalc
ColorCalc is a small Tkinter tool for analysing colour ranges in images. You load a picture, pick or click a reference colour, adjust hue/saturation/value sliders, and the app marks matching pixels while showing quick stats.
## Features
- Two synced previews (original + overlay)
- Hue/Sat/Value sliders with presets and image colour picker
- Exclusion rectangles to ignore regions
- Theme toggle (light/dark) with rounded toolbar buttons
- Quick overlay export (PNG) and optional defaults via `config.toml`
## Requirements
- Python 3.11+ (3.10 works with `tomli`)
- Tkinter (install separately on some Linux distros)
- Pillow (`pip install pillow`)
## Setup
```bash
git clone https://github.com/<your-org>/ColorCalc.git
cd ColorCalc
python3 -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install pillow
python3 main.py
```
## Workflow
1. Load an image (`📂`).
2. Pick a colour (`🎨` dialog, `🖱️` image click, or preset swatch).
3. Finetune sliders; watch the overlay update on the right.
4. Draw exclusions with right drag; reset or save when ready.
## Config Defaults
Optional `config.toml`:
```toml
[defaults]
hue_min = 250.0
hue_max = 310.0
sat_min = 15.0
val_min = 15.0
val_max = 100.0
alpha = 120
```
## Project Layout
```
app/
app.py # main app assembly
gui/ # UI, theme, picker mixins
logic/ # image ops, defaults, reset
config.toml # optional defaults
main.py # entry point
```
## Development
- Quick check: `python3 -m compileall app main.py`
- Contributions welcome; include screenshots for UI tweaks.