org.openimaj.audio

Class AudioAnnotator

java.lang.Object

org.openimaj.ml.annotation.AbstractAnnotator<OBJECT,ANNOTATION>

org.openimaj.ml.annotation.IncrementalAnnotator<DoubleFV,String>

org.openimaj.audio.AudioAnnotator

All Implemented Interfaces:

Classifier<String,DoubleFV>, FeatureExtractor<DoubleFV,SampleChunk>, Annotator<DoubleFV,String>, IncrementalTrainer<Annotated<DoubleFV,String>>

public abstract class AudioAnnotator
extends IncrementalAnnotator<DoubleFV,String>
implements FeatureExtractor<DoubleFV,SampleChunk>

A classifier/annotator for audio frames. Note that this is a pretty general annotator that takes DoubleFVs and String labels. The DoubleFVs can be extracted from audio with this class also, as it also implements FeatureExtractor interface for SampleChunks (returning DoubleFVs). However, there is no implementation for the necessary FeatureExtractor.extractFeature(Object) method, so subclasses must implement this. The default annotator in use is a general KNNAnnotator for DoubleFVs, however, this can be changed using setAnnotator(AudioAnnotatorType).

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AudioAnnotator.AudioAnnotatorType An enumeration that allows different trainers to be used and specified on the command-line.

Constructor Summary

Constructors

Constructor and Description
AudioAnnotator()

Method Summary

Methods

Modifier and Type	Method and Description
List<ScoredAnnotation<String>>	annotate(DoubleFV object) Generate annotations for the given object.
Set<String>	getAnnotations()
AudioAnnotator.AudioAnnotatorType	getAnnotator() Get the annotator type in use.
void	reset() Reset the object to its initial condition, as if it hasn't seen any training data.
void	setAnnotator(AudioAnnotator.AudioAnnotatorType annotator) Set the annotator type to use.
void	train(Annotated<DoubleFV,String> annotated) Train/update object using a new instance.

Methods inherited from class org.openimaj.ml.annotation.IncrementalAnnotator

train, train, trainMultiClass

Methods inherited from class org.openimaj.ml.annotation.AbstractAnnotator

classify

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openimaj.feature.FeatureExtractor

extractFeature

Constructor Detail

AudioAnnotator

public AudioAnnotator()

Method Detail

train

public void train(Annotated<DoubleFV,String> annotated)

Train/update object using a new instance.

Specified by:

train in interface IncrementalTrainer<Annotated<DoubleFV,String>>

Parameters:

annotated - instance to train with

See Also:

IncrementalTrainer.train(java.lang.Object)

reset

public void reset()

Reset the object to its initial condition, as if it hasn't seen any training data.

Specified by:

reset in interface IncrementalTrainer<Annotated<DoubleFV,String>>

See Also:

IncrementalTrainer.reset()

getAnnotations

public Set<String> getAnnotations()

Specified by:

getAnnotations in interface Annotator<DoubleFV,String>

Returns:

a Set of all annotations this Annotator knows about

See Also:

Annotator.getAnnotations()

annotate

public List<ScoredAnnotation<String>> annotate(DoubleFV object)

Generate annotations for the given object.

Specified by:

annotate in interface Annotator<DoubleFV,String>

Parameters:

object - the image

Returns:

generated annotations

See Also:

Annotator.annotate(java.lang.Object)

getAnnotator

public AudioAnnotator.AudioAnnotatorType getAnnotator()

Get the annotator type in use.

Returns:

The annotator type

setAnnotator

public void setAnnotator(AudioAnnotator.AudioAnnotatorType annotator)

Set the annotator type to use.

Parameters:

annotator - The annotator type.