Import Upstream version 0.4.0~beta1

1 files changed, 330 insertions, 0 deletions

diff --git a/src/de/lmu/ifi/dbs/elki/visualization/visualizers/vis2d/SelectionToolCubeVisualization.java b/src/de/lmu/ifi/dbs/elki/visualization/visualizers/vis2d/SelectionToolCubeVisualization.java
new file mode 100644
index 00000000..c5f1b3f9
--- /dev/null
+++ b/src/de/lmu/ifi/dbs/elki/visualization/visualizers/vis2d/SelectionToolCubeVisualization.java
@@ -0,0 +1,330 @@
+package de.lmu.ifi.dbs.elki.visualization.visualizers.vis2d;

+/*
+This file is part of ELKI:
+Environment for Developing KDD-Applications Supported by Index-Structures
+
+Copyright (C) 2011
+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.BitSet;

+import java.util.Iterator;

+

+import org.apache.batik.util.SVGConstants;

+import org.w3c.dom.Element;

+import org.w3c.dom.events.Event;

+import org.w3c.dom.svg.SVGPoint;

+

+import de.lmu.ifi.dbs.elki.data.NumberVector;

+import de.lmu.ifi.dbs.elki.database.ids.DBID;

+import de.lmu.ifi.dbs.elki.database.ids.DBIDUtil;

+import de.lmu.ifi.dbs.elki.database.ids.ModifiableDBIDs;

+import de.lmu.ifi.dbs.elki.database.relation.Relation;

+import de.lmu.ifi.dbs.elki.logging.Logging;

+import de.lmu.ifi.dbs.elki.math.linearalgebra.Vector;

+import de.lmu.ifi.dbs.elki.result.DBIDSelection;

+import de.lmu.ifi.dbs.elki.result.HierarchicalResult;

+import de.lmu.ifi.dbs.elki.result.RangeSelection;

+import de.lmu.ifi.dbs.elki.result.Result;

+import de.lmu.ifi.dbs.elki.result.ResultUtil;

+import de.lmu.ifi.dbs.elki.result.SelectionResult;

+import de.lmu.ifi.dbs.elki.utilities.DatabaseUtil;

+import de.lmu.ifi.dbs.elki.utilities.iterator.IterableUtil;

+import de.lmu.ifi.dbs.elki.utilities.pairs.DoubleDoublePair;

+import de.lmu.ifi.dbs.elki.visualization.batikutil.DragableArea;

+import de.lmu.ifi.dbs.elki.visualization.css.CSSClass;

+import de.lmu.ifi.dbs.elki.visualization.projections.Projection;

+import de.lmu.ifi.dbs.elki.visualization.projections.Projection2D;

+import de.lmu.ifi.dbs.elki.visualization.style.StyleLibrary;

+import de.lmu.ifi.dbs.elki.visualization.svg.SVGPlot;

+import de.lmu.ifi.dbs.elki.visualization.svg.SVGUtil;

+import de.lmu.ifi.dbs.elki.visualization.visualizers.AbstractVisFactory;

+import de.lmu.ifi.dbs.elki.visualization.visualizers.Visualization;

+import de.lmu.ifi.dbs.elki.visualization.visualizers.VisualizationTask;

+import de.lmu.ifi.dbs.elki.visualization.visualizers.VisualizerUtil;

+import de.lmu.ifi.dbs.elki.visualization.visualizers.events.ContextChangedEvent;

+

+/**

+ * Tool-Visualization for the tool to select ranges

+ * 

+ * @author Heidi Kolb

+ * 

+ * @apiviz.has SelectionResult oneway - - updates

+ * @apiviz.has RangeSelection oneway - - updates

+ * 

+ * @param <NV> Type of the NumberVector being visualized.

+ */

