# fomo_confusion_matrix

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

FOMO 的混淆矩阵，它将每个预测点周围的小框与目标框进行匹配。

## 类

### FomoConfusionMatrix

FOMO 关键点预测的混淆矩阵。

 * `输入:`: * `keypoints` (`list[Tensor]`): 每张图像 [Ki, 1, 4]，`(x, y, prob, 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] 计数，行是目标，最后一行和列是背景
 * `公式:`:
   [update](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/fomo_confusion_matrix.md)
   会丢弃每个概率低于 `0.5` 的关键点。它将每个其他关键点转换为围绕该点的 `5`x`5` 像素框，并裁剪到图像。然后
   [DetectionConfusionMatrix](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/detection_confusion_matrix.md)
   使用 IoU 阈值 `0` 计算这些框。因此，当关键点框和目标框共享的面积大于 `0`
   时，目标框和关键点匹配。[DetectionConfusionMatrix](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/detection_confusion_matrix.md)
   的其他规则保持不变。

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

> **注意**
> 该指标始终使用 IoU 阈值 `0`。`iou_threshold` 不为 `None` 和 `0` 时会记录警告。

> **示例**
> 在 `model.nodes` 中附加到 `FOMOHead`：

```yaml
- name: FOMOHead
  inputs: [EfficientRep]
  metrics:
    - name: FomoConfusionMatrix
```

 * `兼容:`: * 节点:
   [FOMOHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/fomo_head.md)

#### 方法

##### init

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

使用 IoU 阈值 `0` 初始化指标。

参数

 * `iou_threshold` (`float | None`): 忽略。非 `None` 和 `0.0` 的值会记录警告。
 * `**kwargs`: 转发给
   [DetectionConfusionMatrix](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/detection_confusion_matrix.md)
   的关键字参数，例如 `node`。

##### update

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

将一个批次的关键点转换为框并计数。

[keypoints_to_bboxes](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/utils/boundingbox.md)
会丢弃每个概率低于 `0.5` 的关键点。它将每个其他关键点转换为围绕该点的 `5`x`5` 像素框。它将框裁剪到
[BaseAttachedModule.original_in_shape](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/base_attached_module.md)
的高度和宽度。然后
[DetectionConfusionMatrix](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/detection_confusion_matrix.md)
计数这些框。

> **示例**
> 一个类别 `0` 的目标框覆盖从 `0` 到 `5` 的像素。第一个关键点位于其中。第二个关键点的概率低于 `0.5`，因此指标将其丢弃。`SimpleNamespace` 代表节点。

```pycon
>>> import torch
>>> from types import SimpleNamespace
>>> node = SimpleNamespace(
...     task=None,
...     n_classes=1,
...     original_in_shape=torch.Size([3, 10, 10]),
... )
>>> metric = FomoConfusionMatrix(node=node)
>>> target = torch.tensor([[0, 0, 0.0, 0.0, 0.5, 0.5]])
>>> points = [
...     torch.tensor([[[2.0, 2.0, 0.9, 0]], [[8.0, 8.0, 0.3, 0]]])
... ]
>>> metric.update(points, target)
>>> metric.confusion_matrix.tolist()
[[1, 0], [0, 0]]
```

参数

 * `keypoints` (`list[Tensor]`): 每张图像的关键点，形状为 `[K_i, 1, 4]`，表示为像素中的 `[x, y, probability, class]`。列表的长度是批次大小。
 * `target_boundingbox` (`Tensor`): 批次的 `boundingbox` 标签，形状为 `[N, 6]`，表示为 `[batch_index, class, x, y, w, h]`。这些值是归一化的，`x` 和 `y`
   是左上角。该方法将 `xyxy` 像素写入其中。

#### 属性

##### supported_tasks
