READMECN.md

Demo Plugin

Path: https://github.com/Image-Py/demoplugin

Version: 0.1

Author: YXDragon

Email: [email protected]

Keyword: demo, tutorial

Description: a friendly develop tutorial.

English Document | 中文文档

这是一个ImagePy插件项目，里面覆盖了各类插件的编写方法和用法，并配有详细的文档，ImagePy的插件开发者可以以此为参考

安装

ImagePy菜单：Plugins > Manager > Plugins Manager 在输入框内输入demo进行查询，选中Demo Plugin，点击Install，完成后菜单栏出现Demo菜单，工具栏会加入Demo工具，组件栏也会加入Demo组件。

Install DemoPlugin

基础预备

从这里开始

1. 什么是插件
2. Hello World（第一个插件）
3. Who Are You（带有交互）
4. Questionnaire（参数对话框详解）
5. 一个文件内实现多个插件

插件开发

Markdown: 文档提示

1. Markdown Demo

Macros: 用宏串联已有功能

1. 高斯模糊再求反
2. Coins Segment Macros：硬币分割

Workflow: 可交互的宏

1. Coins Segment Workflow：按照指引进行硬币分割

Report: 生成报表

1. Personal Information：填写个人信息
2. Coins Report：硬币分割成果
3. Report 插件的设计原则

Filter: 二维图像滤波器

1. Invert Demo：无参数的插件
2. Gaussian Demo：带有参数的插件
3. Filter 的运行机制

Simple: 图像整体操作

1. Gaussian 3D Demo：三维滤波
2. Red Lut Demo：设定索引色
3. ROI Inflate Demo：操作ROI
4. Unit Demo: 设置比例尺及单位
5. Draw Mark Demo: 设置Overlay Mark
6. Simple 的运行机制

Table: 表格数据

1. Generate Table Demo：数据表生成
2. Sort By Key Demo：排序
3. Table Plot Demo：绘图
4. Table 运行机制

Free: 没有任何依赖的插件

1. New Image Demo: 创建图像
2. About Demo：关于对话框
3. Close Demo：退出软件
4. Free 的运行机制

Tool: 鼠标交互工具

1. Painter Demo：画笔工具
2. Tool的运行机制

Widget: 桌面小部件

1. Widget Demo：桌面小部件演示
2. Tool的运行机制

插件项目发布

插件的组织方式

1. 功能划分
2. 顺序设定

插件项目创建

1. 创建插件项目仓库
2. 编写requirements
3. 编写readme
4. 插件的安装

发布到 ImagePy

1. 给ImagePy发Pull Request
2. 关于顶级菜单

文档编写

编写操作手册

查阅操作手册

注意事项

用户友好性

开发者友好性

及时沟通

本篇文档相对系统的介绍了ImagePy的插件开发，但是依然无法详尽，关于更多ImagePy使用，开发上的问题请在forum.Image.sc行进行讨论