source: branches/DataPreprocessing Enhancements/HeuristicLab.DataPreprocessing.Views/3.4/ScatterPlotSingleView.cs @ 14724

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2016 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab 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 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab 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 HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System;
using System.Collections.Generic;
using System.Drawing;
using System.Linq;
using HeuristicLab.Analysis;
using HeuristicLab.Common;
using HeuristicLab.Core.Views;
using HeuristicLab.MainForm;
using HeuristicLab.MainForm.WindowsForms;
using RegressionType = HeuristicLab.Analysis.ScatterPlotDataRowVisualProperties.ScatterPlotDataRowRegressionType;

namespace HeuristicLab.DataPreprocessing.Views {

  [View("Scatter Plot Single View")]
  [Content(typeof(SingleScatterPlotContent), true)]
  public sealed partial class ScatterPlotSingleView : ItemView {
    private const int MAX_DISTINCT_VALUES_FOR_GROUPING = 20;
    private readonly string NoGroupItem = "";

    public new SingleScatterPlotContent Content {
      get { return (SingleScatterPlotContent)base.Content; }
      set { base.Content = value; }
    }

    public ScatterPlotSingleView() {
      InitializeComponent();

      regressionTypeComboBox.DataSource = Enum.GetValues(typeof(RegressionType));
      regressionTypeComboBox.SelectedItem = RegressionType.None;
    }

    protected override void SetEnabledStateOfControls() {
      base.SetEnabledStateOfControls();
      useGradientCheckBox.Enabled = (string)comboBoxGroup.SelectedItem != NoGroupItem;
      gradientPanel.Visible = useGradientCheckBox.Enabled && useGradientCheckBox.Checked; ;
    }

    protected override void OnContentChanged() {
      base.OnContentChanged();
      if (Content != null) {
        InitData();
      }
    }

    private void InitData() {
      IEnumerable<string> variables = Content.PreprocessingData.GetDoubleVariableNames();

      comboBoxXVariable.Items.Clear();
      comboBoxYVariable.Items.Clear();
      comboBoxGroup.Items.Clear();

      comboBoxXVariable.Items.AddRange(variables.ToArray());
      comboBoxYVariable.Items.AddRange(variables.ToArray());
      comboBoxGroup.Items.Add(NoGroupItem);
      foreach (string var in GetVariableNamesForGrouping(Content.PreprocessingData)) {
        comboBoxGroup.Items.Add(var);
      }
      comboBoxGroup.SelectedItem = Content.SelectedGroupVariable;

      // use x and y variable from content
      if (Content.SelectedXVariable != null && Content.SelectedYVariable != null && Content.SelectedGroupVariable != null) {
        comboBoxXVariable.SelectedItem = Content.SelectedXVariable;
        comboBoxYVariable.SelectedItem = Content.SelectedYVariable;
        comboBoxGroup.SelectedItem = Content.SelectedGroupVariable;
      } else {
        if (variables.Count() >= 2) {
          comboBoxXVariable.SelectedIndex = 0;
          comboBoxYVariable.SelectedIndex = 1;
          comboBoxGroup.SelectedIndex = 0;
          UpdateScatterPlot();
        }
      }
    }

