RemoveAttributeTransform (Java Statistical Analysis Tool 0.0.8 API)

java.lang.Object
- jsat.datatransform.RemoveAttributeTransform

All Implemented Interfaces:

Serializable, Cloneable, DataTransform

Direct Known Subclasses:

MutualInfoFS, ReliefF, SBS
```
public class RemoveAttributeTransform
extends Object
implements DataTransform
```
This Data Transform allows the complete removal of specific features from the data set.

Author:

Edward Raff

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected int[] catIndexMap

protected int[] numIndexMap

Fields
Modifier and Type	Field and Description
`protected int[]`	`catIndexMap`
`protected int[]`	`numIndexMap`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`RemoveAttributeTransform()` Empty constructor that may be used by extending classes.
	`RemoveAttributeTransform(DataSet dataSet, Set<Integer> categoricalToRemove, Set<Integer> numericalToRemove)` Creates a new transform for removing specified features from a data set
`protected`	`RemoveAttributeTransform(RemoveAttributeTransform other)` Copy constructor
	`RemoveAttributeTransform(Set<Integer> categoricalToRemove, Set<Integer> numericalToRemove)` Creates a new transform for removing specified features from a data set.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RemoveAttributeTransform`	`clone()`
`void`	`consolidate(RemoveAttributeTransform preceding)` A serious of Remove Attribute Transforms may be learned and applied sequentially to a single data set.
`void`	`fit(DataSet data)` Fits this transform to the given dataset.
`List<Integer>`	`getKeptNominal()` Returns an unmodifiable list of the original indices of the nominal attributes that will be kept when this transform is applied.
`List<Integer>`	`getKeptNumeric()` Returns an unmodifiable list of the original indices of the numeric attributes that will be kept when this transform is applied.
`Map<Integer,Integer>`	`getReverseNominalMap()` Returns a mapping from the nominal indices in the transformed space back to their original indices
`Map<Integer,Integer>`	`getReverseNumericMap()` Returns a mapping from the numeric indices in the transformed space back to their original indices
`protected void`	`setUp(DataSet dataSet, Set<Integer> categoricalToRemove, Set<Integer> numericalToRemove)` Sets up the Remove Attribute Transform properly
`DataPoint`	`transform(DataPoint dp)` Returns a new data point that is a transformation of the original data point.

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

- Field Detail
  - catIndexMap
```
protected int[] catIndexMap
```
  - numIndexMap
```
protected int[] numIndexMap
```
- Constructor Detail
  - RemoveAttributeTransform
```
protected RemoveAttributeTransform()
```
    Empty constructor that may be used by extending classes. Transforms that extend this will need to call setUp(jsat.DataSet, java.util.Set, java.util.Set) once the attributes to remove have been selected
  - RemoveAttributeTransform
```
public RemoveAttributeTransform(Set<Integer> categoricalToRemove,
                                Set<Integer> numericalToRemove)
```
    Creates a new transform for removing specified features from a data set. Needs to still call fit(jsat.DataSet) before ready to be used.
    
    Parameters:
    
    categoricalToRemove - the set of categorical attributes to remove, in the rage of [0, DataSet.getNumCategoricalVars()).
    
    numericalToRemove - the set of numerical attributes to remove, in the rage of [0, DataSet.getNumNumericalVars()).
  - RemoveAttributeTransform
```
public RemoveAttributeTransform(DataSet dataSet,
                                Set<Integer> categoricalToRemove,
                                Set<Integer> numericalToRemove)
```
    Creates a new transform for removing specified features from a data set
    
    Parameters:
    
    dataSet - the data set that this transform is meant for
    
    categoricalToRemove - the set of categorical attributes to remove, in the rage of [0, DataSet.getNumCategoricalVars()).
    
    numericalToRemove - the set of numerical attributes to remove, in the rage of [0, DataSet.getNumNumericalVars()).
  - RemoveAttributeTransform
```
protected RemoveAttributeTransform(RemoveAttributeTransform other)
```
    Copy constructor
    
    Parameters:
    
    other - the transform to copy
- Method Detail
  - getKeptNumeric
```
public List<Integer> getKeptNumeric()
```
    Returns an unmodifiable list of the original indices of the numeric attributes that will be kept when this transform is applied.
    
    Returns:
    
    the numeric indices that are not removed by this transform
  - getReverseNumericMap
```
public Map<Integer,Integer> getReverseNumericMap()
```
    Returns a mapping from the numeric indices in the transformed space back to their original indices
    
    Returns:
    
    a mapping from the transformed numeric space to the original one
  - getKeptNominal
```
public List<Integer> getKeptNominal()
```
    Returns an unmodifiable list of the original indices of the nominal attributes that will be kept when this transform is applied.
    
    Returns:
    
    the nominal indices that are not removed by this transform
  - getReverseNominalMap
```
public Map<Integer,Integer> getReverseNominalMap()
```
    Returns a mapping from the nominal indices in the transformed space back to their original indices
    
    Returns:
    
    a mapping from the transformed nominal space to the original one
  - fit
```
public void fit(DataSet data)
```
    Description copied from interface: DataTransform
    
    Fits this transform to the given dataset. Some transforms can only be learned from classification or regression datasets. If an incompatible dataset type is given, a FailedToFitException exception may be thrown.
    
    Specified by:
    
    fit in interface DataTransform
    
    Parameters:
    
    data - the dataset to fir this transform to
  - setUp
```
protected final void setUp(DataSet dataSet,
                           Set<Integer> categoricalToRemove,
                           Set<Integer> numericalToRemove)
```
    Sets up the Remove Attribute Transform properly
    
    Parameters:
    
    dataSet - the data set to remove the attributes from
    
    categoricalToRemove - the categorical attributes to remove
    
    numericalToRemove - the numeric attributes to remove
  - consolidate
```
public void consolidate(RemoveAttributeTransform preceding)
```
    A serious of Remove Attribute Transforms may be learned and applied sequentially to a single data set. Instead of keeping all the transforms around indefinitely, a sequential series of Remove Attribute Transforms can be consolidated into a single transform object.
    This method mutates the this transform by providing it with the transform that would have been applied before this current object. Once complete, this transform can be used two perform both removals in one step.
    
    Example:
    An initial set of features A is transformed into A' by transform t₁
    A' is transformed into A'' by transform t₂
    Instead, you can invoke t₂.consolidate(t₁). You can then transform A into A'' by using only transform t₂
    
    Parameters:
    
    preceding - the DataTransform that immediately precedes this one in a sequential list of transforms
  - transform
```
public DataPoint transform(DataPoint dp)
```
    Description copied from interface: DataTransform
    
    Returns a new data point that is a transformation of the original data point. This new data point is a different object, but may contain the same references as the original data point. It is not guaranteed that you can mutate the transformed point without having a side effect on the original point.
    
    Specified by:
    
    transform in interface DataTransform
    
    Parameters:
    
    dp - the data point to apply a transformation to
    
    Returns:
    
    a transformed data point
  - clone
```
public RemoveAttributeTransform clone()
```
    Specified by:
    
    clone in interface DataTransform
    
    Overrides:
    
    clone in class Object

Class RemoveAttributeTransform

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

catIndexMap

numIndexMap

Constructor Detail

RemoveAttributeTransform

RemoveAttributeTransform

RemoveAttributeTransform

RemoveAttributeTransform

Method Detail

getKeptNumeric

getReverseNumericMap

getKeptNominal

getReverseNominalMap

fit

setUp

consolidate

transform

clone