# coco_parser

Python API: `luxonis_ml.data.parsers.coco_parser`

## 类

### COCOParser

将带有 COCO 注释的目录解析为 LDF。

预期格式：

```text
dataset_dir/
├── train/
│   ├── data/
│   │   ├── img1.jpg
│   │   ├── img2.jpg
│   │   └── ...
│   └── labels.json
├── validation/
│   ├── data/
│   └── labels.json
└── test/
    ├── data/
    └── labels.json

这是使用 FiftyOne 包时返回的默认格式。
```

或：

```text
dataset_dir/
    ├── train/
    │   ├── img1.jpg
    │   ├── img2.jpg
    │   └── ...
    │   └── _annotations.coco.json
    ├── valid/
    └── test/

这是 Roboflow 可以生成的一种格式。
```

#### 方法

##### discover_dir_splits

```python
def discover_dir_splits(dataset_dir: Path) -> dict[str, dict[str, Any]]:
```

返回按其规范拆分名称键入的现有且有效的拆分目录。

##### from_dir

```python
def from_dir(dataset_dir: Path, use_keypoint_ann: bool = False, keypoint_ann_paths: dict[str, str] | None = None, split_val_to_test: bool = True) -> tuple[list[Path], list[Path], list[Path]]:
```

解析源数据集目录中的所有 COCO 拆分。

参数

 * `dataset_dir` (`Path`): 源数据集目录。
 * `use_keypoint_ann` (`bool`): 是否使用单独的 COCO 关键点注释文件用于 FiftyOne 样式数据集。
 * `keypoint_ann_paths` (`dict[str, str] | None`): 关键点注释文件的可选路径，相对于 `dataset_dir` 并按 `"train"`、`"val"` 和 `"test"` 键入。
 * `split_val_to_test` (`bool`): 当没有可用的测试注释时，是否将验证图像 50/50 拆分为验证和测试。

返回

 * `tuple[list[Path], list[Path], list[Path]]`: 训练、验证和测试拆分添加的图像。

引发

 * `ValueError`: 如果数据集目录、训练拆分、验证拆分或现有测试拆分不符合公认的 COCO 布局。

##### from_split

```python
def from_split(image_dir: Path, annotation_path: Path) -> ParserOutput:
```

将 COCO 注释解析为 LDF 记录。

注释包括分类、分割、对象检测和关键点（如果存在）。

该方法还构建骨架元数据。它读取每个包含 `keypoints` 字段和 `skeleton` 字段的类别。它使用 `keypoints` 作为关键点标签，并将 `skeleton` 对转换为边。COCO 从 1
开始对骨架关节进行编号，因此该方法从每个索引中减去 1。

参数

 * `image_dir` (`Path`): 包含图像的目录。
 * `annotation_path` (`Path`): 注释 JSON 文件。

返回

 * `ParserOutput`: 包含注释记录、骨架元数据和添加图像的解析器输出。

##### validate

```python
def validate(dataset_dir: Path) -> bool:
```

验证数据集目录是否具有预期格式。

参数

 * `dataset_dir` (`Path`): 源数据集目录。

返回

 * `bool`: 数据集是否为预期格式。

##### validate_split

```python
def validate_split(split_path: Path) -> dict[str, Any] | None:
```

验证拆分目录是否具有预期格式。

参数

 * `split_path` (`Path`): 拆分目录的路径。

返回

 * `dict[str, Any] | None`: `from_split` 的关键字参数，如果拆分不是预期格式，则为 `None`。

## 函数

### clean_annotations

```python
def clean_annotations(annotation_path: Path) -> Path:
```

删除已知会导致解析问题的 COCO 图像。

参数

 * `annotation_path` (`Path`): 注释 JSON 文件。

返回

 * `Path`: 清理后的注释 JSON 文件的路径。
