package de.lmu.ifi.dbs.elki.evaluation.clustering.extractor;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2015
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 .
*/
import java.util.ArrayList;
import de.lmu.ifi.dbs.elki.algorithm.clustering.hierarchical.PointerDensityHierarchyRepresentationResult;
import de.lmu.ifi.dbs.elki.algorithm.clustering.hierarchical.PointerHierarchyRepresentationResult;
import de.lmu.ifi.dbs.elki.algorithm.clustering.hierarchical.extraction.SimplifiedHierarchyExtraction;
import de.lmu.ifi.dbs.elki.data.Clustering;
import de.lmu.ifi.dbs.elki.data.model.DendrogramModel;
import de.lmu.ifi.dbs.elki.database.datastore.DBIDDataStore;
import de.lmu.ifi.dbs.elki.database.datastore.DoubleDataStore;
import de.lmu.ifi.dbs.elki.database.ids.DBIDs;
import de.lmu.ifi.dbs.elki.evaluation.Evaluator;
import de.lmu.ifi.dbs.elki.evaluation.clustering.extractor.ExtractFlatClusteringFromHierarchyEvaluator.DummyHierarchicalClusteringAlgorithm;
import de.lmu.ifi.dbs.elki.result.Result;
import de.lmu.ifi.dbs.elki.result.ResultHierarchy;
import de.lmu.ifi.dbs.elki.result.ResultUtil;
import de.lmu.ifi.dbs.elki.utilities.ClassGenericsUtil;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.ChainedParameterization;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.ListParameterization;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.Parameterization;
import de.lmu.ifi.dbs.elki.workflow.AlgorithmStep;
/**
* Extract clusters from a hierarchical clustering, during the evaluation phase.
*
* Usually, it is more elegant to use {@link SimplifiedHierarchyExtraction} as
* primary algorithm. But in order to extract multiple partitionings
* from the same clustering, this can be useful.
*
* @author Erich Schubert
*/
public class SimplifiedHierarchyExtractionEvaluator implements Evaluator {
/**
* Class to perform the cluster extraction.
*/
private SimplifiedHierarchyExtraction inner;
/**
* Constructor.
*
* @param inner Inner algorithm instance.
*/
public SimplifiedHierarchyExtractionEvaluator(SimplifiedHierarchyExtraction inner) {
this.inner = inner;
}
@Override
public void processNewResult(ResultHierarchy hier, Result newResult) {
ArrayList hrs = ResultUtil.filterResults(hier, newResult, PointerHierarchyRepresentationResult.class);
for(PointerHierarchyRepresentationResult pointerresult : hrs) {
DBIDs ids = pointerresult.getDBIDs();
DBIDDataStore pi = pointerresult.getParentStore();
DoubleDataStore lambda = pointerresult.getParentDistanceStore();
DoubleDataStore coredist = null;
if(pointerresult instanceof PointerDensityHierarchyRepresentationResult) {
coredist = ((PointerDensityHierarchyRepresentationResult) pointerresult).getCoreDistanceStore();
}
Clustering result = inner.extractClusters(ids, pi, lambda, coredist);
pointerresult.addChildResult(result);
}
}
/**
* Parameterization class.
*
* @author Erich Schubert
*
* @apiviz.exclude
*/
public static class Parameterizer extends AbstractParameterizer {
/**
* Inner algorithm to extract a clustering.
*/
SimplifiedHierarchyExtraction inner;
@Override
protected void makeOptions(Parameterization config) {
super.makeOptions(config);
ListParameterization overrides = new ListParameterization();
overrides.addParameter(AlgorithmStep.Parameterizer.ALGORITHM_ID, DummyHierarchicalClusteringAlgorithm.class);
ChainedParameterization list = new ChainedParameterization(overrides, config);
inner = ClassGenericsUtil.parameterizeOrAbort(SimplifiedHierarchyExtraction.class, list);
}
@Override
protected SimplifiedHierarchyExtractionEvaluator makeInstance() {
return new SimplifiedHierarchyExtractionEvaluator(inner);
}
}
}