Image Shape Filter

---
name: image_shape_filter
description: |
  图像形状过滤器。过滤器保持样品的图像形状 (w，h) 在特定范围内。
  本SKILL使用依赖data_juicer，请在调用前安装好python环境并安装data_juicer，你可用以下指令进行安装：
  pip install py-data-juicer
  
  当用户提到图像尺寸过滤、图片宽高筛选、图像分辨率过滤、按图片大小过滤、图像形状限制等需求时使用此skill。

name_zh: 图像形状过滤器算子
input_params:
  - name: input_path
    type: string
    required: true
    description: 输入数据文件路径（JSON/JSONL格式）

  - name: output_path
    type: string
    required: true
    description: 输出数据文件路径（JSONL格式）

  - name: min_width
    type: int
    required: false
    default: 1
    description: 最小图像宽度

  - name: max_width
    type: int
    required: false
    default: 2147483647
    description: 最大图像宽度

  - name: min_height
    type: int
    required: false
    default: 1
    description: 最小图像高度

  - name: max_height
    type: int
    required: false
    default: 2147483647
    description: 最大图像高度

  - name: any_or_all
    type: string
    required: false
    default: any
    description: 过滤策略（any/all）

  - name: num_proc
    type: int
    required: false
    default: 1
    description: 并行处理的进程数

output_params:
  - name: output_path
    type: jsonl_file
    description: 过滤后的JSONL文件，包含图像尺寸在指定范围内的样本
tag: 数据筛选
publisher: COMMUNITY
---

## 功能概述

该算子用于过滤图像尺寸（宽度和高度）在指定范围内的样本。支持多种过滤策略：
- `any`: 任意一张图像符合条件即保留
- `all`: 所有图像都符合条件才保留

## 核心参数

| 参数 | 类型 | 必填 | 默认值 | 说明 |
|------|------|------|--------|------|
| input_path | string | 是 | - | 输入数据文件路径 (JSON/JSONL格式) |
| output_path | string | 是 | - | 输出数据文件路径 (JSONL格式) |
| min_width | int | 否 | 1 | 最小图像宽度 |
| max_width | int | 否 | 2147483647 | 最大图像宽度 |
| min_height | int | 否 | 1 | 最小图像高度 |
| max_height | int | 否 | 2147483647 | 最大图像高度 |
| any_or_all | string | 否 | 'any' | 过滤策略：'any' 或 'all' |
| num_proc | int | 否 | 1 | 并行处理的进程数 |

## 输入数据格式

输入文件应为 JSON 或 JSONL 格式，每行包含一个样本，样本需包含 `images` 字段：

```json
{"images": ["/path/to/image1.jpg", "/path/to/image2.jpg"]}
```

## 输出数据格式

输出为 JSONL 格式，每行一个符合条件的样本。

## 使用示例

### 命令行调用

```bash
python scripts/run_image_shape_filter.py \
  --input_path /path/to/input.jsonl \
  --output_path /path/to/output.jsonl \
  --min_width 400 \
  --min_height 400 \
  --any_or_all any
```

### 参数说明

- `--input_path`: 输入文件路径
- `--output_path`: 输出文件路径  
- `--min_width`: 最小图像宽度（默认1）
- `--max_width`: 最大图像宽度（默认无限）
- `--min_height`: 最小图像高度（默认1）
- `--max_height`: 最大图像高度（默认无限）
- `--any_or_all`: 过滤策略，默认any
- `--num_proc`: 并行进程数，默认1

## 注意事项

1. 输入文件中的图像路径应为有效且可访问的文件路径
2. 该算子使用 PIL/Pillow 读取图像尺寸，无需加载模型
3. 处理大量数据时可适当增加 num_proc 提高效率