---
title: panoptic-quality
tags:
- evaluate
- metric
description: PanopticQuality score
sdk: gradio
sdk_version: 4.36.0
app_file: app.py
pinned: false
emoji: 🖼️
---

# SEA-AI/PanopticQuality

This hugging face metric uses `seametrics.segmentation.PanopticQuality` under the hood to compute a panoptic quality score. It is a wrapper class for the torchmetrics class [`torchmetrics.detection.PanopticQuality`](https://lightning.ai/docs/torchmetrics/stable/detection/panoptic_quality.html). 

## Getting Started

To get started with PanopticQuality, make sure you have the necessary dependencies installed. This metric relies on the `evaluate`, `seametrics` and `seametrics[segmentation]`libraries for metric calculation and integration with FiftyOne datasets.

### Basic Usage
```python
>>> import evaluate
>>> from seametrics.payload.processor import PayloadProcessor
>>> MODEL_FIELD = ["maskformer-27k-100ep"]
>>> payload = PayloadProcessor("SAILING_PANOPTIC_DATASET_QA",
>>>                         gt_field="ground_truth_det",
>>>                         models=MODEL_FIELD,
>>>                         sequence_list=["Trip_55_Seq_2", "Trip_197_Seq_1", "Trip_197_Seq_68"],
>>>                         excluded_classes=[""]).payload
>>> module = evaluate.load("SEA-AI/PanopticQuality", area_rng=[(0, 100),(100, 1e9)])
>>> module.add_payload(payload, model_name=MODEL_FIELD[0])
>>> module.compute()
100%|██████████| 3/3 [00:03<00:00,  1.30s/it]
Added data ...
Start computing ...
Finished!
{'scores': {'MOTORBOAT': array([[0.        , 0.25889117],
         [0.        , 0.79029936],
         [0.        , 0.3275862 ]]),
  'FAR_AWAY_OBJECT': array([[0., 0.],
         [0., 0.],
         [0., 0.]]),
  'SAILING_BOAT_WITH_CLOSED_SAILS': array([[0.        , 0.35410052],
         [0.        , 0.75246359],
         [0.        , 0.47058824]]),
  'SHIP': array([[0.        , 0.47743301],
         [0.        , 0.90181785],
         [0.        , 0.52941179]]),
  'WATERCRAFT': array([[0., 0.],
         [0., 0.],
         [0., 0.]]),
  'SPHERICAL_BUOY': array([[0., 0.],
         [0., 0.],
         [0., 0.]]),
  'FLOTSAM': array([[0., 0.],
         [0., 0.],
         [0., 0.]]),
  'SAILING_BOAT_WITH_OPEN_SAILS': array([[0., 0.],
         [0., 0.],
         [0., 0.]]),
  'CONTAINER': array([[0., 0.],
         [0., 0.],
         [0., 0.]]),
  'PILLAR_BUOY': array([[0., 0.],
         [0., 0.],
         [0., 0.]]),
  'AERIAL_ANIMAL': array([[0., 0.],
         [0., 0.],
         [0., 0.]]),
  'HUMAN_IN_WATER': array([[0., 0.],
         [0., 0.],
         [0., 0.]]),
  'WOODEN_LOG': array([[0., 0.],
         [0., 0.],
         [0., 0.]]),
  'MARITIME_ANIMAL': array([[0., 0.],
         [0., 0.],
         [0., 0.]]),
  'WATER': array([[0.        , 0.96737861],
         [0.        , 0.96737861],
         [0.        , 1.        ]]),
  'SKY': array([[0.        , 0.93018024],
         [0.   
```

## Metric Settings
The metric takes four optional input parameters: __label2id__, __stuff__, __per_class__ and __split_sq_rq__.

* `label2id: Dict[str, int]`: this dictionary is used to map string labels to an integer representation.
    if not provided a default setting will be used:
        `{'WATER': 0,
        'SKY': 1,
        'LAND': 2,
        'MOTORBOAT': 3,
        'FAR_AWAY_OBJECT': 4,
        'SAILING_BOAT_WITH_CLOSED_SAILS': 5,
        'SHIP': 6,
        'WATERCRAFT': 7,
        'SPHERICAL_BUOY': 8,
        'CONSTRUCTION': 9,
        'FLOTSAM': 10,
        'SAILING_BOAT_WITH_OPEN_SAILS': 11,
        'CONTAINER': 12,
        'PILLAR_BUOY': 13,
        'AERIAL_ANIMAL': 14,
        'HUMAN_IN_WATER': 15,
        'OWN_BOAT': 16,
        'WOODEN_LOG': 17,
        'MARITIME_ANIMAL': 18}
        `
* `stuff: List[str]`: this list holds all string labels that belong to stuff.
    if not provided a default setting will be used:
        `
        ["WATER", "SKY", "LAND", "CONSTRUCTION", "ICE", "OWN_BOAT"]`

* `per_class: bool = True`: By default, the results are split up per class.
    Setting this to False will aggregate the results (average the _scores_, sum up the _numbers_; see below for explanation of _scores_ and _numbers_)
* `split_sq_rq: bool = True`: By default, the PQ-score is returned in three parts: the PQ score itself, and split into the segmentation quality (SQ) and recognition quality (RQ) part.
    Setting this to False will return the PQ score only (PQ=RQ*SQ).

## Output Values
A dictionary containing the following keys:
* __scores__: This is a dictionary, that contains a key for each label, if `per_class == True`. Otherwise it only contains the key _all_.
              For each key, it contains an array that holds the scores in the the columns in following order: PQ, SQ and RQ. If `split_sq_rq == False`, the columns consist of PQ only.
              The number of rows corresponds to the given area ranges. That means, the results in each row are for a certain size of objects.
* __numbers__: This is a dictionary, that contains a key for each label, if `per_class == True`. Otherwise it only contains the key _all_.
               For each key, it contains an array that consists of four elements in the columns: TP, FP, FN and IOU:
  * __TP__: number of true positive predictions
  * __FP__: number of false positive predictions
  * __FN__: number of false negative predictions
  * __IOU__: sum of IOU of all TP predictions with ground truth

  With all these values, it is possible to calculate the final scores. As for the scores, the number of rows corresponds to the given area ranges. That means, the results in each row are for a certain size of objects.

## Further References

- **seametrics Library**: Explore the [seametrics GitHub repository](https://github.com/SEA-AI/seametrics/tree/main) for more details on the underlying library.
- **Torchmetrics**: https://lightning.ai/docs/torchmetrics/stable/detection/panoptic_quality.html
- **Understanding Metrics**: The Panoptic Segmentation task, as well as Panoptic Quality as the evaluation metric, were introduced [in this paper](https://arxiv.org/pdf/1801.00868.pdf).

## Contribution

Your contributions are welcome! If you'd like to improve SEA-AI/PanopticQuality or add new features, please feel free to fork the repository, make your changes, and submit a pull request.