# segmentation_mask_directory_parser

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

## 类

### SegmentationMaskDirectoryParser

将带有分割掩码注释的目录解析为 LDF。

预期格式：

```text
dataset_dir/
├── train/
│   ├── img1.jpg
│   ├── img1_mask.png
│   ├── ...
│   └── _classes.csv
├── valid/
└── test/
```

`_classes.csv` 将像素值映射到类名：

```text
Pixel Value, Class
0, background
1, class1
2, class2
```

解析器只读取类名列。该列必须命名为 `" Class"`，带有一个前导空格，这是 Roboflow 写入的标题。像素值列的名称无关紧要，因为解析器从不读取它。行顺序给出像素值，因此第一行描述像素值 0。

解析器不会删除类名中的空格。行 `0, background` 给出类名 `" background"`，带有一个前导空格。

解析器将每个掩码读取为 8 位灰度图像。每个不同的像素值成为一个类。解析器从类名列的该行中获取类名。

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

#### 方法

##### from_dir

```python
def from_dir(dataset_dir: Path) -> tuple[list[Path], list[Path], list[Path]]:
```

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

参数

 * `dataset_dir` (`Path`): 源数据集目录。
 * `**kwargs`: 其他解析器特定参数。

返回

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

##### from_split

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

将分割掩码注释解析为 LDF 记录。

注释包括分类和分割。

参数

 * `image_dir` (`Path`): 包含图像的目录。
 * `seg_dir` (`Path`): 包含分割掩码的目录。
 * `classes_path` (`Path`): 包含类名的 CSV 文件。

返回

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

##### validate_split

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

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

参数

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

返回

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