    private void UpdateScatterPlot() {
      if (comboBoxXVariable.SelectedItem != null && comboBoxYVariable.SelectedItem != null && comboBoxGroup.SelectedItem != null) {
        var xVariable = (string)comboBoxXVariable.SelectedItem;
        var yVariable = (string)comboBoxYVariable.SelectedItem;
        var groupVariable = (string)comboBoxGroup.SelectedItem;

        ScatterPlot scatterPlot = Content.CreateScatterPlot(xVariable, yVariable, groupVariable);
        //rows are saved and removed to avoid firing of visual property changed events
        var rows = scatterPlot.Rows.ToList();
        scatterPlot.Rows.Clear();
        var regressionType = (RegressionType)regressionTypeComboBox.SelectedValue;
        int order = (int)polynomialRegressionOrderNumericUpDown.Value;
        foreach (var row in rows) {
          row.VisualProperties.PointSize = 6;
          row.VisualProperties.IsRegressionVisibleInLegend = false;
          row.VisualProperties.RegressionType = regressionType;
          row.VisualProperties.PolynomialRegressionOrder = order;
          row.VisualProperties.IsVisibleInLegend = !useGradientCheckBox.Checked;
        }
        scatterPlot.Rows.AddRange(rows);
        var vp = scatterPlot.VisualProperties;
        vp.Title = string.Empty;
        vp.XAxisTitle = xVariable;
        vp.YAxisTitle = yVariable;

        scatterPlotControl.Content = scatterPlot;

        //save selected x and y variable in content
        this.Content.SelectedXVariable = (string)comboBoxXVariable.SelectedItem;
        this.Content.SelectedYVariable = (string)comboBoxYVariable.SelectedItem;
        this.Content.SelectedGroupVariable = (string)comboBoxGroup.SelectedItem;
      }
    }

    private void comboBoxXVariable_SelectedIndexChanged(object sender, EventArgs e) {
      var oldPlot = scatterPlotControl.Content;
      UpdateScatterPlot();
      var newPlot = scatterPlotControl.Content;

      if (oldPlot == null || newPlot == null) return;
      newPlot.VisualProperties.YAxisMinimumAuto = oldPlot.VisualProperties.YAxisMinimumAuto;
      newPlot.VisualProperties.YAxisMaximumAuto = oldPlot.VisualProperties.YAxisMaximumAuto;
      newPlot.VisualProperties.YAxisMinimumFixedValue = oldPlot.VisualProperties.YAxisMinimumFixedValue;
      newPlot.VisualProperties.YAxisMaximumFixedValue = oldPlot.VisualProperties.YAxisMaximumFixedValue;

      foreach (var x in newPlot.Rows.Zip(oldPlot.Rows, (nr, or) => new { nr, or })) {
        var newVisuapProperties = (ScatterPlotDataRowVisualProperties)x.or.VisualProperties.Clone();
        newVisuapProperties.DisplayName = x.nr.VisualProperties.DisplayName;
        x.nr.VisualProperties = newVisuapProperties;
      }
    }

    private void comboBoxYVariable_SelectedIndexChanged(object sender, EventArgs e) {
      var oldPlot = scatterPlotControl.Content;
      UpdateScatterPlot();
      var newPlot = scatterPlotControl.Content;

      if (oldPlot == null || newPlot == null) return;
      newPlot.VisualProperties.XAxisMinimumAuto = oldPlot.VisualProperties.XAxisMinimumAuto;
      newPlot.VisualProperties.XAxisMaximumAuto = oldPlot.VisualProperties.XAxisMaximumAuto;
      newPlot.VisualProperties.XAxisMinimumFixedValue = oldPlot.VisualProperties.XAxisMinimumFixedValue;
      newPlot.VisualProperties.XAxisMaximumFixedValue = oldPlot.VisualProperties.XAxisMaximumFixedValue;

      foreach (var x in newPlot.Rows.Zip(oldPlot.Rows, (nr, or) => new { nr, or })) {
        var newVisuapProperties = (ScatterPlotDataRowVisualProperties)x.or.VisualProperties.Clone();
        newVisuapProperties.DisplayName = x.nr.VisualProperties.DisplayName;
        x.nr.VisualProperties = newVisuapProperties;
      }
    }

    private void comboBoxGroup_SelectedIndexChanged(object sender, EventArgs e) {
      useGradientCheckBox.Enabled = (string)comboBoxGroup.SelectedItem != NoGroupItem && Content.PreprocessingData.GetDoubleVariableNames().Contains((string)comboBoxGroup.SelectedItem);
      gradientPanel.Visible = useGradientCheckBox.Enabled && useGradientCheckBox.Checked;
      UpdateScatterPlot();
    }

