001/*******************************************************************************
002 * This software is provided as a supplement to the authors' textbooks on digital
003 * image processing published by Springer-Verlag in various languages and editions.
004 * Permission to use and distribute this software is granted under the BSD 2-Clause
005 * "Simplified" License (see http://opensource.org/licenses/BSD-2-Clause).
006 * Copyright (c) 2006-2023 Wilhelm Burger, Mark J. Burge. All rights reserved.
007 * Visit https://imagingbook.com for additional details.
008 ******************************************************************************/
009
010package Ch08_Binary_Regions;
011
012import ij.IJ;
013import ij.ImagePlus;
014import ij.gui.GenericDialog;
015import ij.plugin.filter.PlugInFilter;
016import ij.process.ByteProcessor;
017import ij.process.ImageProcessor;
018import imagingbook.common.color.sets.BasicAwtColor;
019import imagingbook.common.geometry.hulls.ConvexHull;
020import imagingbook.common.ij.DialogUtils;
021import imagingbook.common.ij.IjUtils;
022import imagingbook.common.ij.overlay.ColoredStroke;
023import imagingbook.common.ij.overlay.ShapeOverlayAdapter;
024import imagingbook.common.regions.BinaryRegion;
025import imagingbook.common.regions.RegionContourSegmentation;
026import imagingbook.core.plugin.IjPluginName;
027import imagingbook.core.jdoc.JavaDocHelp;
028import imagingbook.sampleimages.GeneralSampleImage;
029
030import java.util.List;
031
032import static imagingbook.common.ij.IjUtils.noCurrentImage;
033
034/**
035 * <p>
036 * This ImageJ plugin demonstrates the use of the {@link ConvexHull} class. See Sec. 8.4.2 of [1] for additional
037 * details. It performs region segmentation, calculates the convex hull for each region found and then displays the
038 * result in a new image. Requires a binary image. Zero-value pixels are considered background, all other pixels are
039 * foreground. Display lookup tables (LUTs) are not considered. The resulting convex hull is shown as a vector overlay
040 * on top of a new image, the original image is not modified. If no image is currently open, the plugin optionally loads
041 * a suitable sample image.
042 * </p>
043 * <p>
044 * [1] W. Burger, M.J. Burge, <em>Digital Image Processing &ndash; An Algorithmic Introduction</em>, 3rd ed, Springer
045 * (2022).
046 * </p>
047 *
048 * @author WB
049 * @version 2022/06/24
050 */
051@IjPluginName("Convex Hull Demo")
052public class Convex_Hull_Demo implements PlugInFilter, JavaDocHelp {
053        
054        /** Color of the convex hull outline. */
055        public static BasicAwtColor DrawingColor = BasicAwtColor.Blue;
056        public static double StrokeWidth = 0.5;
057        
058        private ImagePlus im = null;
059        
060        /**
061         * Constructor, asks to open a predefined sample image if no other image
062         * is currently open.
063         */
064        public Convex_Hull_Demo() {
065                if (noCurrentImage()) {
066                        DialogUtils.askForSampleImage(GeneralSampleImage.ToolsSmall);
067                }
068        }
069        
070        @Override
071        public int setup(String arg, ImagePlus im) {
072                this.im = im;
073                return DOES_8G; 
074        }
075        
076        @Override
077        public void run(ImageProcessor ip) {
078                if (!IjUtils.isBinary(ip)) {
079                        IJ.showMessage("Plugin requires a binary image!");
080                        return;
081                }
082
083                if (!runDialog())
084                        return;
085
086                RegionContourSegmentation segmenter = new RegionContourSegmentation((ByteProcessor) ip);
087                
088                List<BinaryRegion> regions = segmenter.getRegions();
089                if (regions.isEmpty()) {
090                        IJ.error("No regions detected!");
091                        return;
092                }
093                
094                ImageProcessor ip2 = ip.duplicate();
095                ip2.add(128);
096                
097                // draw convex hulls as vector overlay
098                ShapeOverlayAdapter ola = new ShapeOverlayAdapter();
099                ola.setStroke(new ColoredStroke(StrokeWidth, DrawingColor.getColor()));
100                
101                for (BinaryRegion r: regions) {
102                        //ConvexHull hull = new ConvexHull(r);                                  // takes all region points
103                        ConvexHull hull = new ConvexHull(r.getOuterContour());  // takes only outer contour points
104                        ola.addShapes(hull.getShapes());
105                }
106
107                im.setOverlay(ola.getOverlay());
108        }
109
110
111        // --------------------------------------------------------------------------
112
113        private boolean runDialog() {
114                GenericDialog gd = new GenericDialog(Region_Contours_Demo.class.getSimpleName());
115                gd.addHelp(getJavaDocUrl());
116                gd.addEnumChoice("Drawing color", DrawingColor);
117                gd.addNumericField("Stroke width", StrokeWidth, 1);
118
119                gd.showDialog();
120                if (gd.wasCanceled()) {
121                        return false;
122                }
123
124                DrawingColor = gd.getNextEnumChoice(BasicAwtColor.class);
125                StrokeWidth = gd.getNextNumber();
126                return true;
127        }
128}