de.lmu.ifi.dbs.elki.index.preprocessed.localpca

Class AbstractFilteredPCAIndex<NV extends NumberVector<?>>

java.lang.Object

de.lmu.ifi.dbs.elki.index.AbstractIndex<O>

de.lmu.ifi.dbs.elki.index.preprocessed.AbstractPreprocessorIndex<NV,PCAFilteredResult>

de.lmu.ifi.dbs.elki.index.preprocessed.localpca.AbstractFilteredPCAIndex<NV>

Type Parameters:

NV - Vector type

All Implemented Interfaces:

Index, FilteredLocalPCAIndex<NV>, LocalProjectionIndex<NV,PCAFilteredResult>, Result

Direct Known Subclasses:

KNNQueryFilteredPCAIndex, RangeQueryFilteredPCAIndex

@Title(value="Local PCA Preprocessor")
@Description(value="Materializes the local PCA and the locally weighted matrix of objects of a database.")
public abstract class AbstractFilteredPCAIndex<NV extends NumberVector<?>>
extends AbstractPreprocessorIndex<NV,PCAFilteredResult>
implements FilteredLocalPCAIndex<NV>

Abstract base class for a local PCA based index.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractFilteredPCAIndex.Factory<NV extends NumberVector<?>,I extends AbstractFilteredPCAIndex<NV>> Factory class.

Field Summary

Fields

Modifier and Type	Field and Description
protected PCAFilteredRunner<NV>	pca PCA utility object.

Fields inherited from class de.lmu.ifi.dbs.elki.index.preprocessed.AbstractPreprocessorIndex

storage

Fields inherited from class de.lmu.ifi.dbs.elki.index.AbstractIndex

relation

Constructor Summary

Constructors

Constructor and Description
AbstractFilteredPCAIndex(Relation<NV> relation, PCAFilteredRunner<NV> pca) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
PCAFilteredResult	getLocalProjection(DBIDRef objid) Get the precomputed local PCA for a particular object ID.
void	initialize() Initialize the index.
protected abstract DistanceDBIDList<DoubleDistance>	objectsForPCA(DBIDRef id) Returns the objects to be considered within the PCA for the specified query object.

Methods inherited from class de.lmu.ifi.dbs.elki.index.preprocessed.AbstractPreprocessorIndex

getLogger

Methods inherited from class de.lmu.ifi.dbs.elki.index.AbstractIndex

getLongName, getShortName

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.lmu.ifi.dbs.elki.index.Index

logStatistics

Methods inherited from interface de.lmu.ifi.dbs.elki.result.Result

getLongName, getShortName

Field Detail

pca

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

PCA utility object.

Constructor Detail

AbstractFilteredPCAIndex

public AbstractFilteredPCAIndex(Relation<NV> relation,
                        PCAFilteredRunner<NV> pca)

Constructor.

Parameters:

relation - Relation to use

pca - PCA runner to use

Method Detail

initialize

public void initialize()

Description copied from interface: Index

Initialize the index. For static indexes, this is the moment the index is bulk loaded.

Specified by:

initialize in interface Index

getLocalProjection

public PCAFilteredResult getLocalProjection(DBIDRef objid)

Description copied from interface: FilteredLocalPCAIndex

Get the precomputed local PCA for a particular object ID.

Specified by:

getLocalProjection in interface FilteredLocalPCAIndex<NV extends NumberVector<?>>

Specified by:

getLocalProjection in interface LocalProjectionIndex<NV extends NumberVector<?>,PCAFilteredResult>

Parameters:

objid - Object ID

Returns:

Matrix

objectsForPCA

protected abstract DistanceDBIDList<DoubleDistance> objectsForPCA(DBIDRef id)

Returns the objects to be considered within the PCA for the specified query object.

Parameters:

id - the id of the query object for which a PCA should be performed

Returns:

the list of the objects (i.e. the ids and the distances to the query object) to be considered within the PCA