# xfeat

Python API: `depthai_nodes.node.parsers.utils.xfeat`

## 函数

### bilinear

```python
def bilinear(im, pos, H, W):
```

给定输入和流场网格，使用输入值和网格中的像素位置计算输出。仅支持双线性插值方法来采样输入像素。

参数

 * `im` (`np.ndarray`): 输入特征图，形状 (N, C, H, W)
 * `pos` (`np.ndarray`): 点坐标，形状 (N, Hg, Wg, 2)
 * `H` (`int`): 输出特征图的高度
 * `W` (`int`): 输出特征图的宽度

返回

 * `np.ndarray`: 采样点的张量，形状 (N, C, Hg, Wg)

### compute_xfeat_matches

```python
def compute_xfeat_matches(result1: dict[str, Any], result2: dict[str, Any], min_cossim: float = -1) -> tuple[np.ndarray, np.ndarray]:
```

通过相互最近邻相似度匹配 XFeat 描述符。

参数

 * `result1` (`dict[str, Any]`): 包含 `keypoints` 和 `descriptors` 的参考结果。
 * `result2` (`dict[str, Any]`): 包含 `keypoints` 和 `descriptors` 的目标结果。
 * `min_cossim` (`float`): 最小描述符余弦相似度；非正值禁用此阈值。

返回

 * `tuple[np.ndarray, np.ndarray]`: 形状为 `(N, 2)` 的参考和目标关键点数组，按对应顺序排列。

### compute_xfeat_result

```python
def compute_xfeat_result(feats: np.ndarray, keypoints: np.ndarray, heatmaps: np.ndarray, *, resize_rate_w: float, resize_rate_h: float, input_size: tuple[int, int], max_keypoints: int) -> list[dict[str, Any]] | None:
```

计算排名的 XFeat 关键点和描述符。

参数

 * `feats` (`np.ndarray`): 批处理的密集特征描述符张量。
 * `keypoints` (`np.ndarray`): 模型关键点张量。
 * `heatmaps` (`np.ndarray`): 模型热图张量。
 * `resize_rate_w` (`float`): 将模型坐标映射到源图像的水平比例因子。
 * `resize_rate_h` (`float`): 将模型坐标映射到源图像的垂直比例因子。
 * `input_size` (`tuple[int, int]`): 模型输入大小，格式为 `(width, height)`。
 * `max_keypoints` (`int`): 每张图像保留的最高得分关键点的最大数量。

返回

 * `list[dict[str, Any]] | None`: 每个批处理项一个结果字典，包含 `keypoints`、`scores` 和 `descriptors`。如果未找到候选关键点，则返回 `None`。

### detect_and_compute

```python
def detect_and_compute(feats: np.ndarray, kpts: np.ndarray, heatmaps: np.ndarray, resize_rate_w: float, resize_rate_h: float, input_size: tuple[int, int], top_k: int = 4096) -> list[dict[str, Any]]:
```

检测并计算关键点。

参数

 * `feats` (`np.ndarray`): 特征。
 * `kpts` (`np.ndarray`): 关键点。
 * `heatmaps` (`np.ndarray`): 热图。
 * `resize_rate_w` (`float`): 宽度的调整大小比例。
 * `resize_rate_h` (`float`): 高度的调整大小比例。
 * `input_size` (`tuple[int, int]`): 输入大小。
 * `top_k` (`int`): 要保留的关键点的最大数量。

返回

 * `list[dict[str, Any]]`: 包含关键点、分数和描述符的字典列表。

### local_maximum_filter

```python
def local_maximum_filter(x: np.ndarray, kernel_size: int) -> np.ndarray:
```

对输入数组应用局部最大值滤波器。

参数

 * `x` (`np.ndarray`): 输入数组。
 * `kernel_size` (`int`): 局部最大值滤波器的大小。

返回

 * `np.ndarray`: 应用局部最大值滤波器后的输出数组。

### match

```python
def match(result1: dict[str, Any], result2: dict[str, Any], min_cossim: float = -1) -> tuple[np.ndarray, np.ndarray]:
```

匹配关键点。

参数

 * `result1` (`dict[str, Any]`): 结果 1。
 * `result2` (`dict[str, Any]`): 结果 2。
 * `min_cossim` (`float`): 最小余弦相似度。

返回

 * `tuple[np.ndarray, np.ndarray]`: 匹配的关键点。

### normgrid

```python
def normgrid(x, H, W):
```

将坐标归一化到 [-1,1]。

参数

 * `x` (`np.ndarray`): 输入坐标，形状 (N, Hg, Wg, 2)
 * `H` (`int`): 输出特征图的高度
 * `W` (`int`): 输出特征图的宽度

返回

 * `np.ndarray`: 归一化坐标，形状 (N, Hg, Wg, 2)
