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.annotations.XYBoxAnnotation;
  38 import org.jfree.chart.annotations.XYLineAnnotation;
  39 import org.jfree.chart.annotations.XYPointerAnnotation;
  40 import org.jfree.chart.axis.AxisLocation;
  41 import org.jfree.chart.axis.NumberAxis;
  42 import org.jfree.chart.labels.CustomXYToolTipGenerator;
  43 import org.jfree.chart.plot.PlotOrientation;
  44 import org.jfree.chart.plot.XYPlot;
  45 import org.jfree.chart.renderer.PaintScale;
  46 import org.jfree.chart.renderer.xy.XYLineAndShapeRenderer;
  47 import org.jfree.chart.renderer.xy.XYShapeRenderer;
  48 import org.jfree.chart.title.PaintScaleLegend;
  49 import org.jfree.data.xy.DefaultXYZDataset;
  50 import org.jfree.data.xy.XYSeries;
  51 import org.jfree.data.xy.XYSeriesCollection;
  52 import org.jfree.ui.RectangleEdge;
  53 import org.jfree.ui.TextAnchor;
  54
  55 /**
  56  * A class that plots the path of an optimization.
  57  *
  58  * @author Sampo Niskanen <sampo.niskanen@iki.fi>
  59  */
  60 public class OptimizationPlotDialog extends JDialog {
  61         private static final LogHelper log = Application.getLogger();
  62         private static final Translator trans = Application.getTranslator();
  63
  64
  65         private static final LinearInterpolator RED = new LinearInterpolator(
  66                         new double[] { 0.0, 1.0 }, new double[] { 0.0, 1.0 }
  67                         );
  68         private static final LinearInterpolator GREEN = new LinearInterpolator(
  69                         new double[] { 0.0, 1.0 }, new double[] { 0.0, 0.0 }
  70                         );
  71         private static final LinearInterpolator BLUE = new LinearInterpolator(
  72                         new double[] { 0.0, 1.0 }, new double[] { 1.0, 0.0 }
  73                         );
  74
  75         private static final Color OUT_OF_DOMAIN_COLOR = Color.BLACK;
  76
  77         private static final Color PATH_COLOR = new Color(220, 0, 0);
  78
  79
  80         public OptimizationPlotDialog(List<Point> path, Map<Point, FunctionEvaluationData> evaluations,
  81                         List<SimulationModifier> modifiers, OptimizableParameter parameter, UnitGroup stabilityUnit, Window parent) {
  82                 super(parent, trans.get("title"), ModalityType.APPLICATION_MODAL);
  83
  84
  85                 JPanel panel = new JPanel(new MigLayout("fill"));
  86
  87                 ChartPanel chart;
  88                 if (modifiers.size() == 1) {
  89                         chart = create1DPlot(path, evaluations, modifiers, parameter, stabilityUnit);
  90                 } else if (modifiers.size() == 2) {
  91                         chart = create2DPlot(path, evaluations, modifiers, parameter, stabilityUnit);
  92                 } else {
  93                         throw new IllegalArgumentException("Invalid dimensionality, dim=" + modifiers.size());
  94                 }
  95                 chart.setBorder(BorderFactory.createLineBorder(Color.BLACK));
  96                 panel.add(chart, "span, grow, wrap para");
  97
  98
  99                 JLabel label = new StyledLabel(trans.get("lbl.zoomInstructions"), -2);
 100                 panel.add(label, "");
 101
 102
 103                 JButton close = new JButton(trans.get("button.close"));
 104                 close.addActionListener(new ActionListener() {
 105                         @Override
 106                         public void actionPerformed(ActionEvent e) {
 107                                 OptimizationPlotDialog.this.setVisible(false);
 108                         }
 109                 });
 110                 panel.add(close, "right");
 111
 112
 113                 this.add(panel);
 114
 115                 GUIUtil.setDisposableDialogOptions(this, close);
 116         }
 117
 118
 119
 120         /**
 121          * Create a 1D plot of the optimization path.
 122          */
 123         private ChartPanel create1DPlot(List<Point> path, Map<Point, FunctionEvaluationData> evaluations,
 124                         List<SimulationModifier> modifiers, OptimizableParameter parameter, UnitGroup stabilityUnit) {
 125
 126                 SimulationModifier modX = modifiers.get(0);
 127                 Unit xUnit = modX.getUnitGroup().getDefaultUnit();
 128                 Unit yUnit = parameter.getUnitGroup().getDefaultUnit();
 129
 130                 // Create the optimization path (with autosort)
 131                 XYSeries series = new XYSeries(trans.get("plot1d.series"), true, true);
 132                 List<String> tooltips = new ArrayList<String>();
 133                 for (Point p : evaluations.keySet()) {
 134                         FunctionEvaluationData data = evaluations.get(p);
 135                         if (data != null) {
 136                                 if (data.getParameterValue() != null) {
 137                                         Value[] state = data.getState();
 138                                         series.add(xUnit.toUnit(state[0].getValue()), yUnit.toUnit(data.getParameterValue().getValue()));
 139                                         tooltips.add(getTooltip(data, parameter));
 140                                 }
 141                         } else {
 142                                 log.error("Could not find evaluation data for point " + p);
 143                         }
 144                 }
 145
 146
 147                 String xLabel = modX.getRelatedObject().toString() + ": " + modX.getName() + " / " + xUnit.getUnit();
 148                 String yLabel = parameter.getName() + " / " + yUnit.getUnit();
 149
 150                 JFreeChart chart = ChartFactory.createXYLineChart(
 151                                 trans.get("plot1d.title"),
 152                                 xLabel,
 153                                 yLabel,
 154                                 null,
 155                                 PlotOrientation.VERTICAL,
 156                                 false, // Legend
 157                                 true, // Tooltips
 158                                 false); // Urls
 159
 160
 161                 // Set the scale of the plot to the limits
 162                 double x1 = xUnit.toUnit(modX.getMinValue());
 163                 double x2 = xUnit.toUnit(modX.getMaxValue());
 164
 165                 if (x1 < x2 - 0.0001) {
 166                         log.debug("Setting 1D plot domain axis x1=" + x1 + " x2=" + x2);
 167                         chart.getXYPlot().getDomainAxis().setRange(x1, x2);
 168                 } else {
 169                         log.warn("1D plot domain singular x1=" + x1 + " x2=" + x2 + ", not setting");
 170                 }
 171
 172                 // Add lines to show optimization limits
 173                 XYLineAnnotation line = new XYLineAnnotation(x1, -1e19, x1, 1e19);
 174                 chart.getXYPlot().addAnnotation(line);
 175                 line = new XYLineAnnotation(x2, -1e19, x2, 1e19);
 176                 chart.getXYPlot().addAnnotation(line);
 177
 178                 // Mark the optimum point
 179                 Point optimum = path.get(path.size() - 1);
 180                 FunctionEvaluationData data = evaluations.get(optimum);
 181                 if (data != null) {
 182                         if (data.getParameterValue() != null) {
 183                                 Value[] state = data.getState();
 184                                 double x = xUnit.toUnit(state[0].getValue());
 185                                 double y = yUnit.toUnit(data.getParameterValue().getValue());
 186
 187                                 XYPointerAnnotation text = new XYPointerAnnotation(trans.get("plot.label.optimum"),
 188                                                 x, y, Math.PI / 2);
 189                                 text.setTextAnchor(TextAnchor.TOP_LEFT);
 190                                 chart.getXYPlot().addAnnotation(text);
 191                         }
 192                 } else {
 193                         log.error("Could not find evaluation data for point " + optimum);
 194                 }
 195
 196
 197                 XYLineAndShapeRenderer lineRenderer = new XYLineAndShapeRenderer(true, true);
 198                 lineRenderer.setBaseShapesVisible(true);
 199                 lineRenderer.setSeriesShapesFilled(0, false);
 200                 //lineRenderer.setSeriesShape(0, shapeRenderer.getBaseShape());
 201                 lineRenderer.setSeriesOutlinePaint(0, PATH_COLOR);
 202                 lineRenderer.setSeriesPaint(0, PATH_COLOR);
 203                 lineRenderer.setUseOutlinePaint(true);
 204                 CustomXYToolTipGenerator tooltipGenerator = new CustomXYToolTipGenerator();
 205                 tooltipGenerator.addToolTipSeries(tooltips);
 206                 lineRenderer.setBaseToolTipGenerator(tooltipGenerator);
 207
 208                 XYPlot plot = chart.getXYPlot();
 209
 210                 plot.setDataset(0, new XYSeriesCollection(series));
 211                 plot.setRenderer(lineRenderer);
 212
 213
 214
 215                 return new ChartPanel(chart);
 216         }
 217
 218         /**
 219          * Create a 2D plot of the optimization path.
 220          */
 221         private ChartPanel create2DPlot(List<Point> path, Map<Point, FunctionEvaluationData> evaluations,
 222                         List<SimulationModifier> modifiers, OptimizableParameter parameter, UnitGroup stabilityUnit) {
 223
 224                 Unit parameterUnit = parameter.getUnitGroup().getDefaultUnit();
 225
 226                 SimulationModifier modX = modifiers.get(0);
 227                 SimulationModifier modY = modifiers.get(1);
 228
 229                 Unit xUnit = modX.getUnitGroup().getDefaultUnit();
 230                 Unit yUnit = modY.getUnitGroup().getDefaultUnit();
 231
 232                 // Create the optimization path dataset
 233                 XYSeries pathSeries = new XYSeries(trans.get("plot2d.path"), false, true);
 234                 List<String> pathTooltips = new ArrayList<String>();
 235                 for (Point p : path) {
 236                         FunctionEvaluationData data = evaluations.get(p);
 237                         if (data != null) {
 238                                 Value[] state = data.getState();
 239                                 pathSeries.add(xUnit.toUnit(state[0].getValue()), yUnit.toUnit(state[1].getValue()));
 240                                 pathTooltips.add(getTooltip(data, parameter));
 241                         } else {
 242                                 log.error("Could not find evaluation data for point " + p);
 243                         }
 244                 }
 245
 246
 247                 // Create evaluations dataset
 248                 double min = Double.POSITIVE_INFINITY;
 249                 double max = Double.NEGATIVE_INFINITY;
 250                 double[][] evals = new double[3][evaluations.size()];
 251                 List<String> evalTooltips = new ArrayList<String>();
 252
 253                 Iterator<FunctionEvaluationData> iterator = evaluations.values().iterator();
 254                 for (int i = 0; i < evaluations.size(); i++) {
 255                         FunctionEvaluationData data = iterator.next();
 256                         Value param = data.getParameterValue();
 257                         double value;
 258                         if (param != null) {
 259                                 value = parameterUnit.toUnit(data.getParameterValue().getValue());
 260                         } else {
 261                                 value = Double.NaN;
 262                         }
 263
 264                         Value[] state = data.getState();
 265                         evals[0][i] = xUnit.toUnit(state[0].getValue());
 266                         evals[1][i] = yUnit.toUnit(state[1].getValue());
 267                         evals[2][i] = value;
 268
 269                         if (value < min) {
 270                                 min = value;
 271                         }
 272                         if (value > max) {
 273                                 max = value;
 274                         }
 275
 276                         evalTooltips.add(getTooltip(data, parameter));
 277                 }
 278                 DefaultXYZDataset evalDataset = new DefaultXYZDataset();
 279                 evalDataset.addSeries(trans.get("plot2d.evals"), evals);
 280
 281
 282
 283                 String xLabel = modX.getRelatedObject().toString() + ": " + modX.getName() + " / " + xUnit.getUnit();
 284                 String yLabel = modY.getRelatedObject().toString() + ": " + modY.getName() + " / " + yUnit.getUnit();
 285
 286                 JFreeChart chart = ChartFactory.createXYLineChart(
 287                                 trans.get("plot2d.title"),
 288                                 xLabel,
 289                                 yLabel,
 290                                 null,
 291                                 //evalDataset,
 292                                 PlotOrientation.VERTICAL,
 293                                 true, // Legend
 294                                 true, // Tooltips
 295                                 false); // Urls
 296
 297
 298                 // Set the scale of the plot to the limits
 299                 double x1 = xUnit.toUnit(modX.getMinValue());
 300                 double x2 = xUnit.toUnit(modX.getMaxValue());
 301                 double y1 = yUnit.toUnit(modY.getMinValue());
 302                 double y2 = yUnit.toUnit(modY.getMaxValue());
 303
 304                 if (x1 < x2 - 0.0001) {
 305                         log.debug("Setting 2D plot domain axis to x1=" + x1 + " x2=" + x2);
 306                         chart.getXYPlot().getDomainAxis().setRange(x1, x2);
 307                 } else {
 308                         log.warn("2D plot has singular domain axis: x1=" + x1 + " x2=" + x2);
 309                 }
 310
 311                 if (y1 < y2 - 0.0001) {
 312                         log.debug("Setting 2D plot range axis to y1=" + y1 + " y2=" + y2);
 313                         chart.getXYPlot().getRangeAxis().setRange(y1, y2);
 314                 } else {
 315                         log.warn("2D plot has singular range axis: y1=" + y1 + " y2=" + y2);
 316                 }
 317
 318                 XYBoxAnnotation box = new XYBoxAnnotation(x1, y1, x2, y2);
 319                 chart.getXYPlot().addAnnotation(box);
 320
 321                 int n = pathSeries.getItemCount();
 322                 XYPointerAnnotation text = new XYPointerAnnotation(trans.get("plot.label.optimum"),
 323                                 (Double) pathSeries.getX(n - 1), (Double) pathSeries.getY(n - 1), -Math.PI / 5);
 324                 text.setTextAnchor(TextAnchor.BASELINE_LEFT);
 325                 chart.getXYPlot().addAnnotation(text);
 326
 327
 328                 if (min < max - 0.0001) {
 329                         log.debug("Setting gradient scale range to min=" + min + " max=" + max);
 330                 } else {
 331                         log.warn("2D plot has singular gradient scale, resetting to (0,1): min=" + min + " max=" + max);
 332                         min = 0;
 333                         max = 1;
 334                 }
 335
 336                 PaintScale paintScale = new GradientScale(min, max);
 337
 338                 XYShapeRenderer shapeRenderer = new XYShapeRenderer();
 339                 shapeRenderer.setPaintScale(paintScale);
 340                 shapeRenderer.setUseFillPaint(true);
 341                 CustomXYToolTipGenerator tooltipGenerator = new CustomXYToolTipGenerator();
 342                 tooltipGenerator.addToolTipSeries(evalTooltips);
 343                 shapeRenderer.setBaseToolTipGenerator(tooltipGenerator);
 344
 345
 346                 shapeRenderer.getLegendItem(0, 0);
 347
 348
 349                 XYLineAndShapeRenderer lineRenderer = new XYLineAndShapeRenderer(true, true);
 350                 lineRenderer.setBaseShapesVisible(true);
 351                 lineRenderer.setSeriesShapesFilled(0, false);
 352                 lineRenderer.setSeriesShape(0, shapeRenderer.getBaseShape());
 353                 lineRenderer.setSeriesOutlinePaint(0, PATH_COLOR);
 354                 lineRenderer.setSeriesPaint(0, PATH_COLOR);
 355                 lineRenderer.setUseOutlinePaint(true);
 356                 tooltipGenerator = new CustomXYToolTipGenerator();
 357                 tooltipGenerator.addToolTipSeries(pathTooltips);
 358                 lineRenderer.setBaseToolTipGenerator(tooltipGenerator);
 359
 360
 361                 XYPlot plot = chart.getXYPlot();
 362
 363                 plot.setDataset(0, new XYSeriesCollection(pathSeries));
 364                 plot.setRenderer(lineRenderer);
 365
 366                 plot.setDataset(1, evalDataset);
 367                 plot.setRenderer(1, shapeRenderer);
 368
 369
 370                 // Add value scale
 371                 NumberAxis numberAxis = new NumberAxis(parameter.getName() + " / " + parameterUnit.getUnit());
 372                 PaintScaleLegend scale = new PaintScaleLegend(paintScale, numberAxis);
 373                 scale.setPosition(RectangleEdge.RIGHT);
 374                 scale.setMargin(4.0D, 4.0D, 40.0D, 4.0D);
 375                 scale.setAxisLocation(AxisLocation.BOTTOM_OR_RIGHT);
 376                 chart.addSubtitle(scale);
 377
 378
 379                 return new ChartPanel(chart);
 380         }
 381
 382
 383
 384         private String getTooltip(FunctionEvaluationData data, OptimizableParameter parameter) {
 385                 String ttip = "<html>";
 386                 if (data.getParameterValue() != null) {
 387                         ttip += parameter.getName() + ": " +
 388                                         parameter.getUnitGroup().getDefaultUnit().toStringUnit(data.getParameterValue().getValue());
 389                         ttip += "<br>";
 390                 }
 391                 if (data.getDomainReference() != null) {
 392                         ttip += trans.get("plot.ttip.stability") + " " + data.getDomainReference();
 393                 }
 394                 return ttip;
 395         }
 396
 397         private class GradientScale implements PaintScale {
 398
 399                 private final double min;
 400                 private final double max;
 401
 402                 public GradientScale(double min, double max) {
 403                         this.min = min;
 404                         this.max = max;
 405                 }
 406
 407                 @Override
 408                 public Paint getPaint(double value) {
 409                         if (Double.isNaN(value)) {
 410                                 return OUT_OF_DOMAIN_COLOR;
 411                         }
 412
 413                         value = MathUtil.map(value, min, max, 0.0, 1.0);
 414                         value = MathUtil.clamp(value, 0.0, 1.0);
 415
 416                         float r = (float) RED.getValue(value);
 417                         float g = (float) GREEN.getValue(value);
 418                         float b = (float) BLUE.getValue(value);
 419
 420                         return new Color(r, g, b);
 421                 }
 422
 423                 @Override
 424                 public double getLowerBound() {
 425                         return min;
 426                 }
 427
 428                 @Override
 429                 public double getUpperBound() {
 430                         return max;
 431                 }
 432         }
 433
 434 }