# ocr_visualizer

Python API: `luxonis_train.attached_modules.visualizers.ocr_visualizer`

在白色面板上写入识别文本的可视化工具。

## 类

### OCRVisualizer

OCR 头文本预测的可视化工具。

可视化工具不会在输入图像上绘制。它会为每个图像返回一个带有白色面板的图像。面板显示目标文本和预测文本及其平均概率。

输入图像及其文本面板。

 * `输入：`： * `prediction_canvas`、`target_canvas` (`Tensor`)：[B, 3, H, W]
    * `predictions` (`Tensor`)：[B, T, C] logits
    * `targets` (`Tensor | None`)：[B, Tmax] Unicode 码点，用 `0` 填充
 * `输出：`： * `tuple[Tensor, Tensor]`：[B, 3, H, W]，输入图像和文本面板

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

> **注意事项**
> 附加的 [OCRCTCHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/ocr_ctc_head.md) 的 `decoder` 将预测转换为文本。OpenCV 在面板上写入文本。

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

```yaml
- name: OCRCTCHead
  inputs: [SVTRNeck]
  visualizers:
    - name: OCRVisualizer
```

 * `兼容：`： *
   使用者：[OCRRecognitionModel](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/config/predefined_models/ocr_recognition/v1/model.md)
    * 节点：[OCRCTCHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/ocr_ctc_head.md)

#### 方法

##### init

```python
def __init__(font_scale: float = 0.5, color: tuple[int, int, int] = (0, 0, 0), thickness: int = 1, **kwargs):
```

初始化可视化工具并存储文本选项。

参数

 * `font_scale` (`float`)：OpenCV 文本的字体比例。
 * `color` (`tuple[int, int, int]`)：文本颜色，每个通道一个值在 `[0, 255]` 之间，按画布的通道顺序。默认值为黑色。
 * `thickness` (`int`)：文本的线条粗细，以像素为单位。
 * `**kwargs`：转发到
   [BaseVisualizer](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/base_visualizer.md)
   的关键字参数，例如 `scale` 和 `node`。`node` 必须是
   [OCRCTCHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/ocr_ctc_head.md)，因为
   [forward](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/ocr_visualizer.md)
   使用其 `decoder`。其他节点类型会引发 `IncompatibleError`。

##### forward

```python
def forward(prediction_canvas: Tensor, target_canvas: Tensor, predictions: Tensor, targets: Tensor | None) -> tuple[Tensor, Tensor]:
```

在白色面板上写入目标文本和预测文本。

节点的 `decoder` 将 `predictions` 转换为文本和每个图像的平均概率。对于每个图像，该方法用白色填充画布大小的面板。当给出 `targets` 时，它会写入 `"GT: <目标文本>"`，文本的左下角位于像素 `(5, 20)`。它会在
`(5, 40)` 处写入 `"Pred: <预测文本> <概率>"`。概率有两位小数，对于空文本为 `nan`。

> **示例**
> ```pycon
>>> import torch
>>> from torch import Size
>>> from luxonis_train.nodes import OCRCTCHead
>>> shapes = [{"features": [Size([1, 8, 1, 4])]}]
>>> head = OCRCTCHead(alphabet=["a", "b"], input_shapes=shapes)
>>> visualizer = OCRVisualizer(node=head)
>>> canvas = torch.zeros(1, 3, 48, 96, dtype=torch.uint8)
>>> targets = torch.tensor([[97, 98, 0]])
>>> images, panels = visualizer(
...     canvas, canvas, torch.zeros(1, 4, 3), targets
... )
>>> bool((images == canvas).all()), panels[0, :, 0, 0].tolist()
(True, [255, 255, 255])
```

参数

 * `prediction_canvas` (`Tensor`)：形状为 `[B, 3, H, W]` 的图像。该方法仅使用此张量的形状、dtype 和设备。
 * `target_canvas` (`Tensor`)：形状为 `[B, 3, H, W]` 的 `uint8` 图像。面板将获得这些图像的大小。
 * `predictions` (`Tensor`)：节点的 logits，形状为 `[B, T, n_classes]`。
 * `targets` (`Tensor | None`)：`metadata/text` 标签，形状为 `[B, T_max]`。每行包含一个文本的 Unicode 码点，用 `0` 填充。当批次没有文本标签时为 `None`。

返回

 * `tuple[Tensor, Tensor]`：`target_canvas` 的副本，以及相同形状张量中的面板。

#### 属性

##### node
