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 data can be communicated from one plugin to another. In this example, THIS plugin
018 * ({@link Data_Transfer_Plugin_Producer}) calculates a histogram that is subsequently retrieved by ANOTHER plugin
019 * {@link Data_Transfer_Plugin_Consumer}. Data are stored as a <strong>property</strong> of the associated image (of
020 * type {@link ImagePlus}). Note that the stored data should contain no instances of self-defined classes, since these
021 * may be re-loaded when performing compile-and-run.
022 *
023 * @author WB
024 */
025public class Data_Transfer_Plugin_Producer implements PlugInFilter, JavaDocHelp {
026        
027        // Create a unique (publicly visible) property key:
028        public static final String HistKey = 
029                        Data_Transfer_Plugin_Producer.class.getCanonicalName() + "histogram";
030        
031        ImagePlus im;
032        
033        public int setup(String arg, ImagePlus im) {
034                this.im = im;
035                return DOES_ALL + NO_CHANGES;}
036                
037        public void run(ImageProcessor ip) {
038                int[] hist = ip.getHistogram();
039                // add histogram to image properties:
040                im.setProperty(HistKey, hist);
041        }
042}