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 de.lmu.ifi.dbs.elki.data.NumberVector;
import de.lmu.ifi.dbs.elki.data.type.TypeUtil;
import de.lmu.ifi.dbs.elki.database.relation.Relation;
import de.lmu.ifi.dbs.elki.result.HierarchicalResult;
import de.lmu.ifi.dbs.elki.result.Result;
import de.lmu.ifi.dbs.elki.result.ResultUtil;
import de.lmu.ifi.dbs.elki.utilities.DatabaseUtil;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.OptionID;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.GreaterEqualConstraint;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.Parameterization;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.IntParameter;
/**
* Produce scatterplot projections.
*
* @author Erich Schubert
*
* @apiviz.has ScatterPlotProjector
*/
public class ScatterPlotFactory implements ProjectorFactory {
/**
* Maximum number of dimensions to visualize.
*
* TODO: Erich: add scrolling function for higher dimensionality!
*/
public static final int MAX_DIMENSIONS_DEFAULT = 10;
/**
* Stores the maximum number of dimensions to show.
*/
private int maxdim = MAX_DIMENSIONS_DEFAULT;
/**
* Constructor.
*
* @param maxdim Maximum number of dimensions to show.
*/
public ScatterPlotFactory(int maxdim) {
super();
this.maxdim = maxdim;
}
@Override
public void processNewResult(HierarchicalResult baseResult, Result newResult) {
ArrayList<Relation<?>> rels = ResultUtil.filterResults(newResult, Relation.class);
for(Relation<?> rel : rels) {
if(TypeUtil.NUMBER_VECTOR_FIELD.isAssignableFromType(rel.getDataTypeInformation())) {
@SuppressWarnings("unchecked")
Relation<NumberVector<?, ?>> vrel = (Relation<NumberVector<?, ?>>) rel;
final int dim = DatabaseUtil.dimensionality(vrel);
ScatterPlotProjector<NumberVector<?, ?>> proj = new ScatterPlotProjector<NumberVector<?, ?>>(vrel, Math.min(maxdim, dim));
baseResult.getHierarchy().add(vrel, proj);
}
}
}
/**
* Parameterization class.
*
* @author Erich Schubert
*
* @apiviz.exclude
*/
public static class Parameterizer extends AbstractParameterizer {
/**
* Parameter for the maximum number of dimensions,
*
* <p>
* Code: -vis.maxdim
* </p>
*/
public static final OptionID MAXDIM_ID = OptionID.getOrCreateOptionID("vis.maxdim", "Maximum number of dimensions to display.");
/**
* Stores the maximum number of dimensions to show.
*/
private int maxdim = MAX_DIMENSIONS_DEFAULT;
@Override
protected void makeOptions(Parameterization config) {
super.makeOptions(config);
IntParameter maxdimP = new IntParameter(MAXDIM_ID, new GreaterEqualConstraint(1), MAX_DIMENSIONS_DEFAULT);
if(config.grab(maxdimP)) {
maxdim = maxdimP.getValue();
}
}
@Override
protected ScatterPlotFactory makeInstance() {
return new ScatterPlotFactory(maxdim);
}
}
}