CentroidTfidfSimilarityExtractor (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>
  - - org.cleartk.ml.feature.transform.extractor.CentroidTfidfSimilarityExtractor<OUTCOME_T,FOCUS_T>

All Implemented Interfaces:

FeatureExtractor1<FOCUS_T>, TrainableExtractor<OUTCOME_T>
```
public class CentroidTfidfSimilarityExtractor<OUTCOME_T,FOCUS_T extends Annotation>
extends TfidfExtractor<OUTCOME_T,FOCUS_T>
```
Copyright (c) 2012, Regents of the University of Colorado
All rights reserved.

Author:

Lee Becker

Nested Class Summary
- Nested classes/interfaces inherited from class org.cleartk.ml.feature.transform.extractor.TfidfExtractor
  TfidfExtractor.IDFMap

Field Summary
- Fields inherited from class org.cleartk.ml.feature.transform.extractor.TfidfExtractor
  idfMap, isTrained, subExtractor
- Fields inherited from class org.cleartk.ml.feature.transform.OneToOneTrainableExtractor_ImplBase
  name

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`protected Map<String,Double>`	`computeCentroid(Iterable<Instance<OUTCOME_T>> instances, TfidfExtractor.IDFMap idfs)`
`List<Feature>`	`extract(JCas view, FOCUS_T focusAnnotation)` Some feature extractors will require some specific number of annotations that is greater than one.
`Map<String,Double>`	`featuresToFeatureMap(List<Feature> features)`
`static URI`	`getCentroidDataURI(String name, URI baseURI)`
`static URI`	`getDocumentFrequencyDataURI(String name, URI baseURI)`
`void`	`load(URI baseURI)` Loads statistics from location URI
`void`	`save(URI baseURI)` 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...
`Instance<OUTCOME_T>`	`transform(Instance<OUTCOME_T> instance)` Transforms all features handled by this extractor.

Methods inherited from class org.cleartk.ml.feature.transform.extractor.TfidfExtractor
createIdfMap, transform

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

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

- Constructor Detail
  - CentroidTfidfSimilarityExtractor
```
public CentroidTfidfSimilarityExtractor(String name)
```
  - CentroidTfidfSimilarityExtractor
```
public CentroidTfidfSimilarityExtractor(String name,
                                FeatureExtractor1<FOCUS_T> extractor)
```
- Method Detail
  - computeCentroid
```
protected Map<String,Double> computeCentroid(Iterable<Instance<OUTCOME_T>> instances,
                                 TfidfExtractor.IDFMap idfs)
```
  - 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>
    
    Overrides:
    
    extract in class TfidfExtractor<OUTCOME_T,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
  - featuresToFeatureMap
```
public Map<String,Double> featuresToFeatureMap(List<Feature> features)
```
  - getCentroidDataURI
```
public static URI getCentroidDataURI(String name,
                     URI baseURI)
                              throws MalformedURLException,
                                     URISyntaxException
```
    Throws:
    
    MalformedURLException
    
    URISyntaxException
  - getDocumentFrequencyDataURI
```
public static URI getDocumentFrequencyDataURI(String name,
                              URI baseURI)
                                       throws MalformedURLException,
                                              URISyntaxException
```
    Throws:
    
    MalformedURLException
    
    URISyntaxException
  - load
```
public void load(URI baseURI)
          throws IOException
```
    Description copied from interface: TrainableExtractor
    
    Loads statistics from location URI
    
    Specified by:
    
    load in interface TrainableExtractor<OUTCOME_T>
    
    Overrides:
    
    load in class TfidfExtractor<OUTCOME_T,FOCUS_T extends Annotation>
    
    Throws:
    
    IOException
  - save
```
public void save(URI baseURI)
          throws IOException
```
    Description copied from interface: TrainableExtractor
    
    Saves statistics from train in location URI
    
    Specified by:
    
    save in interface TrainableExtractor<OUTCOME_T>
    
    Overrides:
    
    save in class TfidfExtractor<OUTCOME_T,FOCUS_T extends Annotation>
    
    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>
    
    Overrides:
    
    train in class TfidfExtractor<OUTCOME_T,FOCUS_T extends Annotation>
    
    Parameters:
    instances - - URI pointing to the output location for saving statistics
  - transform
```
public Instance<OUTCOME_T> transform(Instance<OUTCOME_T> instance)
```
    Description copied from interface: TrainableExtractor
    
    Transforms all features handled by this extractor. Called on an Instance that was created before TrainableExtractor.train(Iterable) was called, to complete the processing of the Instance.
    
    Specified by:
    
    transform in interface TrainableExtractor<OUTCOME_T>
    
    Overrides:
    
    transform in class OneToOneTrainableExtractor_ImplBase<OUTCOME_T>
    
    Parameters:
    instance - An instance that was created before TrainableExtractor.train(Iterable) was called.
    
    Returns:
    A copy of the instance, where processing of the instances is complete.

Class CentroidTfidfSimilarityExtractor<OUTCOME_T,FOCUS_T extends Annotation>

Nested Class Summary

Nested classes/interfaces inherited from class org.cleartk.ml.feature.transform.extractor.TfidfExtractor

Field Summary

Fields inherited from class org.cleartk.ml.feature.transform.extractor.TfidfExtractor

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

Constructor Summary

Method Summary

Methods inherited from class org.cleartk.ml.feature.transform.extractor.TfidfExtractor

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

Methods inherited from class java.lang.Object

Constructor Detail

CentroidTfidfSimilarityExtractor

CentroidTfidfSimilarityExtractor

Method Detail

computeCentroid

extract

featuresToFeatureMap

getCentroidDataURI

getDocumentFrequencyDataURI

load

save

train

transform