+public class SelectionToolCubeVisualization<NV extends NumberVector<NV, ?>> extends P2DVisualization<NV> implements DragableArea.DragListener {

+  /**

+   * The logger for this class.

+   */

+  protected static final Logging logger = Logging.getLogger(SelectionToolCubeVisualization.class);

+

+  /**

+   * A short name characterizing this Visualizer.

+   */

+  private static final String NAME = "Range Selection";

+

+  /**

+   * Generic tag to indicate the type of element. Used in IDs, CSS-Classes etc.

+   */

+  private static final String CSS_RANGEMARKER = "selectionRangeMarker";

+

+  /**

+   * Dimension

+   */

+  private int dim;

+

+  /**

+   * Element for selection rectangle

+   */

+  private Element rtag;

+

+  /**

+   * Element for the rectangle to add listeners

+   */

+  private Element etag;

+

+  /**

+   * Our result

+   */

+  private SelectionResult result;

+

+  /**

+   * Constructor.

+   * 

+   * @param task Task

+   */

+  public SelectionToolCubeVisualization(VisualizationTask task) {

+    super(task);

+    this.result = task.getResult();

+    this.dim = DatabaseUtil.dimensionality(rep);

+    context.addContextChangeListener(this);

+    incrementalRedraw();

+  }

+

+  @Override

+  public void destroy() {

+    super.destroy();

+    context.removeContextChangeListener(this);

+  }

+

+  @Override

+  public void contextChanged(@SuppressWarnings("unused") ContextChangedEvent e) {

+    synchronizedRedraw();

+  }

+

+  @Override

+  protected void redraw() {

+    addCSSClasses(svgp);

+

+    // rtag: tag for the selected rect

+    rtag = svgp.svgElement(SVGConstants.SVG_G_TAG);

+    SVGUtil.addCSSClass(rtag, CSS_RANGEMARKER);

+    layer.appendChild(rtag);

+

+    // etag: sensitive area

+    DragableArea drag = new DragableArea(svgp, -0.6 * StyleLibrary.SCALE, -0.7 * StyleLibrary.SCALE, 1.3 * StyleLibrary.SCALE, 1.4 * StyleLibrary.SCALE, this);

+    etag = drag.getElement();

+    layer.appendChild(etag);

+  }

+

+  /**

+   * Delete the children of the element

+   * 

+   * @param container SVG-Element

+   */

+  private void deleteChildren(Element container) {

+    while(container.hasChildNodes()) {

+      container.removeChild(container.getLastChild());

+    }

+  }

+

+  /**

+   * Set the selected ranges and the mask for the actual dimensions in the

+   * context

+   * 

+   * @param x1 x-value of the first dimension

+   * @param x2 x-value of the second dimension

+   * @param y1 y-value of the first dimension

+   * @param y2 y-value of the second dimension

+   */

+  private void updateSelectionRectKoordinates(double x1, double x2, double y1, double y2, DoubleDoublePair[] ranges) {

+    BitSet actDim = proj.getVisibleDimensions2D();

+    Vector v1 = new Vector(dim);

+    Vector v2 = new Vector(dim);

+    v1.set(0, x1);

+    v1.set(1, y1);

+    v2.set(0, x2);

+    v2.set(1, y2);

+

+    NV factory = DatabaseUtil.assumeVectorField(rep).getFactory();

+

+    NV nv1 = proj.projectRenderToDataSpace(v1, factory);

+    NV nv2 = proj.projectRenderToDataSpace(v2, factory);

+

+    for(int d = actDim.nextSetBit(0); d >= 0; d = actDim.nextSetBit(d + 1)) {

+      ranges[d] = new DoubleDoublePair(Math.min(nv1.doubleValue(d + 1), nv2.doubleValue(d + 1)), Math.max(nv1.doubleValue(d + 1), nv2.doubleValue(d + 1)));

+    }

+  }

+

+  @Override

+  public boolean startDrag(@SuppressWarnings("unused") SVGPoint startPoint, @SuppressWarnings("unused") Event evt) {

+    return true;

+  }

+

+  @Override

+  public boolean duringDrag(SVGPoint startPoint, SVGPoint dragPoint, @SuppressWarnings("unused") Event evt, @SuppressWarnings("unused") boolean inside) {

+    deleteChildren(rtag);

+    double x = Math.min(startPoint.getX(), dragPoint.getX());

+    double y = Math.min(startPoint.getY(), dragPoint.getY());

+    double width = Math.abs(startPoint.getX() - dragPoint.getX());

+    double height = Math.abs(startPoint.getY() - dragPoint.getY());

+    rtag.appendChild(svgp.svgRect(x, y, width, height));

+    return true;

+  }

+

+  @Override

+  public boolean endDrag(SVGPoint startPoint, SVGPoint dragPoint, @SuppressWarnings("unused") Event evt, @SuppressWarnings("unused") boolean inside) {

+    deleteChildren(rtag);

+    if(startPoint.getX() != dragPoint.getX() || startPoint.getY() != dragPoint.getY()) {

+      updateSelection(proj, startPoint, dragPoint);

+    }

+    return true;

+  }

+

+  /**

+   * Update the selection in the context.

+   * 

+   * @param proj The projection

+   * @param p1 First Point of the selected rectangle

+   * @param p2 Second Point of the selected rectangle

+   */

+  private void updateSelection(Projection proj, SVGPoint p1, SVGPoint p2) {

+    DBIDSelection selContext = context.getSelection();

+    ModifiableDBIDs selection;

+    if(selContext != null) {

+      selection = DBIDUtil.newHashSet(selContext.getSelectedIds());

+    }

+    else {

+      selection = DBIDUtil.newHashSet();

+    }

+    DoubleDoublePair[] ranges;

+

+    if(p1 == null || p2 == null) {

+      logger.warning("no rect selected: p1: " + p1 + " p2: " + p2);

+    }

+    else {

+      double x1 = Math.min(p1.getX(), p2.getX());

+      double x2 = Math.max(p1.getX(), p2.getX());

+      double y1 = Math.max(p1.getY(), p2.getY());

+      double y2 = Math.min(p1.getY(), p2.getY());

+

+      if(selContext instanceof RangeSelection) {

+        ranges = ((RangeSelection) selContext).getRanges();

+      }

+      else {

+        ranges = new DoubleDoublePair[dim];

+      }

+      updateSelectionRectKoordinates(x1, x2, y1, y2, ranges);

+

+      selection.clear();

+      boolean idIn = true;

+      for(DBID id : rep.iterDBIDs()) {

+        NV dbTupel = rep.get(id);

+        idIn = true;

+        for(int i = 0; i < dim; i++) {

+          if(ranges != null && ranges[i] != null) {

+            if(dbTupel.doubleValue(i + 1) < ranges[i].first || dbTupel.doubleValue(i + 1) > ranges[i].second) {

+              idIn = false;

+              break;

+            }

+          }

+        }

+        if(idIn == true) {

+          selection.add(id);

+        }

+      }

+      context.setSelection(new RangeSelection(selection, ranges));

+    }

+  }

+

+  /**

+   * Adds the required CSS-Classes

+   * 

+   * @param svgp SVG-Plot

+   */

+  protected void addCSSClasses(SVGPlot svgp) {

+    // Class for the range marking

+    if(!svgp.getCSSClassManager().contains(CSS_RANGEMARKER)) {

+      final CSSClass rcls = new CSSClass(this, CSS_RANGEMARKER);

+      final StyleLibrary style = context.getStyleLibrary();

+      rcls.setStatement(SVGConstants.CSS_FILL_PROPERTY, style.getColor(StyleLibrary.SELECTION_ACTIVE));

+      rcls.setStatement(SVGConstants.CSS_OPACITY_PROPERTY, style.getOpacity(StyleLibrary.SELECTION_ACTIVE));

+      svgp.addCSSClassOrLogError(rcls);

+    }

+  }

+

+  /**

+   * Factory for tool visualizations for selecting ranges and the inclosed

+   * objects

+   * 

+   * @author Heidi Kolb

+   * 

+   * @apiviz.stereotype factory

+   * @apiviz.uses SelectionToolCubeVisualization oneway - - «create»

+   * 

+   * @param <NV> Type of the NumberVector being visualized.

+   */

+  public static class Factory<NV extends NumberVector<NV, ?>> extends AbstractVisFactory {

+    /**

+     * Constructor, adhering to

+     * {@link de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameterizable}

+     */

+    public Factory() {

+      super();

+    }

+

+    @Override

+    public Visualization makeVisualization(VisualizationTask task) {

+      return new SelectionToolCubeVisualization<NV>(task);

+    }

+

+    @Override

+    public void processNewResult(HierarchicalResult baseResult, Result result) {

+      Iterator<Relation<? extends NumberVector<?, ?>>> reps = VisualizerUtil.iterateVectorFieldRepresentations(baseResult);

+      for(Relation<? extends NumberVector<?, ?>> rep : IterableUtil.fromIterator(reps)) {

+        final ArrayList<SelectionResult> selectionResults = ResultUtil.filterResults(result, SelectionResult.class);

+        for(SelectionResult selres : selectionResults) {

+          final VisualizationTask task = new VisualizationTask(NAME, selres, rep, this, P2DVisualization.class);

+          task.put(VisualizationTask.META_LEVEL, VisualizationTask.LEVEL_INTERACTIVE);

+          task.put(VisualizationTask.META_TOOL, true);

+          task.put(VisualizationTask.META_NOTHUMB, true);

+          task.put(VisualizationTask.META_NOEXPORT, true);

+          baseResult.getHierarchy().add(selres, task);

+        }

+      }

+    }

+

+    @Override

+    public Class<? extends Projection> getProjectionType() {

+      return Projection2D.class;

+    }

+  }

+}
\ No newline at end of file