Skip to content

Commit

Permalink
prepare for release
Browse files Browse the repository at this point in the history
  • Loading branch information
dlegland committed May 17, 2023
1 parent e4f3e13 commit 1292905
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 16 deletions.
32 changes: 17 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
# imagej-plugin-template
Simple project template for creating ImageJ Plugins.
# Label Map To Polygon
Simple plugin for ImageJ that converts a label map into a collection of ROIs integrated
into the RoiManager.

The aim is to provide a quick way to start a plugin for ImageJ, using the "legacy" plugin style.

The project is based on maven. It uses sci-java as parent configuration. The parent configuration
is somewhat old (1.126), but I encountered configuration troubles with more recent ones.

The base configuration has few dependencies:
The plugin has few dependencies:

* ImageJ
* JUnit
* JUnit (only for tests)
* MorphoLibJ (for representation of polygons)


## Installation

Simply clone the project into the directory of your choice.
Then you can edit the pom.xml with informations specific to the project.
In particular, the name of the project is used by the Eclipse IDE to index
the project.
Simply add the jar file into the "plugins" directory of ImageJ or Fiji.
Then a new option "Region Boundary Polygons" is available in the
"Plugins -> LabelMaps Utils" menu.

The plugins displays a dialog that allows to choose the connectivity to use
(can be either 4 or 8), and the pattern of the names of the regions to create.
Default name pattern is "r%03d", generating region names like "r000", "r001"...
When a given region is bounded by several boundaries (regions with holes,
or regions with multiple disconnected parts), names are suffixed by the
boundary index: "r023-0", "r023-1".

A sample plugin file is provided in `src/main/java/net.ijt/DemoPlugin.java` file.
The plugin configuration file is in `src/main/resources/plugins.config`.
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd">
<artifactId>Labels_To_Polygons</artifactId>
<!-- Good practice are to use semantic versioning, -->
<!-- and to remove the "-SNAPSHOT" suffix before releasing new version' -->
<version>0.0.1-SNAPSHOT</version>
<version>1.0.0</version>
<!-- The name of the project at it will appear in IDE or during compilation -->
<!-- (may be different from artifactID) -->
<name>Labels_To_Polygons</name>
Expand Down

0 comments on commit 1292905

Please sign in to comment.