# superanimal_landmarker

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

## 类

### SuperAnimalParser

用于解析 SuperAnimal 地标模型输出的解析器类。

> **注意**
> 发出 `dai.beta.Keypoints` 消息。输出包含超出置信度阈值的检测到的关键点。

#### 方法

##### init

```python
def __init__(output_layer_name: str = '', scale_factor: float = 256.0, n_keypoints: int = 39, score_threshold: float = 0.5, label_names: list[str] | None = None, edges: list[tuple[int, int]] | None = None):
```

初始化解析器节点。

参数

 * `output_layer_name` (`str`): 与解析器相关的输出层名称。
 * `scale_factor` (`float`): 用于除关键点的比例因子。
 * `n_keypoints` (`int`): 关键点数量。
 * `score_threshold` (`float`): 检测到的关键点的置信度分数阈值。
 * `label_names` (`list[str] | None`): 关键点的标签名称。
 * `edges` (`list[tuple[int, int]] | None`): 定义骨架边缘的关键点索引对。例如，`[(0, 1), (1, 2)]` 将关键点 0 连接到 1，将 1 连接到 2。

##### build

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

配置解析器。

参数

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

返回

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

##### compute

```python
def compute(heatmaps: np.ndarray, *, scale_factor: float) -> tuple[np.ndarray, np.ndarray]:
```

计算解析器结果，从提取的张量中获取，无需发送消息。

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

参数

 * `heatmaps` (`np.ndarray`): 模型热图张量。
 * `scale_factor` (`float`): 用于将模型坐标转换为归一化坐标的非零除数。

返回

 * `tuple[np.ndarray, np.ndarray]`: 一对 `(N, 2)` 关键点坐标和 `(N,)` 分数。坐标除以 `scale_factor`。

##### emit

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

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

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

参数

 * `output` (`dai.NNData`): 神经网络输出，携带张量和源时间戳、序列号以及可选的图像转换。
 * `keypoints` (`np.ndarray`): `compute()` 返回的归一化关键点坐标。
 * `scores` (`np.ndarray`): 与计算出的有效载荷对应的置信度分数。

##### extract

```python
def extract(output: dai.NNData) -> np.ndarray:
```

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

参数

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

返回

 * `np.ndarray`: 模型张量布局中的反量化 float32 热图。

引发

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

##### run

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

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

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

#### 属性

##### edges

定义骨架边缘的关键点索引对。例如，`[(0, 1), (1, 2)]` 将关键点 0 连接到 1，将 1 连接到 2。

##### label_names

关键点的标签名称。

##### n_keypoints

关键点数量。

##### output_layer_name

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

##### scale_factor

用于除关键点的比例因子。

##### score_threshold

检测到的关键点的置信度分数阈值。
