# GID Plugin Documentation

## Overview

The GID plugin extends VIPR for GIWAXS/GID Bragg peak detection using `mlgidDETECT`.

It provides:
- TIFF and HDF5 data loaders
- ONNX model loading and inference
- postprocessing to structured peak results
- UI outputs (image + peaks table)

## Registered Components

| Component Type | Handler Label |
|---|---|
| Data loader | `gid_tif_reader` |
| Data loader | `gid_pygid_h5_reader` |
| Model loader | `mlgiddetect` |
| Predictor | `mlgiddetect_predictor` |
| Postprocessor | `mlgiddetect_postprocessor` |

## Quickstart

```bash
vipr --config @vipr_gid/mlgiddetect/examples/configs/w4_tif.yaml inference run
```

Main outputs:
- image: `giwaxs_detection_0` (or `..._1`, `..._2`, ...)
- table: `peaks`

## Documentation

```{toctree}
:maxdepth: 1
:caption: Plugin Details

configuration
visualization
troubleshooting
```
