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 ImageJ_Demos;
010
011import ij.ImagePlus;
012import ij.plugin.filter.PlugInFilter;
013import ij.process.ImageProcessor;
014import imagingbook.core.jdoc.JavaDocHelp;
015
016/**
017 * This ImageJ plugin shows how a subimage is extracted from a given image using the bounding box of the currently
018 * selected region of interest (ROI). Note that the resulting image is of the same type as the original.
019 *
020 * @author WB
021 * @version 2022/04/01
022 */
023public class Roi_Extract_Subimage_Demo implements PlugInFilter, JavaDocHelp {
024
025        ImagePlus im = null;
026
027        public int setup(String arg, ImagePlus im) {
028                this.im = im;
029                return DOES_ALL + NO_CHANGES;
030        }
031
032        public void run(ImageProcessor ip) {
033                // The ROI obtained from ImageProcessor always exists even without a user selection.
034                // It is a rectangle with int coordinates.
035                // By default (no user selection) the ROI contains the whole image.
036                // Rectangle roi = ip.getRoi();
037                ImageProcessor ip2 = ip.crop();         // extracts the subimage defined by the ROI
038                new ImagePlus(im.getShortTitle() + "-extracted", ip2).show();
039        }
040}