# base_visualizer

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

所有可视化器继承的基类。

## 类

### BaseVisualizer

所有可视化器的基类。

可视化器在输入图像的副本上绘制节点的预测和批次的标签。每个子类都在
[VISUALIZERS](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/registry.md)
注册表中以其类名注册自己，因此配置将其命名为字符串。

子类实现
[forward](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/base_visualizer.md)。[BaseAttachedModule.get_parameters](https://docs.luxonis.com/zh/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/base_attached_module.md)
描述了
[run](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/base_visualizer.md)
如何填充其非画布参数。

#### 方法

##### init

```python
def __init__(*args, scale: float = 1.0, **kwargs):
```

初始化可视化器并存储画布比例。

参数

 * `*args`: 转发到
   [BaseAttachedModule](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/base_attached_module.md)
   的位置参数。
 * `scale` (`float`):
   [run](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/base_visualizer.md)
   在调用
   [forward](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/base_visualizer.md)
   之前，使用
   [scale_canvas](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/base_visualizer.md)
   对两个画布应用的因子。默认为 `1.0`。
 * `**kwargs`: 转发到
   [BaseAttachedModule](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/base_attached_module.md)
   的关键字参数，例如 `node`。

##### forward

```python
def forward(target_canvas: Tensor, prediction_canvas: Tensor, *args: Unpack[Ts]) -> Tensor | tuple[Tensor, Tensor] | tuple[Tensor, list[Tensor]] | list[Tensor]:
```

在画布上绘制标签和预测。

实现返回以下之一：

 * 一个图像，如
   [ClassificationVisualizer](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/classification_visualizer.md)
   在 `include_plot` 为 `False` 时所做。
 * 一个 `(labels, predictions)` 元组，包含两个图像，如
   [BBoxVisualizer](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/bbox_visualizer.md)
   所做。
 * 一个包含标签图像和图像列表的元组。
 * 一个不相关的图像列表。

参数

 * `target_canvas` (`Tensor`): 用于绘制标签的图像，形状为 `[B, 3, H, W]`。
 * `prediction_canvas` (`Tensor`): 用于绘制预测的图像，形状为 `[B, 3, H, W]`。
 * `*args` (`Unpack[Ts]`):
   [run](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/base_visualizer.md)
   从实现的参数名称解析的预测和标签。

返回

 * `Tensor | tuple[Tensor, Tensor] | tuple[Tensor, list[Tensor]] | list[Tensor]`: 可视化结果，以上述四种形式之一。

##### run

```python
def run(prediction_canvas: Tensor, target_canvas: Tensor, inputs: Packet[Tensor], labels: Labels | None) -> Tensor | tuple[Tensor, Tensor] | tuple[Tensor, list[Tensor]]:
```

缩放画布，解析输入，并调用
[forward](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/base_visualizer.md)。

[BaseAttachedModule.get_parameters](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/base_attached_module.md)
记录了
[forward](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/base_visualizer.md)
的其余参数如何选择预测和标签。

参数

 * `prediction_canvas` (`Tensor`): 用于绘制预测的图像，形状为 `[B, 3, H, W]`。
 * `target_canvas` (`Tensor`): 用于绘制标签的图像，形状为 `[B, 3, H, W]`。
 * `inputs` (`Packet[Tensor]`): 节点的输出包。
 * `labels` (`Labels | None`): 批次的标签，键为 `<task_name>/<label>`，如果批次没有标签则为 `None`。然后，每个可选的 `target` 参数接收 `None`，而必需的参数则会引发
   `RuntimeError`。

返回

 * `Tensor | tuple[Tensor, Tensor] | tuple[Tensor, list[Tensor]]`:
   [forward](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/base_visualizer.md)
   的返回值。

##### scale_canvas

```python
def scale_canvas(canvas: Tensor, scale: float = 1.0) -> Tensor:
```

使用双线性插值按因子调整一批图像的大小。

> **示例**
> ```pycon
>>> import torch
>>> canvas = torch.zeros(1, 3, 4, 6)
>>> BaseVisualizer.scale_canvas(canvas, scale=0.5).shape
torch.Size([1, 3, 2, 3])
>>> BaseVisualizer.scale_canvas(canvas, scale=2.0).shape
torch.Size([1, 3, 8, 12])
```

参数

 * `canvas` (`Tensor`): 形状为 `[B, C, H, W]` 的图像。
 * `scale` (`float`): 高度和宽度的乘数。默认为 `1.0`。

返回

 * `Tensor`: 形状为 `[B, C, floor(H * scale), floor(W * scale)]` 的图像。

#### 属性

##### colormap

一个 `ColorMap`，为每个标签提供独特的 RGB 颜色。

该映射在首次访问标签时分配颜色，并在之后返回相同的颜色。此属性在首次访问时创建映射并缓存它。

## 属性

### Ts
