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 Ch09_Automatic_Thresholding;
010
011import ij.IJ;
012import ij.ImagePlus;
013import ij.plugin.filter.PlugInFilter;
014import ij.process.ByteProcessor;
015import ij.process.ImageProcessor;
016import imagingbook.common.threshold.global.GlobalThresholder;
017import imagingbook.common.threshold.global.QuantileThresholder;
018import imagingbook.core.jdoc.JavaDocHelp;
019import imagingbook.sampleimages.GeneralSampleImage;
020
021import static imagingbook.common.ij.DialogUtils.askForSampleImage;
022import static imagingbook.common.ij.IjUtils.noCurrentImage;
023import static java.lang.Float.isFinite;
024
025/**
026 * <p>
027 * ImageJ plugin showing the use of the {@link QuantileThresholder} class.
028 * See Sec. 9.1 of [1] for additional details.
029 * </p>
030 * <p>
031 * [1] W. Burger, M.J. Burge, <em>Digital Image Processing &ndash; An Algorithmic Introduction</em>,
032 * 3rd ed, Springer (2022).
033 * </p>
034 * 
035 * @author WB
036 * @version 2022/04/02
037 * @see imagingbook.common.threshold.global.QuantileThresholder
038 */
039public class Global_Quantile implements PlugInFilter, JavaDocHelp {
040        
041        private static double quantile = 0.2;
042
043        /**
044         * Constructor, asks to open a predefined sample image if no other image
045         * is currently open.
046         */
047        public Global_Quantile() {
048                if (noCurrentImage()) {
049                        askForSampleImage(GeneralSampleImage.Kepler);
050                }
051        }
052        
053        @Override
054        public int setup(String arg, ImagePlus imp) {
055                return DOES_8G;
056        }
057        
058        @Override
059        public void run(ImageProcessor ip) {
060                ByteProcessor bp = (ByteProcessor) ip;
061                
062                quantile = IJ.getNumber("Black quantile (0 < p < 1)", quantile);
063                if (quantile < 0.01) quantile = 0.01;
064                if (quantile > 0.99) quantile = 0.99;
065                
066                GlobalThresholder thr = new QuantileThresholder(quantile);
067                float q = thr.getThreshold(bp);
068
069                if (isFinite(q)) {
070                        bp.threshold(Math.round(q));
071                }
072                else {
073                        IJ.showMessage("no threshold found");
074                }
075
076        }
077}