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 ******************************************************************************/
009package Ch12_Ransac_Hough;
010
011import Ch12_Ransac_Hough.settings.RansacDrawSettings;
012import ij.IJ;
013import ij.ImagePlus;
014import ij.gui.GenericDialog;
015import ij.plugin.ImagesToStack;
016import ij.plugin.filter.PlugInFilter;
017import ij.process.ByteProcessor;
018import ij.process.ImageProcessor;
019import imagingbook.common.geometry.basic.Pnt2d;
020import imagingbook.common.geometry.circle.GeometricCircle;
021import imagingbook.common.ij.DialogUtils;
022import imagingbook.common.ij.IjUtils;
023import imagingbook.common.ij.overlay.ColoredStroke;
024import imagingbook.common.ij.overlay.ShapeOverlayAdapter;
025import imagingbook.common.ransac.RansacCircleDetector;
026import imagingbook.common.ransac.RansacResult;
027import imagingbook.core.jdoc.JavaDocHelp;
028import imagingbook.sampleimages.GeneralSampleImage;
029
030import java.util.ArrayList;
031import java.util.List;
032
033import static imagingbook.common.ij.DialogUtils.addToDialog;
034import static imagingbook.common.ij.DialogUtils.getFromDialog;
035import static imagingbook.common.ij.IjUtils.noCurrentImage;
036
037/**
038 * <p>
039 * RANSAC circle detection implemented with imagingbook library class {@link RansacCircleDetector} (see Sec. 12.1.4 of
040 * [1] for details). If no image is currently open, the plugin optionally loads a suitable sample image.
041 * </p>
042 * <p>
043 * [1] W. Burger, M.J. Burge, <em>Digital Image Processing &ndash; An Algorithmic Introduction</em>, 3rd ed, Springer
044 * (2022).
045 * </p>
046 *
047 * @author WB
048 * @version 2022/10/03
049 */
050public class Ransac_Circle_Detect implements PlugInFilter, RansacDrawSettings, JavaDocHelp {
051
052        private static RansacCircleDetector.Parameters params = new RansacCircleDetector.Parameters();
053        static {
054                params.randomSeed = 17;
055        }
056        
057        private static int MaxCircleCount = 3;
058        
059        private int W, H;
060        private ImagePlus im;
061        private String title;
062
063        /**
064         * Constructor, asks to open a predefined sample image if no other image
065         * is currently open.
066         */
067        public Ransac_Circle_Detect() {
068                if (noCurrentImage()) {
069                        DialogUtils.askForSampleImage(GeneralSampleImage.NoisyCircles);
070                }
071        }
072        
073        // -------------------------------------------------------------------------
074
075        
076        @Override
077        public int setup(String arg, ImagePlus im) {
078                this.im = im;
079                return DOES_8G + NO_CHANGES;
080        }
081
082        @Override
083        public void run(ImageProcessor ip) {
084                title = "Circles from " + im.getTitle();
085                W = ip.getWidth();
086                H = ip.getHeight();     
087                
088                if (!runDialog()) {
089                        return;
090                }
091        
092                Pnt2d[] points = IjUtils.collectNonzeroPoints(ip);
093                List<RansacResult<GeometricCircle>> circles = new ArrayList<>();
094
095                // ---------------------------------------------------------------------
096                RansacCircleDetector detector = new RansacCircleDetector(params);
097                // ---------------------------------------------------------------------
098                
099                List<ImagePlus> resultImages = new ArrayList<>();
100                int cnt = 0;
101
102                RansacResult<GeometricCircle> sol = detector.detectNext(points);
103                while (sol != null && cnt < MaxCircleCount) {
104                        circles.add(sol);
105                        cnt = cnt + 1;
106                        
107                        ImagePlus imSnap = new ImagePlus("circle-"+cnt, showPointSet(points));
108                        ShapeOverlayAdapter ola = new ShapeOverlayAdapter();
109                        
110                        {       // draw inliers (points)
111                                ColoredStroke stroke = new ColoredStroke(LineStrokeWidth, InlierColor, 0);
112                                stroke.setFillColor(InlierColor);
113                                for (Pnt2d p : sol.getInliers()) {
114                                        ola.addShape(p.getShape(InlierRadius), stroke);
115                                }
116                        }
117        
118                        {       // draw initial circle
119                                GeometricCircle circle = sol.getPrimitiveInit();
120                                ColoredStroke stroke = new ColoredStroke(LineStrokeWidth, InitialFitColor, 0);
121                                ola.addShape(circle.getShape(), stroke);
122                        }
123        
124                        {       // draw final circle
125                                GeometricCircle circle = sol.getPrimitiveFinal();
126                                ColoredStroke stroke = new ColoredStroke(LineStrokeWidth, FinalFitColor, 0);
127                                ola.addShape(circle.getShape(), stroke);
128                        }
129        
130                        {       // draw the 3 random points used
131                                ColoredStroke stroke = new ColoredStroke(LineStrokeWidth, RandomDrawDotColor, 0);
132                                stroke.setFillColor(RandomDrawDotColor);
133                                for (Pnt2d p : sol.getDraw()) {
134                                        ola.addShape(p.getShape(RandoDrawDotRadius), stroke);
135                                }
136                        }
137
138                        imSnap.setOverlay(ola.getOverlay());
139                        resultImages.add(imSnap);
140                        sol = detector.detectNext(points);
141                }
142
143                // combine all result images to a stack:
144                if (resultImages.isEmpty()) {
145                        IJ.error("No items detected!");
146                }
147                else {
148                        ImagePlus stack = ImagesToStack.run(resultImages.toArray(new ImagePlus[0]));
149                        stack.setTitle(title);
150                        stack.show();
151                }
152                
153                List.of(1,2,3,4);
154        }
155
156        // ------------------------------------------------------
157        
158        private ByteProcessor showPointSet(Pnt2d[] points) {
159                ByteProcessor bp = new ByteProcessor(W, H);
160                IjUtils.drawPoints(bp, points, 255);
161                bp.invertLut();
162                return bp;
163        }
164        
165        private boolean runDialog() {
166                GenericDialog gd = new GenericDialog(this.getClass().getSimpleName());
167                gd.addHelp(getJavaDocUrl());
168                addToDialog(params, gd);
169                gd.addNumericField("Max. number of circles", MaxCircleCount);
170                
171                gd.addStringField("Output title", title, 16);
172                
173                gd.showDialog();
174                if (gd.wasCanceled())
175                        return false;
176                
177                getFromDialog(params, gd);
178                MaxCircleCount = (int) gd.getNextNumber();
179                title = gd.getNextString();
180                
181                return params.validate();
182        }
183}