    #region Regression Line
    private void regressionTypeComboBox_SelectedIndexChanged(object sender, EventArgs e) {
      var regressionType = (RegressionType)regressionTypeComboBox.SelectedValue;
      polynomialRegressionOrderNumericUpDown.Enabled = regressionType == RegressionType.Polynomial;

      UpdateRegressionLine();
    }

    private void polynomialRegressionOrderNumericUpDown_ValueChanged(object sender, EventArgs e) {
      UpdateRegressionLine();
    }

    private void UpdateRegressionLine() {
      if (Content == null) return;
      scatterPlotControl.Content.Rows.Clear();

      var regressionType = (RegressionType)regressionTypeComboBox.SelectedValue;
      int order = (int)polynomialRegressionOrderNumericUpDown.Value;

      var rows = scatterPlotControl.Content.Rows.ToList();
      foreach (var row in rows) {
        row.VisualProperties.IsRegressionVisibleInLegend = false;
        row.VisualProperties.RegressionType = regressionType;
        row.VisualProperties.PolynomialRegressionOrder = order;
      }
      scatterPlotControl.Content.Rows.AddRange(rows);
    }
    #endregion

    private void useGradientCheckBox_CheckedChanged(object sender, EventArgs e) {
      gradientPanel.Visible = useGradientCheckBox.Enabled && useGradientCheckBox.Checked;

      // remove rows and re-add them later to avoid firing visual property changd events
      var rows = scatterPlotControl.Content.Rows.ToDictionary(r => r.Name, r => r);
      scatterPlotControl.Content.Rows.Clear();

      if (useGradientCheckBox.Checked) {
        var groupVariable = (string)comboBoxGroup.SelectedItem;
        if (groupVariable == NoGroupItem) return;

        var groupValues = Content.PreprocessingData.GetValues<double>(Content.PreprocessingData.GetColumnIndex(groupVariable))
          .Distinct().OrderBy(x => x).ToList();
        double min = groupValues.FirstOrDefault(x => !double.IsNaN(x)), max = groupValues.LastOrDefault(x => !double.IsNaN(x));
        foreach (var group in groupValues) {
          ScatterPlotDataRow row;
          if (rows.TryGetValue(group.ToString("R"), out row)) {
            row.VisualProperties.Color = GetColor(group, min, max);
            row.VisualProperties.IsVisibleInLegend = false;
          }
        }
        gradientMinimumLabel.Text = min.ToString("G5");
        gradientMaximumLabel.Text = max.ToString("G5");
      } else {
        foreach (var row in rows.Values) {
          row.VisualProperties.Color = Color.Empty;
          row.VisualProperties.IsVisibleInLegend = true;
        }
      }
      scatterPlotControl.Content.Rows.AddRange(rows.Values);
    }

    private static Color GetColor(double value, double min, double max) {
      if (double.IsNaN(value)) {
        return Color.Black;
      }
      var colors = ColorGradient.Colors;
      int index = (int)((colors.Count - 1) * (value - min) / (max - min));
      if (index >= colors.Count) index = colors.Count - 1;
      if (index < 0) index = 0;
      return colors[index];
    }

    private static IEnumerable<string> GetVariableNamesForGrouping(IPreprocessingData preprocessingData) {
      var variableNames = new List<string>();

      for (int i = 0; i < preprocessingData.Columns; ++i) {
        int distinctValues = Int32.MaxValue;
        if (preprocessingData.VariableHasType<double>(i))
          distinctValues = preprocessingData.GetValues<double>(i).GroupBy(x => x).Count();
        else if (preprocessingData.VariableHasType<string>(i))
          distinctValues = preprocessingData.GetValues<string>(i).GroupBy(x => x).Count();
        else if (preprocessingData.VariableHasType<DateTime>(i))
          distinctValues = preprocessingData.GetValues<DateTime>(i).GroupBy(x => x).Count();

        if (distinctValues <= MAX_DISTINCT_VALUES_FOR_GROUPING)
          variableNames.Add(preprocessingData.GetVariableName(i));
      }
      return variableNames;
    }
  }
}