# detection_confusion_matrix

Python API: `luxonis_train.attached_modules.metrics.confusion_matrix.detection_confusion_matrix`

通过 IoU 将预测与标签匹配的边界框混淆矩阵。

## 类

### DetectionConfusionMatrix

边界框预测的混淆矩阵。

 * `输入:`: * `boundingbox` (`list[Tensor]`): 每张图像 [Mi, 6]，`[x1, y1, x2, y2, conf, class]`，像素
    * `target_boundingbox` (`Tensor`): [N, 6]，`[batch, class, x, y, w, h]`，`xywh` 归一化
 * `输出:`: * `mcc` (`Tensor`): 整个矩阵的标量 MCC，请参阅
   [compute_mcc](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/utils.md)
    * `confusion_matrix` (`Tensor`): [nclasses + 1, nclasses + 1] 计数，行是目标，最后一行和列是背景
 * `公式:`: 该指标匹配每张图像的框。使用 `iou_threshold` 中的 IoU 阈值 t，当 IoU > t 时，目标框和预测匹配。预测的类别不影响匹配。每个目标框按行顺序选择它匹配的第一个预测，而不是 IoU
   最高的预测。几个目标框可以选择相同的预测。然后： * 匹配的目标框在其预测类别的列中，为其类别行添加 `1`。
    * 未匹配的目标框在其类别行中，为背景列添加 `1`。
    * 没有目标框选择的预测在其类别列中，为背景行添加 `1`。
    * 没有目标框且没有预测的图像在单元格 `[n_classes, n_classes]` 中添加 `1`。 在没有目标框、没有预测或没有匹配的图像中，每个类别最多计数一次。 例如，在没有目标框的图像中，三个类别 `0` 的预测添加 `1`，而不是
      `3`，到背景行。

> **参考**
> * 来源：本项目。
 * 许可证：Apache-2.0 (本项目)

> **注意**
> 该指标忽略置信度列，因此节点的每个预测都计数。[FomoConfusionMatrix](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/fomo_confusion_matrix.md) 和 [InstanceSegmentationConfusionMatrix](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/instance_segmentation_confusion_matrix.md) 扩展了此类别。

> **示例**
> 附加到 `model.nodes` 中的 `EfficientBBoxHead`：

```yaml
- name: EfficientBBoxHead
  inputs: [RepPANNeck]
  metrics:
    - name: DetectionConfusionMatrix
```

 * `兼容:`: * 节点: *
   [EfficientBBoxHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/efficient_bbox_head.md)
       * [EfficientKeypointBBoxHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/efficient_keypoint_bbox_head.md)
       * [PrecisionBBoxHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/precision_bbox_head.md)
       * [PrecisionSegmentBBoxHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/precision_seg_bbox_head.md)

#### 方法

##### init

```python
def __init__(iou_threshold: float = 0.45, **kwargs):
```

初始化指标及其 `confusion_matrix` 状态。

状态是一个形状为 `[n_classes + 1, n_classes + 1]` 的零 `int64` 张量。分布式运行会添加所有进程的状态。类别数量来自节点，因此没有节点的指标会引发 `RuntimeError`。

参数

 * `iou_threshold` (`float`): 目标框和预测的 IoU 必须超过此值才能匹配。
 * `**kwargs`: 转发给
   [BaseMetric](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/base_metric.md)
   的关键字参数，例如 `node`。

##### compute

```python
def compute(self) -> dict[str, Tensor]:
```

返回自上次重置以来的 MCC 和矩阵。

> **示例**
> 批次包含一张图像，其中有一个类别 `0` 的目标框。第一个预测覆盖它。第二个类别 `1` 的预测不匹配任何目标框。`SimpleNamespace` 代表节点。

```pycon
>>> import torch
>>> from types import SimpleNamespace
>>> node = SimpleNamespace(
...     task=None,
...     n_classes=2,
...     original_in_shape=torch.Size([3, 10, 10]),
... )
>>> metric = DetectionConfusionMatrix(node=node)
>>> target = torch.tensor([[0, 0, 0.0, 0.0, 0.5, 0.5]])
>>> boxes = [
...     torch.tensor([[0, 0, 5, 5, 0.9, 0], [6, 6, 9, 9, 0.8, 1]])
... ]
>>> metric.update(boxes, target)
>>> metric.compute()["confusion_matrix"].tolist()
[[1, 0, 0], [0, 0, 0], [0, 1, 0]]
```

返回

 * `dict[str, Tensor]`: 包含两个键的字典。 * `"mcc"` 包含整个矩阵的标量 MCC，包括背景，请参阅
   [compute_mcc](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/utils.md)。
    * `"confusion_matrix"` 包含 `int64` 计数，形状为 `[n_classes + 1, n_classes + 1]`。行是目标类别，列是预测类别，索引 `n_classes` 是背景。

##### update

```python
def update(boundingbox: list[Tensor], target_boundingbox: Tensor):
```

匹配一个批次的框并计算结果。

该方法将目标框转换为 `xyxy` 像素，其高度和宽度为
[BaseAttachedModule.original_in_shape](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/base_attached_module.md)。它将转换后的框写入
`target_boundingbox`。[BaseMetric.run_update](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/base_metric.md)
传递一个克隆，因此批次的标签不会改变。然后，该方法匹配每张图像的框，如类文档字符串所述。

参数

 * `boundingbox` (`list[Tensor]`): 每张图像的预测框，形状为 `[M_i, 6]`，以 `[x1, y1, x2, y2, conf, class]` 像素表示。列表的长度是批次大小。
 * `target_boundingbox` (`Tensor`): 批次的 `boundingbox` 标签，形状为 `[N, 6]`，以 `[batch_index, class, x, y, w, h]` 表示。值已归一化，`x` 和 `y`
   是左上角。

#### 属性

##### confusion_matrix

##### supported_tasks
