summaryrefslogtreecommitdiff
path: root/src/de/lmu/ifi/dbs/elki/visualization/projector/ScatterPlotProjector.java
blob: 755b6fd223a948a74565963a6b247f6619e6f26a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
package de.lmu.ifi.dbs.elki.visualization.projector;

/*
 This file is part of ELKI:
 Environment for Developing KDD-Applications Supported by Index-Structures

 Copyright (C) 2012
 Ludwig-Maximilians-Universität München
 Lehr- und Forschungseinheit für Datenbanksysteme
 ELKI Development Team

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program 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 Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import de.lmu.ifi.dbs.elki.data.NumberVector;
import de.lmu.ifi.dbs.elki.database.relation.Relation;
import de.lmu.ifi.dbs.elki.math.linearalgebra.AffineTransformation;
import de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult;
import de.lmu.ifi.dbs.elki.result.ResultUtil;
import de.lmu.ifi.dbs.elki.result.ScalesResult;
import de.lmu.ifi.dbs.elki.utilities.DatabaseUtil;
import de.lmu.ifi.dbs.elki.visualization.VisualizationTask;
import de.lmu.ifi.dbs.elki.visualization.gui.overview.PlotItem;
import de.lmu.ifi.dbs.elki.visualization.projections.AffineProjection;
import de.lmu.ifi.dbs.elki.visualization.projections.Projection2D;
import de.lmu.ifi.dbs.elki.visualization.projections.Simple2D;
import de.lmu.ifi.dbs.elki.visualization.visualizers.visunproj.LabelVisFactory;

/**
 * ScatterPlotProjector is responsible for producing a set of scatterplot
 * visualizations.
 * 
 * @author Erich Schubert
 * 
 * @apiviz.has LinearScale
 * 
 * @param <V> Vector type
 */
public class ScatterPlotProjector<V extends NumberVector<?, ?>> extends AbstractHierarchicalResult implements Projector {
  /**
   * Relation we project
   */
  Relation<V> rel;

  /**
   * Database dimensionality
   */
  int dmax;

  /**
   * Constructor.
   * 
   * @param rel Relation
   * @param maxdim Maximum dimension to use
   */
  public ScatterPlotProjector(Relation<V> rel, int maxdim) {
    super();
    this.rel = rel;
    this.dmax = maxdim;
    assert (maxdim <= DatabaseUtil.dimensionality(rel)) : "Requested dimensionality larger than data dimensionality?!?";
  }

  @Override
  public Collection<PlotItem> arrange() {
    List<PlotItem> layout = new ArrayList<PlotItem>(1);
    List<VisualizationTask> tasks = ResultUtil.filterResults(this, VisualizationTask.class);
    if(tasks.size() > 0) {
      ScalesResult scales = ResultUtil.getScalesResult(rel);
      final PlotItem master;
      if(dmax == 2) {
        // In 2d, make the plot twice as big.
        master = new PlotItem(2 + .1, 2 + .1, null);
        {
          Projection2D proj = new Simple2D(scales.getScales(), 1, 2);
          PlotItem it = new PlotItem(.1, 0, 2., 2., proj);
          it.tasks = tasks;
          master.subitems.add(it);
        }
        // Label at bottom
        {
          PlotItem it = new PlotItem(.1, 2., 2., .1, null);
          final VisualizationTask task = new VisualizationTask("", null, null, new LabelVisFactory(DatabaseUtil.getColumnLabel(rel, 1)));
          task.height = .1;
          task.width = 2.;
          task.put(VisualizationTask.META_NODETAIL, true);
          it.tasks.add(task);
          master.subitems.add(it);
        }
        // Label on left
        {
          PlotItem it = new PlotItem(0, 0, .1, 2, null);
          final VisualizationTask task = new VisualizationTask("", null, null, new LabelVisFactory(DatabaseUtil.getColumnLabel(rel, 2), true));
          task.height = 2.;
          task.width = .1;
          task.put(VisualizationTask.META_NODETAIL, true);
          it.tasks.add(task);
          master.subitems.add(it);
        }
      }
      else {
        final double sizeh = Math.ceil((dmax - 1) / 2.0);
        master = new PlotItem(sizeh * 2 + .1, dmax - 1 + .1, null);

        for(int d1 = 1; d1 < dmax; d1++) {
          for(int d2 = d1 + 1; d2 <= dmax; d2++) {
            Projection2D proj = new Simple2D(scales.getScales(), d1, d2);
            PlotItem it = new PlotItem(d1 - 1 + .1, d2 - 2, 1., 1., proj);
            it.tasks = tasks;
            master.subitems.add(it);
          }
        }
        if(dmax >= 3) {
          AffineTransformation p = AffineProjection.axisProjection(DatabaseUtil.dimensionality(rel), 1, 2);
          p.addRotation(0, 2, Math.PI / 180 * -10.);
          p.addRotation(1, 2, Math.PI / 180 * 15.);
          // Wanna try 4d? go ahead:
          // p.addRotation(0, 3, Math.PI / 180 * -20.);
          // p.addRotation(1, 3, Math.PI / 180 * 30.);
          Projection2D proj = new AffineProjection(scales.getScales(), p);
          PlotItem it = new PlotItem(sizeh + .1, 0, sizeh, sizeh, proj);
          it.tasks = tasks;
          master.subitems.add(it);
        }
        // Labels at bottom
        for(int d1 = 1; d1 < dmax; d1++) {
          PlotItem it = new PlotItem(d1 - 1 + .1, dmax - 1, 1., .1, null);
          final VisualizationTask task = new VisualizationTask("", null, null, new LabelVisFactory(DatabaseUtil.getColumnLabel(rel, d1)));
          task.height = .1;
          task.width = 1;
          task.put(VisualizationTask.META_NODETAIL, true);
          it.tasks.add(task);
          master.subitems.add(it);
        }
        // Labels on left
        for(int d2 = 2; d2 <= dmax; d2++) {
          PlotItem it = new PlotItem(0, d2 - 2, .1, 1, null);
          final VisualizationTask task = new VisualizationTask("", null, null, new LabelVisFactory(DatabaseUtil.getColumnLabel(rel, d2), true));
          task.height = 1;
          task.width = .1;
          task.put(VisualizationTask.META_NODETAIL, true);
          it.tasks.add(task);
          master.subitems.add(it);
        }
      }

      layout.add(master);
    }
    return layout;
  }

  @Override
  public String getLongName() {
    return "Scatterplot";
  }

  @Override
  public String getShortName() {
    return "scatterplot";
  }

  /**
   * The relation we project.
   * 
   * @return Relation
   */
  public Relation<V> getRelation() {
    return rel;
  }
}