1 package net.sf.openrocket.gui.dialogs.optimization;
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;
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;
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;
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;
52 * A class that plots the path of an optimization.
54 * @author Sampo Niskanen <sampo.niskanen@iki.fi>
56 public class OptimizationPlotDialog extends JDialog {
57 private static final LogHelper log = Application.getLogger();
58 private static final Translator trans = Application.getTranslator();
61 private static final LinearInterpolator RED = new LinearInterpolator(
62 new double[] { 0.0, 1.0 }, new double[] { 0.0, 1.0 }
64 private static final LinearInterpolator GREEN = new LinearInterpolator(
65 new double[] { 0.0, 1.0 }, new double[] { 0.0, 0.0 }
67 private static final LinearInterpolator BLUE = new LinearInterpolator(
68 new double[] { 0.0, 1.0 }, new double[] { 1.0, 0.0 }
71 private static final Color OUT_OF_DOMAIN_COLOR = Color.BLACK;
73 private static final Color PATH_COLOR = new Color(220, 0, 0);
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);
81 JPanel panel = new JPanel(new MigLayout("fill"));
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);
89 throw new IllegalArgumentException("Invalid dimensionality, dim=" + modifiers.size());
91 chart.setBorder(BorderFactory.createLineBorder(Color.BLACK));
92 panel.add(chart, "span, grow, wrap para");
95 JLabel label = new StyledLabel(trans.get("lbl.zoomInstructions"), -2);
99 JButton close = new JButton(trans.get("button.close"));
100 close.addActionListener(new ActionListener() {
102 public void actionPerformed(ActionEvent e) {
103 OptimizationPlotDialog.this.setVisible(false);
106 panel.add(close, "right");
111 GUIUtil.setDisposableDialogOptions(this, close);
117 * Create a 1D plot of the optimization path.
119 private ChartPanel create1DPlot(List<Point> path, Map<Point, FunctionEvaluationData> evaluations,
120 List<SimulationModifier> modifiers, OptimizableParameter parameter, UnitGroup stabilityUnit) {
122 SimulationModifier modX = modifiers.get(0);
123 Unit xUnit = modX.getUnitGroup().getDefaultUnit();
124 Unit yUnit = parameter.getUnitGroup().getDefaultUnit();
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);
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));
138 log.error("Could not find evaluation data for point " + p);
143 String xLabel = modX.getRelatedObject().toString() + ": " + modX.getName() + " / " + xUnit.getUnit();
144 String yLabel = parameter.getName() + " / " + yUnit.getUnit();
146 JFreeChart chart = ChartFactory.createXYLineChart(
147 trans.get("plot1d.title"),
151 PlotOrientation.VERTICAL,
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);
169 XYPlot plot = chart.getXYPlot();
171 plot.setDataset(0, new XYSeriesCollection(series));
172 plot.setRenderer(lineRenderer);
176 return new ChartPanel(chart);
180 * Create a 2D plot of the optimization path.
182 private ChartPanel create2DPlot(List<Point> path, Map<Point, FunctionEvaluationData> evaluations,
183 List<SimulationModifier> modifiers, OptimizableParameter parameter, UnitGroup stabilityUnit) {
185 Unit parameterUnit = parameter.getUnitGroup().getDefaultUnit();
187 SimulationModifier modX = modifiers.get(0);
188 SimulationModifier modY = modifiers.get(1);
190 Unit xUnit = modX.getUnitGroup().getDefaultUnit();
191 Unit yUnit = modY.getUnitGroup().getDefaultUnit();
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);
199 Value[] state = data.getState();
200 series.add(xUnit.toUnit(state[0].getValue()), yUnit.toUnit(state[1].getValue()));
201 pathTooltips.add(getTooltip(data, parameter));
203 log.error("Could not find evaluation data for point " + p);
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>();
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();
220 value = parameterUnit.toUnit(data.getParameterValue().getValue());
225 Value[] state = data.getState();
226 evals[0][i] = xUnit.toUnit(state[0].getValue());
227 evals[1][i] = yUnit.toUnit(state[1].getValue());
237 evalTooltips.add(getTooltip(data, parameter));
239 DefaultXYZDataset evalDataset = new DefaultXYZDataset();
240 evalDataset.addSeries(trans.get("plot2d.evals"), evals);
244 String xLabel = modX.getRelatedObject().toString() + ": " + modX.getName() + " / " + xUnit.getUnit();
245 String yLabel = modY.getRelatedObject().toString() + ": " + modY.getName() + " / " + yUnit.getUnit();
247 JFreeChart chart = ChartFactory.createXYLineChart(
248 trans.get("plot2d.title"),
253 PlotOrientation.VERTICAL,
258 PaintScale paintScale = new GradientScale(min, max);
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);
268 shapeRenderer.getLegendItem(0, 0);
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);
283 XYPlot plot = chart.getXYPlot();
285 plot.setDataset(0, new XYSeriesCollection(series));
286 plot.setRenderer(lineRenderer);
288 plot.setDataset(1, evalDataset);
289 plot.setRenderer(1, shapeRenderer);
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);
301 return new ChartPanel(chart);
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());
313 if (data.getDomainReference() != null) {
314 ttip += trans.get("plot.ttip.stability") + " " + data.getDomainReference();
319 private class GradientScale implements PaintScale {
321 private final double min;
322 private final double max;
324 public GradientScale(double min, double max) {
330 public Paint getPaint(double value) {
331 if (Double.isNaN(value)) {
332 return OUT_OF_DOMAIN_COLOR;
335 value = MathUtil.map(value, min, max, 0.0, 1.0);
336 value = MathUtil.clamp(value, 0.0, 1.0);
338 float r = (float) RED.getValue(value);
339 float g = (float) GREEN.getValue(value);
340 float b = (float) BLUE.getValue(value);
342 return new Color(r, g, b);
346 public double getLowerBound() {
351 public double getUpperBound() {