de.lmu.ifi.dbs.elki.index.preprocessed.localpca
Class AbstractFilteredPCAIndex.Factory<NV extends NumberVector<NV,?>,I extends AbstractFilteredPCAIndex<NV>>

java.lang.Object
  de.lmu.ifi.dbs.elki.index.preprocessed.localpca.AbstractFilteredPCAIndex.Factory<NV,I>

All Implemented Interfaces:

IndexFactory<NV,I>, FilteredLocalPCAIndex.Factory<NV,I>, LocalProjectionIndex.Factory<NV,I>, InspectionUtilFrequentlyScanned, Parameterizable

Direct Known Subclasses:

KNNQueryFilteredPCAIndex.Factory, RangeQueryFilteredPCAIndex.Factory

Enclosing class:

AbstractFilteredPCAIndex<NV extends NumberVector<? extends NV,?>>

public abstract static class AbstractFilteredPCAIndex.Factory<NV extends NumberVector<NV,?>,I extends AbstractFilteredPCAIndex<NV>>
extends Object
implements FilteredLocalPCAIndex.Factory<NV,I>, Parameterizable

Factory class

Nested Class Summary

static class

AbstractFilteredPCAIndex.Factory.Parameterizer<NV extends NumberVector<NV,?>,I extends AbstractFilteredPCAIndex<NV>> Parameterization class.

Field Summary

protected PCAFilteredRunner<NV>	pca PCA utility object.
static OptionID	PCA_DISTANCE_ID Parameter to specify the distance function used for running PCA.
protected DistanceFunction<NV,DoubleDistance>	pcaDistanceFunction Holds the instance of the distance function specified by PCA_DISTANCE_ID.

Constructor Summary

AbstractFilteredPCAIndex.Factory(DistanceFunction<NV,DoubleDistance> pcaDistanceFunction, PCAFilteredRunner<NV> pca)
Constructor.

Method Summary

TypeInformation	getInputTypeRestriction() Get the input type restriction used for negotiating the data query.
abstract I	instantiate(Relation<NV> relation) Instantiate the index for a given database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PCA_DISTANCE_ID

public static final OptionID PCA_DISTANCE_ID

Parameter to specify the distance function used for running PCA. Key: -localpca.distancefunction

pcaDistanceFunction

protected DistanceFunction<NV extends NumberVector<NV,?>,DoubleDistance> pcaDistanceFunction

Holds the instance of the distance function specified by PCA_DISTANCE_ID.

pca

protected PCAFilteredRunner<NV extends NumberVector<NV,?>> pca

PCA utility object.

Constructor Detail

AbstractFilteredPCAIndex.Factory

public AbstractFilteredPCAIndex.Factory(DistanceFunction<NV,DoubleDistance> pcaDistanceFunction,
                                        PCAFilteredRunner<NV> pca)

Constructor.

Parameters:

pcaDistanceFunction - distance Function

pca - PCA runner

Method Detail

instantiate

public abstract I instantiate(Relation<NV> relation)

Description copied from interface: FilteredLocalPCAIndex.Factory

Instantiate the index for a given database.

Specified by:

instantiate in interface IndexFactory<NV extends NumberVector<NV,?>,I extends AbstractFilteredPCAIndex<NV>>

Specified by:

instantiate in interface FilteredLocalPCAIndex.Factory<NV extends NumberVector<NV,?>,I extends AbstractFilteredPCAIndex<NV>>

Specified by:

instantiate in interface LocalProjectionIndex.Factory<NV extends NumberVector<NV,?>,I extends AbstractFilteredPCAIndex<NV>>

Parameters:

relation - Relation to use

Returns:

Index

getInputTypeRestriction

public TypeInformation getInputTypeRestriction()

Description copied from interface: IndexFactory

Get the input type restriction used for negotiating the data query.

Specified by:

getInputTypeRestriction in interface IndexFactory<NV extends NumberVector<NV,?>,I extends AbstractFilteredPCAIndex<NV>>

Returns:

Type restriction