git.gag.com Git - debian/openrocket/blob - src/net/sf/openrocket/gui/dialogs/optimization/OptimizationPlotDialog.java

   1 package net.sf.openrocket.gui.dialogs.optimization;
   2
   3 import java.awt.Color;
   4 import java.awt.Paint;
   5 import java.awt.Window;
   6 import java.awt.event.ActionEvent;
   7 import java.awt.event.ActionListener;
   8 import java.util.ArrayList;
   9 import java.util.Iterator;
  10 import java.util.List;
  11 import java.util.Map;
  12
  13 import javax.swing.BorderFactory;
  14 import javax.swing.JButton;
  15 import javax.swing.JDialog;
  16 import javax.swing.JLabel;
  17 import javax.swing.JPanel;
  18
  19 import net.miginfocom.swing.MigLayout;
  20 import net.sf.openrocket.gui.components.StyledLabel;
  21 import net.sf.openrocket.l10n.Translator;
  22 import net.sf.openrocket.logging.LogHelper;
  23 import net.sf.openrocket.optimization.general.Point;
  24 import net.sf.openrocket.optimization.rocketoptimization.OptimizableParameter;
  25 import net.sf.openrocket.optimization.rocketoptimization.SimulationModifier;
  26 import net.sf.openrocket.startup.Application;
  27 import net.sf.openrocket.unit.Unit;
  28 import net.sf.openrocket.unit.UnitGroup;
  29 import net.sf.openrocket.unit.Value;
  30 import net.sf.openrocket.util.GUIUtil;
  31 import net.sf.openrocket.util.LinearInterpolator;
  32 import net.sf.openrocket.util.MathUtil;
  33
  34 import org.jfree.chart.ChartFactory;
  35 import org.jfree.chart.ChartPanel;
  36 import org.jfree.chart.JFreeChart;
  37 import org.jfree.chart.axis.AxisLocation;
  38 import org.jfree.chart.axis.NumberAxis;
  39 import org.jfree.chart.labels.CustomXYToolTipGenerator;
  40 import org.jfree.chart.plot.PlotOrientation;
  41 import org.jfree.chart.plot.XYPlot;
  42 import org.jfree.chart.renderer.PaintScale;
  43 import org.jfree.chart.renderer.xy.XYLineAndShapeRenderer;
  44 import org.jfree.chart.renderer.xy.XYShapeRenderer;
  45 import org.jfree.chart.title.PaintScaleLegend;
  46 import org.jfree.data.xy.DefaultXYZDataset;
  47 import org.jfree.data.xy.XYSeries;
  48 import org.jfree.data.xy.XYSeriesCollection;
  49 import org.jfree.ui.RectangleEdge;
  50
  51 /**
  52  * A class that plots the path of an optimization.
  53  *
  54  * @author Sampo Niskanen <sampo.niskanen@iki.fi>
  55  */
  56 public class OptimizationPlotDialog extends JDialog {
  57         private static final LogHelper log = Application.getLogger();
  58         private static final Translator trans = Application.getTranslator();
  59
  60
  61         private static final LinearInterpolator RED = new LinearInterpolator(
  62                         new double[] { 0.0, 1.0 }, new double[] { 0.0, 1.0 }
  63                         );
  64         private static final LinearInterpolator GREEN = new LinearInterpolator(
  65                         new double[] { 0.0, 1.0 }, new double[] { 0.0, 0.0 }
  66                         );
  67         private static final LinearInterpolator BLUE = new LinearInterpolator(
  68                         new double[] { 0.0, 1.0 }, new double[] { 1.0, 0.0 }
  69                         );
  70
  71         private static final Color OUT_OF_DOMAIN_COLOR = Color.BLACK;
  72
  73         private static final Color PATH_COLOR = new Color(220, 0, 0);
  74
  75
  76         public OptimizationPlotDialog(List<Point> path, Map<Point, FunctionEvaluationData> evaluations,
  77                         List<SimulationModifier> modifiers, OptimizableParameter parameter, UnitGroup stabilityUnit, Window parent) {
  78                 super(parent, trans.get("title"), ModalityType.APPLICATION_MODAL);
  79
  80
  81                 JPanel panel = new JPanel(new MigLayout("fill"));
  82
  83                 ChartPanel chart;
  84                 if (modifiers.size() == 1) {
  85                         chart = create1DPlot(path, evaluations, modifiers, parameter, stabilityUnit);
  86                 } else if (modifiers.size() == 2) {
  87                         chart = create2DPlot(path, evaluations, modifiers, parameter, stabilityUnit);
  88                 } else {
  89                         throw new IllegalArgumentException("Invalid dimensionality, dim=" + modifiers.size());
  90                 }
  91                 chart.setBorder(BorderFactory.createLineBorder(Color.BLACK));
  92                 panel.add(chart, "span, grow, wrap para");
  93
  94
  95                 JLabel label = new StyledLabel(trans.get("lbl.zoomInstructions"), -2);
  96                 panel.add(label, "");
  97
  98
  99                 JButton close = new JButton(trans.get("button.close"));
 100                 close.addActionListener(new ActionListener() {
 101                         @Override
 102                         public void actionPerformed(ActionEvent e) {
 103                                 OptimizationPlotDialog.this.setVisible(false);
 104                         }
 105                 });
 106                 panel.add(close, "right");
 107
 108
 109                 this.add(panel);
 110
 111                 GUIUtil.setDisposableDialogOptions(this, close);
 112         }
 113
 114
 115
 116         /**
 117          * Create a 1D plot of the optimization path.
 118          */
 119         private ChartPanel create1DPlot(List<Point> path, Map<Point, FunctionEvaluationData> evaluations,
 120                         List<SimulationModifier> modifiers, OptimizableParameter parameter, UnitGroup stabilityUnit) {
 121
 122                 SimulationModifier modX = modifiers.get(0);
 123                 Unit xUnit = modX.getUnitGroup().getDefaultUnit();
 124                 Unit yUnit = parameter.getUnitGroup().getDefaultUnit();
 125
 126                 // Create the optimization path (with autosort)
 127                 XYSeries series = new XYSeries(trans.get("plot1d.series"), true, true);
 128                 List<String> tooltips = new ArrayList<String>();
 129                 for (Point p : evaluations.keySet()) {
 130                         FunctionEvaluationData data = evaluations.get(p);
 131                         if (data != null) {
 132                                 if (data.getParameterValue() != null) {
 133                                         Value[] state = data.getState();
 134                                         series.add(xUnit.toUnit(state[0].getValue()), yUnit.toUnit(data.getParameterValue().getValue()));
 135                                         tooltips.add(getTooltip(data, parameter));
 136                                 }
 137                         } else {
 138                                 log.error("Could not find evaluation data for point " + p);
 139                         }
 140                 }
 141
 142
 143                 String xLabel = modX.getRelatedObject().toString() + ": " + modX.getName() + " / " + xUnit.getUnit();
 144                 String yLabel = parameter.getName() + " / " + yUnit.getUnit();
 145
 146                 JFreeChart chart = ChartFactory.createXYLineChart(
 147                                 trans.get("plot1d.title"),
 148                                 xLabel,
 149                                 yLabel,
 150                                 null,
 151                                 PlotOrientation.VERTICAL,
 152                                 false, // Legend
 153                                 true, // Tooltips
 154                                 false); // Urls
 155
 156
 157                 XYLineAndShapeRenderer lineRenderer = new XYLineAndShapeRenderer(true, true);
 158                 lineRenderer.setBaseShapesVisible(true);
 159                 lineRenderer.setSeriesShapesFilled(0, false);
 160                 //lineRenderer.setSeriesShape(0, shapeRenderer.getBaseShape());
 161                 lineRenderer.setSeriesOutlinePaint(0, PATH_COLOR);
 162                 lineRenderer.setSeriesPaint(0, PATH_COLOR);
 163                 lineRenderer.setUseOutlinePaint(true);
 164                 CustomXYToolTipGenerator tooltipGenerator = new CustomXYToolTipGenerator();
 165                 tooltipGenerator.addToolTipSeries(tooltips);
 166                 lineRenderer.setBaseToolTipGenerator(tooltipGenerator);
 167
 168
 169                 XYPlot plot = chart.getXYPlot();
 170
 171                 plot.setDataset(0, new XYSeriesCollection(series));
 172                 plot.setRenderer(lineRenderer);
 173
 174
 175
 176                 return new ChartPanel(chart);
 177         }
 178
 179         /**
 180          * Create a 2D plot of the optimization path.
 181          */
 182         private ChartPanel create2DPlot(List<Point> path, Map<Point, FunctionEvaluationData> evaluations,
 183                         List<SimulationModifier> modifiers, OptimizableParameter parameter, UnitGroup stabilityUnit) {
 184
 185                 Unit parameterUnit = parameter.getUnitGroup().getDefaultUnit();
 186
 187                 SimulationModifier modX = modifiers.get(0);
 188                 SimulationModifier modY = modifiers.get(1);
 189
 190                 Unit xUnit = modX.getUnitGroup().getDefaultUnit();
 191                 Unit yUnit = modY.getUnitGroup().getDefaultUnit();
 192
 193                 // Create the optimization path dataset
 194                 XYSeries series = new XYSeries(trans.get("plot2d.path"), false, true);
 195                 List<String> pathTooltips = new ArrayList<String>();
 196                 for (Point p : path) {
 197                         FunctionEvaluationData data = evaluations.get(p);
 198                         if (data != null) {
 199                                 Value[] state = data.getState();
 200                                 series.add(xUnit.toUnit(state[0].getValue()), yUnit.toUnit(state[1].getValue()));
 201                                 pathTooltips.add(getTooltip(data, parameter));
 202                         } else {
 203                                 log.error("Could not find evaluation data for point " + p);
 204                         }
 205                 }
 206
 207
 208                 // Create evaluations dataset
 209                 double min = Double.POSITIVE_INFINITY;
 210                 double max = Double.NEGATIVE_INFINITY;
 211                 double[][] evals = new double[3][evaluations.size()];
 212                 List<String> evalTooltips = new ArrayList<String>();
 213
 214                 Iterator<FunctionEvaluationData> iterator = evaluations.values().iterator();
 215                 for (int i = 0; i < evaluations.size(); i++) {
 216                         FunctionEvaluationData data = iterator.next();
 217                         Value param = data.getParameterValue();
 218                         double value;
 219                         if (param != null) {
 220                                 value = parameterUnit.toUnit(data.getParameterValue().getValue());
 221                         } else {
 222                                 value = Double.NaN;
 223                         }
 224
 225                         Value[] state = data.getState();
 226                         evals[0][i] = xUnit.toUnit(state[0].getValue());
 227                         evals[1][i] = yUnit.toUnit(state[1].getValue());
 228                         evals[2][i] = value;
 229
 230                         if (value < min) {
 231                                 min = value;
 232                         }
 233                         if (value > max) {
 234                                 max = value;
 235                         }
 236
 237                         evalTooltips.add(getTooltip(data, parameter));
 238                 }
 239                 DefaultXYZDataset evalDataset = new DefaultXYZDataset();
 240                 evalDataset.addSeries(trans.get("plot2d.evals"), evals);
 241
 242
 243
 244                 String xLabel = modX.getRelatedObject().toString() + ": " + modX.getName() + " / " + xUnit.getUnit();
 245                 String yLabel = modY.getRelatedObject().toString() + ": " + modY.getName() + " / " + yUnit.getUnit();
 246
 247                 JFreeChart chart = ChartFactory.createXYLineChart(
 248                                 trans.get("plot2d.title"),
 249                                 xLabel,
 250                                 yLabel,
 251                                 null,
 252                                 //evalDataset,
 253                                 PlotOrientation.VERTICAL,
 254                                 true, // Legend
 255                                 true, // Tooltips
 256                                 false); // Urls
 257
 258                 PaintScale paintScale = new GradientScale(min, max);
 259
 260                 XYShapeRenderer shapeRenderer = new XYShapeRenderer();
 261                 shapeRenderer.setPaintScale(paintScale);
 262                 shapeRenderer.setUseFillPaint(true);
 263                 CustomXYToolTipGenerator tooltipGenerator = new CustomXYToolTipGenerator();
 264                 tooltipGenerator.addToolTipSeries(evalTooltips);
 265                 shapeRenderer.setBaseToolTipGenerator(tooltipGenerator);
 266
 267
 268                 shapeRenderer.getLegendItem(0, 0);
 269
 270
 271                 XYLineAndShapeRenderer lineRenderer = new XYLineAndShapeRenderer(true, true);
 272                 lineRenderer.setBaseShapesVisible(true);
 273                 lineRenderer.setSeriesShapesFilled(0, false);
 274                 lineRenderer.setSeriesShape(0, shapeRenderer.getBaseShape());
 275                 lineRenderer.setSeriesOutlinePaint(0, PATH_COLOR);
 276                 lineRenderer.setSeriesPaint(0, PATH_COLOR);
 277                 lineRenderer.setUseOutlinePaint(true);
 278                 tooltipGenerator = new CustomXYToolTipGenerator();
 279                 tooltipGenerator.addToolTipSeries(pathTooltips);
 280                 lineRenderer.setBaseToolTipGenerator(tooltipGenerator);
 281
 282
 283                 XYPlot plot = chart.getXYPlot();
 284
 285                 plot.setDataset(0, new XYSeriesCollection(series));
 286                 plot.setRenderer(lineRenderer);
 287
 288                 plot.setDataset(1, evalDataset);
 289                 plot.setRenderer(1, shapeRenderer);
 290
 291
 292                 // Add value scale
 293                 NumberAxis numberAxis = new NumberAxis(parameter.getName() + " / " + parameterUnit.getUnit());
 294                 PaintScaleLegend scale = new PaintScaleLegend(paintScale, numberAxis);
 295                 scale.setPosition(RectangleEdge.RIGHT);
 296                 scale.setMargin(4.0D, 4.0D, 40.0D, 4.0D);
 297                 scale.setAxisLocation(AxisLocation.BOTTOM_OR_RIGHT);
 298                 chart.addSubtitle(scale);
 299
 300
 301                 return new ChartPanel(chart);
 302         }
 303
 304
 305
 306         private String getTooltip(FunctionEvaluationData data, OptimizableParameter parameter) {
 307                 String ttip = "<html>";
 308                 if (data.getParameterValue() != null) {
 309                         ttip += parameter.getName() + ": " +
 310                                         parameter.getUnitGroup().getDefaultUnit().toStringUnit(data.getParameterValue().getValue());
 311                         ttip += "<br>";
 312                 }
 313                 if (data.getDomainReference() != null) {
 314                         ttip += trans.get("plot.ttip.stability") + " " + data.getDomainReference();
 315                 }
 316                 return ttip;
 317         }
 318
 319         private class GradientScale implements PaintScale {
 320
 321                 private final double min;
 322                 private final double max;
 323
 324                 public GradientScale(double min, double max) {
 325                         this.min = min;
 326                         this.max = max;
 327                 }
 328
 329                 @Override
 330                 public Paint getPaint(double value) {
 331                         if (Double.isNaN(value)) {
 332                                 return OUT_OF_DOMAIN_COLOR;
 333                         }
 334
 335                         value = MathUtil.map(value, min, max, 0.0, 1.0);
 336                         value = MathUtil.clamp(value, 0.0, 1.0);
 337
 338                         float r = (float) RED.getValue(value);
 339                         float g = (float) GREEN.getValue(value);
 340                         float b = (float) BLUE.getValue(value);
 341
 342                         return new Color(r, g, b);
 343                 }
 344
 345                 @Override
 346                 public double getLowerBound() {
 347                         return min;
 348                 }
 349
 350                 @Override
 351                 public double getUpperBound() {
 352                         return max;
 353                 }
 354         }
 355
 356 }