HistogramSeriesCollection.java

/*
 * Class:        HistogramSeriesCollection
 * Description:
 * Environment:  Java
 * Software:     SSJ
 * Copyright (C) 2001  Pierre L'Ecuyer and Universite de Montreal
 * Organization: DIRO, Universite de Montreal
 * @author
 * @since
 *
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
package umontreal.ssj.charts;
 
import umontreal.ssj.stat.*;
import umontreal.ssj.util.Num;
 
import org.jfree.chart.renderer.xy.XYBarRenderer;
import org.jfree.data.statistics.HistogramBin;
 
import cern.colt.list.DoubleArrayList;
 
import java.util.Locale;
import java.util.Formatter;
import java.util.List;
import java.util.ListIterator;
import java.awt.Color;

public class HistogramSeriesCollection extends SSJXYSeriesCollection {
   protected boolean[] filled; // fill flag for each series
   protected double[] lineWidth; // sets line width
   protected int numBin = 20; // default number of bins
 
   private int calcNumBins(int n) {
      // set the number of bins
      int numbins = (int) Math.ceil(1.0 + Num.log2(n));
      if (n > 5000)
         numbins *= 2;
      return numbins;
   }
 
   private double[] countersToArray(TallyHistogram hist) {
      final int nb = hist.getNumBins();
      final double binwidth = (hist.getB() - hist.getA()) / nb;
      int[] count = hist.getCounters();
      int sum = 0;
      for (int i = 1; i <= nb; i++)
         sum += count[i];
      double[] data = new double[sum];
 
      double h, base;
      int k = 0;
      for (int i = 1; i <= nb; i++) {
         h = binwidth;
         base = hist.getA() + (i - 1) * binwidth;
         if (count[i] > 0)
            h /= count[i];
         if (i == nb) {
            for (int j = 0; j < count[i]; j++)
               data[k++] = hist.getB() - j * h;
         } else {
            for (int j = 0; j < count[i]; j++)
               data[k++] = base + j * h;
         }
      }
      return data;
   }

   public HistogramSeriesCollection() {
      renderer = new XYBarRenderer();
      seriesCollection = new CustomHistogramDataset();
   }

   public HistogramSeriesCollection(double[]... data) {
      seriesCollection = new CustomHistogramDataset();
      renderer = new XYBarRenderer();
      CustomHistogramDataset tempSeriesCollection = (CustomHistogramDataset) seriesCollection;
      for (int i = 0; i < data.length; i++) {
         numBin = calcNumBins(data[i].length);
         tempSeriesCollection.addSeries(i, data[i], numBin);
      }
 
      // set default colors
      for (int i = 0; i < tempSeriesCollection.getSeriesCount(); i++) {
         renderer.setSeriesPaint(i, getDefaultColor(i));
      }
 
      // set default plot style
      filled = new boolean[seriesCollection.getSeriesCount()];
      lineWidth = new double[seriesCollection.getSeriesCount()];
      for (int i = 0; i < tempSeriesCollection.getSeriesCount(); i++) {
         filled[i] = false;
         lineWidth[i] = 0.5;
         setFilled(i, false);
      }
   }

   public HistogramSeriesCollection(double[] data, int numPoints) {
      seriesCollection = new CustomHistogramDataset();
      renderer = new XYBarRenderer();
      CustomHistogramDataset tempSeriesCollection = (CustomHistogramDataset) seriesCollection;
      numBin = calcNumBins(numPoints);
      tempSeriesCollection.addSeries(0, data, numPoints, numBin);
 
      // set default colors
      for (int i = 0; i < tempSeriesCollection.getSeriesCount(); i++) {
         renderer.setSeriesPaint(i, getDefaultColor(i));
      }
 
      // set default plot style
      filled = new boolean[seriesCollection.getSeriesCount()];
      lineWidth = new double[seriesCollection.getSeriesCount()];
      for (int i = 0; i < tempSeriesCollection.getSeriesCount(); i++) {
         filled[i] = false;
         lineWidth[i] = 0.5;
         setFilled(i, false);
      }
   }

   public HistogramSeriesCollection(DoubleArrayList... data) {
      seriesCollection = new CustomHistogramDataset();
      renderer = new XYBarRenderer();
      CustomHistogramDataset tempSeriesCollection = (CustomHistogramDataset) seriesCollection;
 
      for (int i = 0; i < data.length; i++) {
         numBin = calcNumBins(data[i].size());
         tempSeriesCollection.addSeries(i, data[i].elements(), data[i].size(), numBin);
      }
 
      // set default colors
      for (int i = 0; i < tempSeriesCollection.getSeriesCount(); i++) {
         renderer.setSeriesPaint(i, getDefaultColor(i));
      }
 
      // set default plot style
      filled = new boolean[seriesCollection.getSeriesCount()];
      lineWidth = new double[seriesCollection.getSeriesCount()];
      for (int i = 0; i < tempSeriesCollection.getSeriesCount(); i++) {
         filled[i] = false;
         lineWidth[i] = 0.5;
         setFilled(i, false);
      }
   }

   public HistogramSeriesCollection(TallyStore... tallies) {
      seriesCollection = new CustomHistogramDataset();
      renderer = new XYBarRenderer();
      CustomHistogramDataset tempSeriesCollection = (CustomHistogramDataset) seriesCollection;
 
      double h;
      for (int i = 0; i < tallies.length; i++) {
         // Scott's formula
         h = 3.5 * tallies[i].standardDeviation() / Math.pow(tallies[i].numberObs(), 1.0 / 3.0);
         numBin = (int) ((tallies[i].max() - tallies[i].min()) / (1.5 * h));
         tempSeriesCollection.addSeries(i, tallies[i].getArray(), tallies[i].numberObs(), numBin, tallies[i].min(),
               tallies[i].max());
      }
 
      // set default colors
      for (int i = 0; i < tempSeriesCollection.getSeriesCount(); i++) {
         renderer.setSeriesPaint(i, getDefaultColor(i));
      }
 
      // set default plot style
      filled = new boolean[seriesCollection.getSeriesCount()];
      lineWidth = new double[seriesCollection.getSeriesCount()];
      for (int i = 0; i < tempSeriesCollection.getSeriesCount(); i++) {
         filled[i] = false;
         lineWidth[i] = 0.5;
         setFilled(i, false);
      }
   }

   public HistogramSeriesCollection(TallyHistogram... tallies) {
      seriesCollection = new CustomHistogramDataset();
      renderer = new XYBarRenderer();
      CustomHistogramDataset tempSeriesCollection = (CustomHistogramDataset) seriesCollection;
 
      double[] data;
      for (int i = 0; i < tallies.length; i++) {
         data = countersToArray(tallies[i]);
         tempSeriesCollection.addSeries(i, data, data.length, tallies[i].getNumBins(), tallies[i].getA(),
               tallies[i].getB());
      }
 
      // set default colors
      for (int i = 0; i < tempSeriesCollection.getSeriesCount(); i++) {
         renderer.setSeriesPaint(i, getDefaultColor(i));
      }
 
      // set default plot style
      filled = new boolean[seriesCollection.getSeriesCount()];
      lineWidth = new double[seriesCollection.getSeriesCount()];
      for (int i = 0; i < tempSeriesCollection.getSeriesCount(); i++) {
         filled[i] = false;
         lineWidth[i] = 0.5;
         setFilled(i, false);
      }
   }

   public HistogramSeriesCollection(CustomHistogramDataset data) {
      renderer = new XYBarRenderer();
      seriesCollection = data;
 
      // set default colors
      for (int i = 0; i < data.getSeriesCount(); i++) {
         renderer.setSeriesPaint(i, getDefaultColor(i));
      }
 
      // set default plot style
      filled = new boolean[seriesCollection.getSeriesCount()];
      lineWidth = new double[seriesCollection.getSeriesCount()];
      for (int i = 0; i < data.getSeriesCount(); i++) {
         filled[i] = false;
         lineWidth[i] = 0.5;
         setFilled(i, false);
      }
   }


   public int add(double[] data) {
      return add(data, data.length);
   }

   public int add(double[] data, int numPoints) {
      CustomHistogramDataset tempSeriesCollection = (CustomHistogramDataset) seriesCollection;
      tempSeriesCollection.addSeries(tempSeriesCollection.getSeriesCount(), data, numPoints, numBin);
 
      boolean[] newFilled = new boolean[seriesCollection.getSeriesCount()];
      double[] newLineWidth = new double[seriesCollection.getSeriesCount()];
 
      // color
      int j = seriesCollection.getSeriesCount() - 1;
      renderer.setSeriesPaint(j, getDefaultColor(j));
      newFilled[j] = false;
      newLineWidth[j] = 0.5;
 
      for (j = 0; j < seriesCollection.getSeriesCount() - 1; j++) {
         newFilled[j] = filled[j];
         newLineWidth[j] = lineWidth[j];
      }
 
      filled = newFilled;
      lineWidth = newLineWidth;
 
      return seriesCollection.getSeriesCount() - 1;
   }

   public int add(DoubleArrayList observationSet) {
      return add(observationSet.elements(), observationSet.size());
   }

   public int add(TallyStore tally) {
      return add(tally.getArray(), tally.numberObs());
   }

   public CustomHistogramDataset getSeriesCollection() {
      return (CustomHistogramDataset) seriesCollection;
   }

   public List getBins(int series) {
      return ((CustomHistogramDataset) seriesCollection).getBins(series);
   }

   public void setBins(int series, int bins) {
      ((CustomHistogramDataset) seriesCollection).setBins(series, bins);
   }

   public void setBins(int series, int bins, double minimum, double maximum) {
      ((CustomHistogramDataset) seriesCollection).setBins(series, bins, minimum, maximum);
   }

   public void setBins(int series, HistogramBin[] binsTable) {
      ((CustomHistogramDataset) seriesCollection).setBins(series, binsTable);
   }

   public List getValuesList(int series) {
      return ((CustomHistogramDataset) seriesCollection).getValuesList(series);
   }

   public double[] getValues(int series) {
      return ((CustomHistogramDataset) seriesCollection).getValues(series);
   }

   public void setValues(int series, List valuesList) {
      ((CustomHistogramDataset) seriesCollection).setValues(series, valuesList);
   }

   public void setValues(int series, double[] values) {
      ((CustomHistogramDataset) seriesCollection).setValues(series, values);
   }



   public boolean getFilled(int series) {
      return filled[series];
   }

   public void setFilled(int series, boolean filled) {
      this.filled[series] = filled;
   }

   public double getMargin() {
      return ((XYBarRenderer) renderer).getMargin();
   }

   public void setMargin(double margin) {
      ((XYBarRenderer) renderer).setMargin(margin);
   }

   public double getOutlineWidth(int series) {
      return lineWidth[series];
   }

   public void setOutlineWidth(int series, double outline) {
      this.lineWidth[series] = outline;
   }
 
   public String toLatex(double XScale, double YScale, double XShift, double YShift, double xmin, double xmax,
         double ymin, double ymax) {
 
      // Calcule les bornes reelles du graphique, en prenant en compte la position des
      // axes
      xmin = Math.min(XShift, xmin);
      xmax = Math.max(XShift, xmax);
      ymin = Math.min(YShift, ymin);
      ymax = Math.max(YShift, ymax);
 
      CustomHistogramDataset tempSeriesCollection = (CustomHistogramDataset) seriesCollection;
      Formatter formatter = new Formatter(Locale.US);
      double var;
      double margin = ((XYBarRenderer) renderer).getMargin();
 
      for (int i = tempSeriesCollection.getSeriesCount() - 1; i >= 0; i--) {
         List temp = tempSeriesCollection.getBins(i);
         ListIterator iter = temp.listIterator();
 
         Color color = (Color) renderer.getSeriesPaint(i);
         String colorString = detectXColorClassic(color);
         if (colorString == null) {
            colorString = "color" + i;
            formatter.format("\\definecolor{%s}{rgb}{%.2f, %.2f, %.2f}%n", colorString, color.getRed() / 255.0,
                  color.getGreen() / 255.0, color.getBlue() / 255.0);
         }
 
         HistogramBin currentBin = null;
         while (iter.hasNext()) {
            double currentMargin;
            currentBin = (HistogramBin) iter.next();
            currentMargin = ((margin * (currentBin.getEndBoundary() - currentBin.getStartBoundary()))) * XScale;
            if ((currentBin.getStartBoundary() >= xmin && currentBin.getStartBoundary() <= xmax)
                  && (currentBin.getCount() >= ymin && currentBin.getCount() <= ymax)) {
               var = Math.min(currentBin.getEndBoundary(), xmax);
               if (filled[i]) {
                  formatter.format(
                        "\\filldraw [line width=%.2fpt, opacity=%.2f, color=%s] ([xshift=%.4f] %.4f, %.4f) rectangle ([xshift=-%.4f] %.4f, %.4f); %%%n",
                        lineWidth[i], (color.getAlpha() / 255.0), colorString, currentMargin,
                        (currentBin.getStartBoundary() - XShift) * XScale, 0.0, currentMargin, (var - XShift) * XScale,
                        (currentBin.getCount() - YShift) * YScale);
               } else {
                  formatter.format(
                        "\\draw [line width=%.2fpt, color=%s] ([xshift=%.4f] %.4f, %.4f) rectangle ([xshift=-%.4f] %.4f, %.4f); %%%n",
                        lineWidth[i], colorString, currentMargin, (currentBin.getStartBoundary() - XShift) * XScale,
                        0.0, currentMargin, (var - XShift) * XScale, (currentBin.getCount() - YShift) * YScale);
               }
            } else if ((currentBin.getStartBoundary() >= xmin && currentBin.getStartBoundary() <= xmax)
                  && (currentBin.getCount() >= ymin && currentBin.getCount() > ymax)) { // Cas ou notre rectangle ne
                                                                                        // peut pas etre affiche en
                                                                                        // entier (trop haut)
               var = Math.min(currentBin.getEndBoundary(), xmax);
               if (filled[i]) {
                  formatter.format(
                        "\\filldraw [line width=%.2fpt,  opacity=%.2f, color=%s] ([xshift=%.4f] %.4f, %.4f) rectangle ([xshift=-%.4f] %.4f, %.4f); %%%n",
                        lineWidth[i], (color.getAlpha() / 255.0), colorString, currentMargin,
                        (currentBin.getStartBoundary() - XShift) * XScale, 0.0, currentMargin, (var - XShift) * XScale,
                        (ymax - YShift) * YScale);
                  formatter.format(
                        "\\draw [line width=%.2fpt, color=%s, style=dotted] ([xshift=%.4f] %.4f, %.4f) rectangle ([yshift=3mm, xshift=-%.4f] %.4f, %.4f); %%%n",
                        lineWidth[i], colorString, currentMargin, (currentBin.getStartBoundary() - XShift) * XScale,
                        (ymax - YShift) * YScale, currentMargin, (var - XShift) * XScale, (ymax - YShift) * YScale);
               } else {
                  formatter.format(
                        "\\draw [line width=%.2fpt, color=%s] ([xshift=%.4f] %.4f, %.4f) rectangle ([xshift=-%.4f] %.4f, %.4f); %%%n",
                        lineWidth[i], colorString, currentMargin, (currentBin.getStartBoundary() - XShift) * XScale,
                        0.0, currentMargin, (var - XShift) * XScale, (ymax - YShift) * YScale);
 
                  formatter.format(
                        "\\draw [line width=%.2fpt, color=%s, style=dotted] ([xshift=%.4f] %.4f, %.4f) rectangle ([yshift=3mm, xshift=-%.4f] %.4f, %.4f); %%%n",
                        lineWidth[i], colorString, currentMargin, (currentBin.getStartBoundary() - XShift) * XScale,
                        (ymax - YShift) * YScale, currentMargin, (var - XShift) * XScale, (ymax - YShift) * YScale);
               }
            }
         }
      }
      return formatter.toString();
   }
}