script.imglib.analysis.Histogram.java Source code

Java tutorial

Introduction

Here is the source code for script.imglib.analysis.Histogram.java

Source

/*
 * #%L
 * ImgLib: a general-purpose, multidimensional image processing library.
 * %%
 * Copyright (C) 2009 - 2013 Stephan Preibisch, Tobias Pietzsch, Barry DeZonia,
 * Stephan Saalfeld, Albert Cardona, Curtis Rueden, Christian Dietz, Jean-Yves
 * Tinevez, Johannes Schindelin, Lee Kamentsky, Larry Lindsey, Grant Harris,
 * Mark Hiner, Aivar Grislis, Martin Horn, Nick Perry, Michael Zinsmaier,
 * Steffen Jaensch, Jan Funke, Mark Longair, and Dimiter Prodanov.
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 2 of the 
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public 
 * License along with this program.  If not, see
 * <http://www.gnu.org/licenses/gpl-2.0.html>.
 * #L%
 */

package script.imglib.analysis;

import java.awt.BasicStroke;
import java.awt.Color;
import java.util.ArrayList;
import java.util.TreeMap;

import javax.swing.JFrame;

import mpicbg.imglib.cursor.Cursor;
import mpicbg.imglib.image.Image;
import mpicbg.imglib.image.display.Display;
import mpicbg.imglib.type.numeric.RGBALegacyType;
import mpicbg.imglib.type.numeric.RealType;

import org.jfree.chart.ChartFactory;
import org.jfree.chart.ChartPanel;
import org.jfree.chart.JFreeChart;
import org.jfree.chart.plot.PlotOrientation;
import org.jfree.chart.plot.XYPlot;
import org.jfree.chart.renderer.xy.StandardXYBarPainter;
import org.jfree.chart.renderer.xy.XYBarRenderer;
import org.jfree.data.statistics.HistogramDataset;
import org.jfree.data.statistics.HistogramType;

import script.imglib.algorithm.fn.AlgorithmUtil;

/** An histogram of the image (or an image computed from an IFunction)
 * between its minimum and maximum values,
 * with as many bins as desired (defaults to 256 bins).
 * 
 * The number of bins is then the {@link Histogram#size()},
 * and the value of each bin (each element in this {@link ArrayList})
 * is an integer, which is the count of voxels whose value falls within
 * the bin.
 *
 */
public class Histogram<T extends RealType<T>> extends TreeMap<Double, Integer> {
    private static final long serialVersionUID = 1L;

    private final Image<T> img;
    private final double min, max, increment;

    public Histogram(final Object fn) throws Exception {
        this(fn, 256);
    }

    public Histogram(final Object fn, final Number nBins) throws Exception {
        this(fn, nBins.intValue());
    }

    @SuppressWarnings("unchecked")
    public Histogram(final Object fn, final int nBins) throws Exception {
        this.img = AlgorithmUtil.wrap(fn);
        Display<T> display = img.getDisplay();
        display.setMinMax();
        this.min = display.getMin();
        this.max = display.getMax();
        this.increment = process(img, nBins, min, max);
    }

    @SuppressWarnings("unchecked")
    public Histogram(final Object fn, final int nBins, final double min, final double max) throws Exception {
        this.img = AlgorithmUtil.wrap(fn);
        this.min = min;
        this.max = max;
        this.increment = process(img, nBins, min, max);
    }

    private final double process(final Image<T> img, final int nBins, final double min, final double max)
            throws Exception {
        final double range = max - min;
        final double increment = range / nBins;
        final int[] bins = new int[nBins];
        //
        if (0.0 == range) {
            bins[0] = img.size();
        } else {
            final Cursor<T> c = img.createCursor();
            // zero-based:
            final int N = nBins - 1;
            // Analyze the image
            while (c.hasNext()) {
                c.fwd();
                int v = (int) (((c.getType().getRealDouble() - min) / range) * N);
                if (v < 0)
                    v = 0;
                else if (v > N)
                    v = N;
                bins[v] += 1;
            }
            c.close();
        }
        // Put the contents of the bins into this ArrayList:
        for (int i = 0; i < bins.length; i++) {
            this.put(min + i * increment, bins[i]);
        }

        return increment;
    }

    public double getMin() {
        return min;
    }

    public double getMax() {
        return max;
    }

    public double getIncrement() {
        return increment;
    }

    public Image<T> getImage() {
        return img;
    }

    public Image<RGBALegacyType> asImage() {
        return ChartUtils.asImage(asChart(false));
    }

    public JFreeChart asChart() {
        return asChart(false);
    }

    /** Return the JFreeChart with this histogram, and as a side effect, show it in a JFrame
     * that provides the means to edit the dimensions and also the plot properties via a popup menu. */
    public JFreeChart asChart(final boolean show) {
        double[] d = new double[this.size()];
        int i = 0;
        for (Number num : this.values())
            d[i++] = num.doubleValue();
        HistogramDataset hd = new HistogramDataset();
        hd.setType(HistogramType.RELATIVE_FREQUENCY);
        String title = "Histogram";
        hd.addSeries(title, d, d.length);
        JFreeChart chart = ChartFactory.createHistogram(title, "", "", hd, PlotOrientation.VERTICAL, false, false,
                false);
        setTheme(chart);
        if (show) {
            JFrame frame = new JFrame(title);
            frame.getContentPane().add(new ChartPanel(chart));
            frame.pack();
            frame.setVisible(true);
        }
        return chart;
    }

    static private final void setTheme(final JFreeChart chart) {
        XYPlot plot = (XYPlot) chart.getPlot();
        XYBarRenderer r = (XYBarRenderer) plot.getRenderer();
        StandardXYBarPainter bp = new StandardXYBarPainter();
        r.setBarPainter(bp);
        r.setSeriesOutlinePaint(0, Color.lightGray);
        r.setShadowVisible(false);
        r.setDrawBarOutline(false);
        setBackgroundDefault(chart);
    }

    static private final void setBackgroundDefault(final JFreeChart chart) {
        BasicStroke gridStroke = new BasicStroke(1.0f, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND, 1.0f,
                new float[] { 2.0f, 1.0f }, 0.0f);
        XYPlot plot = (XYPlot) chart.getPlot();
        plot.setRangeGridlineStroke(gridStroke);
        plot.setDomainGridlineStroke(gridStroke);
        plot.setBackgroundPaint(new Color(235, 235, 235));
        plot.setRangeGridlinePaint(Color.white);
        plot.setDomainGridlinePaint(Color.white);
        plot.setOutlineVisible(false);
        plot.getDomainAxis().setAxisLineVisible(false);
        plot.getRangeAxis().setAxisLineVisible(false);
        plot.getDomainAxis().setLabelPaint(Color.gray);
        plot.getRangeAxis().setLabelPaint(Color.gray);
        plot.getDomainAxis().setTickLabelPaint(Color.gray);
        plot.getRangeAxis().setTickLabelPaint(Color.gray);
        chart.getTitle().setPaint(Color.gray);
    }
}