ClassLabelFilter (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

java.lang.Object
- elki.datasource.filter.typeconversions.ClassLabelFilter

All Implemented Interfaces:

elki.datasource.filter.ObjectFilter
```
public class ClassLabelFilter
extends java.lang.Object
implements elki.datasource.filter.ObjectFilter
```
Class that turns a label column into a class label column.

Since:

0.4.0

Author:

Erich Schubert

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ClassLabelFilter.Par
Parameterization class.

Field Summary

Fields
Modifier and Type	Field	Description
`private elki.data.ClassLabel.Factory<?>`	`classLabelFactory`	The class label class to use.
`private int`	`classLabelIndex`	The index of the label to be used as class label, null if no class label is specified.

Constructor Summary

Constructors
Constructor Description

ClassLabelFilter(int classLabelIndex, elki.data.ClassLabel.Factory<?> classLabelFactory)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`elki.datasource.bundle.MultipleObjectsBundle`	`filter(elki.datasource.bundle.MultipleObjectsBundle objects)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - classLabelIndex
```
private final int classLabelIndex
```
    The index of the label to be used as class label, null if no class label is specified.
  - classLabelFactory
```
private final elki.data.ClassLabel.Factory<?> classLabelFactory
```
    The class label class to use.
- Constructor Detail
  - ClassLabelFilter
```
public ClassLabelFilter(int classLabelIndex,
                        elki.data.ClassLabel.Factory<?> classLabelFactory)
```
    Constructor.
    
    Parameters:
    
    classLabelIndex - The index to convert
    
    classLabelFactory - The class label factory to use
- Method Detail
  - filter
```
public elki.datasource.bundle.MultipleObjectsBundle filter(elki.datasource.bundle.MultipleObjectsBundle objects)
```
    Specified by:
    
    filter in interface elki.datasource.filter.ObjectFilter