Awesome

Demo Plugin

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

Version: 0.1

Author: YXDragon

Email: yxdragon@imagepy.org

Keyword: demo, tutorial

Description: a friendly development tutorial.

English Document | 中文文档

This is a demo project to show How to write ImagePy plugin. Including the usage of all kinds of plugin, with document wrote in detail. Developers can take this project as example.

Install

ImagePy Menu：Plugins > Manager > Plugins Manager input demo, and select the Demo Plugin, then click Install/Update. When complete the installing, the user interface would be changed. New plugins' menu, tool, and widget would be loaded in place.

Basic

Start here

1. What is plugin
2. Hello World（my first plugin）
3. Who Are You（interactive）
4. Questionnaire（parameter dialog in detail）
5. Multi plugin in one file

Plugin development

Markdown: document

1. Markdown Demo

Macros: serialise existing function

1. Gaussian blur - Invert
2. Coins Segmentation Macros

Workflow: interactive macros

1. Coins Segment Workflow

Report: generate report

1. Personal Information
2. Coins Report: report for coins segment
3. Rule of Report design

Filter: image filter in 2d

1. Invert Demo: without parameter
2. Gaussian Demo: with parameter
3. Filter operating mechanism

Simple: treat sequence and other attributes

1. Gaussian 3D Demo: filter in 3d
2. Red Lut Demo: operate color lookup table
3. ROI Inflate Demo: operate ROI
4. Unit Demo: set unit and scale
5. Draw Mark Demo: Set Mark
6. Simple operating mechanism

Table: treat dataframe

1. Generate Table Demo: generate table
2. Sort By Key Demo: sort
3. Table Plot Demo: plot
4. Table operation mechanism

Free: depend on nothing

1. New Image Demo: creat image
2. About Demo: the about dialog
3. Close Demo: quit program
4. Free operating mechanism

Tool: mouse interaction

1. Painter Demo: draw with mouse
2. Tool operating mechanism

Widget: customed panel

1. Widget Demo
2. Widget opterating mechanism

Plugin Release

Function Organization

1. Functional partitioning
2. Set Order

Plugin project creation

1. Create a plugin project repository
2. Write requirements
3. Write readme
4. Install Plugin

Release to ImagePy

1. Send Pull Request to ImagePy
2. About the top-level menu

Write Document

Write The Opteration Manual

View The Operation Manual

Attention

User Friendliness

Developer Friendliness

Communicate Timely

This document introduces how to write ImagePy plugin. More questions not exhaustive here，please post in forum.Image.sc