# segmentation

Python API: `depthai_nodes.node.parsers.segmentation`

## 类

### SegmentationParser

用于解析分割模型输出的解析器类。

> **注意**
> 发出 `dai.SegmentationMask` 消息。dai.SegmentationMask 包含分割掩码。每个像素都精确地属于一个类。未分配的像素用“255”表示，类像素用非负整数表示。

引发

 * `ValueError`: 如果输出层的数量不是 1。
 * `ValueError`: 如果输出张量的维度数量不是 3。

#### 方法

##### init

```python
def __init__(output_layer_name: str = '', classes_in_one_layer: bool = False, background_class: bool = False):
```

初始化解析器节点。

参数

 * `output_layer_name` (`str`): 与解析器相关的输出层名称。
 * `classes_in_one_layer` (`bool`): 在多类分割模型中，所有类是否都在一个层中。默认为 False。如果为 True，解析器将使用 np.max 而不是 np.argmax 来获取类映射。
 * `background_class` (`bool`): 类索引 0 是否应被视为背景。

##### build

```python
def build(head_config: dict[str, Any]) -> SegmentationParser:
```

配置解析器。

参数

 * `head_config` (`dict[str, Any]`): 解析器的头部配置。

返回

 * `SegmentationParser`: 设置了头部配置的解析器对象。

##### compute

```python
def compute(segmentation_mask: np.ndarray, *, classes_in_one_layer: bool = False, background_class: bool = False) -> np.ndarray:
```

在不发送消息的情况下，从提取的张量计算解析器结果。

> **注意**
> 使用 [depthai_nodes.node.parsers.utils.segmentation.compute_segmentation_class_map](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/node/parsers/utils/segmentation.md)；有关张量布局和验证详细信息，请参阅该帮助程序。

参数

 * `segmentation_mask` (`np.ndarray`): CHW 或 HWC 张量，可选批处理。4D 张量使用其第一个批处理项；最小轴被视为类轴。
 * `classes_in_one_layer` (`bool`): 单个通道是否已编码类 ID 而不是前景分数。
 * `background_class` (`bool`): 对于多类分数张量，将获胜类 0 替换为 255。

返回

 * `np.ndarray`: HW uint8 标签图。未分配的像素为 255。单个前景分数通道与零进行比较，并为正像素发出类 0。

##### emit

```python
def emit(output: dai.NNData, class_map: np.ndarray):
```

创建 `dai.SegmentationMask` 消息并将其发送到 `out`。

复制源时间戳和序列号，并在存在时携带源图像转换。

参数

 * `output` (`dai.NNData`): 携带张量和源时间戳、序列号以及可选图像转换的神经网络输出。
 * `class_map` (`np.ndarray`): HW 类索引掩码，255 保留用于背景。

##### extract

```python
def extract(output: dai.NNData):
```

选择并解量化解析所需的模型张量。

参数

 * `output` (`dai.NNData`): 携带张量和源时间戳、序列号以及可选图像转换的神经网络输出。

返回

 * 解量化分割张量，如果张量是 4D，则选择第一个批处理项。

引发

 * `ValueError`: 如果未配置输出名称且消息不包含恰好一个层，或者未满足配置的类要求。

##### run

```python
def run(self):
```

读取排队的网络输出，解析它们，并在运行时发出结果。

管道调用此处理循环。当输入队列关闭或节点停止时，它将退出。

##### setBackgroundClass

```python
def setBackgroundClass(background_class: bool):
```

设置类索引 0 是否应被视为背景。

参数

 * `background_class` (`bool`): 类索引 0 是否为背景。

##### setClassesInOneLayer

```python
def setClassesInOneLayer(classes_in_one_layer: bool):
```

设置指示所有类是否都在一个层中的标志。

参数

 * `classes_in_one_layer` (`bool`): 所有类是否都在一个层中。

##### setOutputLayerName

```python
def setOutputLayerName(output_layer_name: str):
```

设置输出层的名称。

参数

 * `output_layer_name` (`str`): 输出层的名称。

#### 属性

##### background_class

##### class_names

##### classes_in_one_layer

在多类分割模型中，所有类是否都在一个层中。默认为 False。如果为 True，解析器将使用 np.max 而不是 np.argmax 来获取类映射。

##### n_classes

##### output_layer_name

与解析器相关的输出层名称。
