TfidfExtractor (ClearTK TimeML 2.0.0 API)

java.lang.Object
- org.cleartk.ml.feature.transform.OneToOneTrainableExtractor_ImplBase<OUTCOME_T>
- - org.cleartk.ml.feature.transform.extractor.TfidfExtractor<OUTCOME_T,FOCUS_T>

All Implemented Interfaces:

FeatureExtractor1<FOCUS_T>, TrainableExtractor<OUTCOME_T>

Direct Known Subclasses:

CentroidTfidfSimilarityExtractor
```
public class TfidfExtractor<OUTCOME_T,FOCUS_T extends Annotation>
extends OneToOneTrainableExtractor_ImplBase<OUTCOME_T>
implements FeatureExtractor1<FOCUS_T>
```
Transforms count features produced by its subextractor into TF*IDF values

Copyright (c) 2012, Regents of the University of Colorado
All rights reserved.

Author:

Lee Becker

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class TfidfExtractor.IDFMap

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`TfidfExtractor.IDFMap`

Field Summary

Fields
Modifier and Type Field and Description

protected TfidfExtractor.IDFMap idfMap

protected boolean isTrained

protected FeatureExtractor1<FOCUS_T> subExtractor
- Fields inherited from class org.cleartk.ml.feature.transform.OneToOneTrainableExtractor_ImplBase
  name

Fields
Modifier and Type	Field and Description
`protected TfidfExtractor.IDFMap`	`idfMap`
`protected boolean`	`isTrained`
`protected FeatureExtractor1<FOCUS_T>`	`subExtractor`

Constructor Summary

Constructors
Constructor and Description

TfidfExtractor(String name)

TfidfExtractor(String name, FeatureExtractor1<FOCUS_T> extractor)

Constructors
Constructor and Description
`TfidfExtractor(String name)`
`TfidfExtractor(String name, FeatureExtractor1<FOCUS_T> extractor)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected TfidfExtractor.IDFMap`	`createIdfMap(Iterable<Instance<OUTCOME_T>> instances)`
`List<Feature>`	`extract(JCas view, FOCUS_T focusAnnotation)` Some feature extractors will require some specific number of annotations that is greater than one.
`void`	`load(URI documentFreqDataURI)` Loads statistics from location URI
`void`	`save(URI documentFreqDataURI)` Saves statistics from train in location URI
`void`	`train(Iterable<Instance<OUTCOME_T>> instances)` In the prototypical case, train takes a collection of instances and computes statistics over the values such as computing mean, standard deviation, TF*IDF, etc...
`protected Feature`	`transform(Feature feature)`

Methods inherited from class org.cleartk.ml.feature.transform.OneToOneTrainableExtractor_ImplBase
isTransformable, transform

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

- Field Detail
  - idfMap
```
protected TfidfExtractor.IDFMap idfMap
```
  - isTrained
```
protected boolean isTrained
```
  - subExtractor
```
protected FeatureExtractor1<FOCUS_T extends Annotation> subExtractor
```
- Constructor Detail
  - TfidfExtractor
```
public TfidfExtractor(String name)
```
  - TfidfExtractor
```
public TfidfExtractor(String name,
              FeatureExtractor1<FOCUS_T> extractor)
```
    Parameters:
    extractor - - This assumes that any extractors passed in will produce counts of some variety
- Method Detail
  - createIdfMap
```
protected TfidfExtractor.IDFMap createIdfMap(Iterable<Instance<OUTCOME_T>> instances)
```
  - extract
```
public List<Feature> extract(JCas view,
                    FOCUS_T focusAnnotation)
                      throws CleartkExtractorException
```
    Description copied from interface: FeatureExtractor1
    
    Some feature extractors will require some specific number of annotations that is greater than one. Such extractors should not implement this interface.
    
    Specified by:
    
    extract in interface FeatureExtractor1<FOCUS_T extends Annotation>
    
    Parameters:
    view - the current view of the document.
    focusAnnotation - the annotation for which to collect features.
    
    Returns:
    a list of features generated by the extractor for the focus annotation.
    
    Throws:
    
    CleartkExtractorException
  - load
```
public void load(URI documentFreqDataURI)
          throws IOException
```
    Description copied from interface: TrainableExtractor
    
    Loads statistics from location URI
    
    Specified by:
    
    load in interface TrainableExtractor<OUTCOME_T>
    
    Throws:
    
    IOException
  - save
```
public void save(URI documentFreqDataURI)
          throws IOException
```
    Description copied from interface: TrainableExtractor
    
    Saves statistics from train in location URI
    
    Specified by:
    
    save in interface TrainableExtractor<OUTCOME_T>
    
    Throws:
    
    IOException
  - train
```
public void train(Iterable<Instance<OUTCOME_T>> instances)
```
    Description copied from interface: TrainableExtractor
    
    In the prototypical case, train takes a collection of instances and computes statistics over the values such as computing mean, standard deviation, TF*IDF, etc...
    
    Specified by:
    
    train in interface TrainableExtractor<OUTCOME_T>
    
    Parameters:
    instances - - URI pointing to the output location for saving statistics
  - transform
```
protected Feature transform(Feature feature)
```
    Specified by:
    
    transform in class OneToOneTrainableExtractor_ImplBase<OUTCOME_T>

Class TfidfExtractor<OUTCOME_T,FOCUS_T extends Annotation>

Nested Class Summary

Field Summary

Fields inherited from class org.cleartk.ml.feature.transform.OneToOneTrainableExtractor_ImplBase

Constructor Summary

Method Summary

Methods inherited from class org.cleartk.ml.feature.transform.OneToOneTrainableExtractor_ImplBase

Methods inherited from class java.lang.Object

Field Detail

idfMap

isTrained

subExtractor

Constructor Detail

TfidfExtractor

TfidfExtractor

Method Detail

createIdfMap

extract

load

save

train

transform