Metadata-Version: 2.2
Name: imaris-cooker
Version: 0.1.1
Summary: A tool for converting IMS format images to TIFF format
Author: Guanhao Sun
License: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: h5py
Requires-Dist: numpy
Requires-Dist: tifffile
Requires-Dist: tqdm
Dynamic: requires-python

# imarisCooker

## 项目简介

imarisCooker是一个用于将Imaris软件的IMS格式文件转换为TIFF格式的工具。该工具支持多通道图像处理，可以选择性地转换特定通道的数据。

## 安装说明

```bash
pip install imaris-cooker
```

## 使用方法

### 命令行参数

```bash
# bash
imaris-cooker <file_path> [-save_path SAVE_PATH] [-specify_channel SPECIFY_CHANNEL]
```
### Python
```python
# python
import imaris_cooker
file_path = 'your .ims file path'
save_path = 'export .tiff file path'
specify_channel = [0,2] # specify channel index, None to extract all channel.
imaris_cooker.convert_ims_to_tiff(file_path,save_path,specify_channel)
```

参数说明：

- `file_path`：必需参数，指定IMS文件的路径
- `-save_path`：可选参数，指定TIFF文件的保存路径，默认为IMS文件所在目录下的`tiff`文件夹
- `-specify_channel`：可选参数，指定需要转换的通道索引，多个通道用逗号分隔，例如：0,1,3 或 1,3

### 示例

```bash
# bash
# 转换所有通道
imaris-cooker D:\data\sample.ims

# 转换指定通道并指定保存路径
imaris-cooker D:\data\sample.ims -save_path D:\output -specify_channel 0,2
```

```python
# python
import imaris_cooker

# 转换所有通道
imaris_cooker.convert_ims_to_tiff(r'D:\data\sample.ims')

# 转换指定通道并指定保存路径
imaris_cooker.convert_ims_to_tiff(r'D:\data\sample.ims',r'D:\data\out', [0, 2])
```
## 注意事项

- 输入文件必须是.ims格式
- 对于大型文件，转换过程可能需要较长时间
