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 Ch25_SIFT;
010
011import ij.ImagePlus;
012import ij.gui.GenericDialog;
013import ij.plugin.filter.PlugInFilter;
014import ij.process.FloatProcessor;
015import ij.process.ImageProcessor;
016import imagingbook.common.ij.DialogUtils;
017import imagingbook.common.sift.SiftDetector;
018import imagingbook.common.sift.scalespace.DogScaleSpace;
019import imagingbook.common.sift.scalespace.GaussianScaleSpace;
020import imagingbook.core.jdoc.JavaDocHelp;
021import imagingbook.core.resource.ImageResource;
022import imagingbook.sampleimages.GeneralSampleImage;
023
024import static imagingbook.common.ij.IjUtils.noCurrentImage;
025
026/**
027 * <p>
028 * This ImageJ plugin visualizes the hierarchical scale space structures used for SIFT feature detection (see
029 * {@link SiftDetector}). Optionally the Gaussian scale space or the derived DoG scale space (or both) are shown. Each
030 * scale space octave is displayed as an image stack, with one frame for each scale level. See Ch. 25 of [1] for
031 * details.
032 * </p>
033 * <p>
034 * [1] W. Burger, M.J. Burge, <em>Digital Image Processing &ndash; An Algorithmic Introduction</em>, 3rd ed, Springer
035 * (2022).
036 * </p>
037 *
038 * @author WB
039 * @version 2022/11/23
040 */
041public class Show_Scale_Space implements PlugInFilter, JavaDocHelp {
042
043        private static ImageResource SampleImage = GeneralSampleImage.Castle;
044        private static boolean ShowGaussianScaleSpace = true;
045        private static boolean ShowDoGScaleSpace = false;
046        
047        /**
048         * Constructor, asks to open a predefined sample image if no other image is currently open.
049         */
050        public Show_Scale_Space() {
051                if (noCurrentImage()) {
052                        DialogUtils.askForSampleImage(SampleImage);
053                }
054        }
055        
056        // ---------------------------------------------------
057
058        @Override
059        public int setup(String arg0, ImagePlus arg1) {
060                return DOES_8G + DOES_32 + NO_CHANGES;
061        }
062        
063        @Override
064        public void run(ImageProcessor ip) {
065                if (!runDialog()) {
066                        return;
067                }
068                
069                if (!ShowGaussianScaleSpace && !ShowDoGScaleSpace) {
070                        return;
071                }
072                
073                FloatProcessor fp = (FloatProcessor) ip.convertToFloat();
074                SiftDetector detector = new SiftDetector(fp);
075                if (ShowGaussianScaleSpace) {
076                        GaussianScaleSpace gss = detector.getGaussianScaleSpace();
077                        ImagePlus[] images = gss.getImages("Gaussian");
078                        for (ImagePlus im : images) {
079                                im.show();
080                        }
081                }
082                
083                if (ShowDoGScaleSpace) {
084                        DogScaleSpace dss = detector.getDogScaleSpace();
085                        ImagePlus[] images = dss.getImages("DoG");
086                        for (ImagePlus im : images) {
087                                im.show();
088                        }
089                }
090        }
091        
092        // ---------------------------
093        
094        private boolean runDialog() {
095                GenericDialog gd = new GenericDialog(this.getClass().getSimpleName());
096                gd.addHelp(getJavaDocUrl());
097                gd.addCheckbox("Show Gaussian scale space)", ShowGaussianScaleSpace);
098                gd.addCheckbox("Show DoG scale space)", ShowDoGScaleSpace);
099                
100                gd.showDialog();
101                if (gd.wasCanceled()) {
102                        return false;
103                }
104                
105                ShowGaussianScaleSpace = gd.getNextBoolean();
106                ShowDoGScaleSpace = gd.getNextBoolean();
107                return true;
108        }
109
110
111}