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 Ch17_EdgePreserving_Smoothing;
010
011import ij.ImagePlus;
012import ij.plugin.filter.PlugInFilter;
013import ij.process.ColorProcessor;
014import ij.process.ImageProcessor;
015import imagingbook.common.filter.edgepreserving.PeronaMalikF.ColorMode;
016import imagingbook.common.filter.edgepreserving.PeronaMalikF.Parameters;
017import imagingbook.common.filter.edgepreserving.PeronaMalikFilterScalar;
018import imagingbook.common.filter.edgepreserving.PeronaMalikFilterVector;
019import imagingbook.common.filter.generic.GenericFilter;
020import imagingbook.common.ij.DialogUtils;
021import imagingbook.core.jdoc.JavaDocHelp;
022import imagingbook.sampleimages.GeneralSampleImage;
023
024import static imagingbook.common.ij.IjUtils.noCurrentImage;
025
026/**
027 * This ImageJ plugin is a minimal example for running the Perona-Malik filter [1]. See Sec. 17.3 of [2] for additional
028 * details. This plugin works for all types of images and stacks.
029 * <p>
030 * [1] Pietro Perona and Jitendra Malik, "Scale-space and edge detection using anisotropic diffusion", IEEE Transactions
031 * on Pattern Analysis and Machine Intelligence, vol. 12, no. 4, pp. 629-639 (July 1990).
032 * <br>
033 * [2] W. Burger, M.J. Burge, <em>Digital Image Processing &ndash; An Algorithmic Introduction</em>, 3rd ed, Springer
034 * (2022).
035 * </p>
036 *
037 * @author WB
038 * @version 2022/12/12
039 * @see PeronaMalikFilterScalar
040 * @see PeronaMalikFilterVector
041 * @see GenericFilter
042 */
043public class Perona_Malik_Minimal implements PlugInFilter, JavaDocHelp {
044
045        /**
046         * Constructor, asks to open a predefined sample image if no other image is currently open.
047         */
048        public Perona_Malik_Minimal() {
049                if (noCurrentImage()) {
050                        DialogUtils.askForSampleImage(GeneralSampleImage.Postcard2c);
051                }
052        }
053
054        @Override
055        public int setup(String arg0, ImagePlus imp) {
056                return DOES_ALL;
057        }
058
059        @Override
060        public void run(ImageProcessor ip) {
061                // create a parameter object, modify settings if needed:
062                Parameters params = new Parameters();
063                params.iterations = 20;
064                params.alpha = 0.15;
065                params.kappa = 20.0;
066                params.colorMode = ColorMode.ColorGradient;
067
068                // create the actual filter:
069                GenericFilter filter = (ip instanceof ColorProcessor) ?
070                        new PeronaMalikFilterVector(params) :
071                        new PeronaMalikFilterScalar(params);
072                
073                // apply the filter:
074                filter.applyTo(ip);
075        }
076}
077
078
079