jAudioFeatureExtractor.Aggregators
Class Mean

java.lang.Object
  extended by jAudioFeatureExtractor.Aggregators.Aggregator
      extended by jAudioFeatureExtractor.Aggregators.Mean

public class Mean
extends Aggregator

Calculates the mean of a feature accross all windows where it is defined. When the feature has more than one dimension, the mean has an equal number of dimensions and the value of each dimension is the mean of that dimension. If the feature has a variable number of dimensions, the dimensionality of the result is the largest number of dimensions present and the mean for each dimension is calculated over all values defined for that dimension.

Author:
Daniel McEnnis

Field Summary
 
Fields inherited from class jAudioFeatureExtractor.Aggregators.Aggregator
LINE_SEP
 
Constructor Summary
Mean()
           
 
Method Summary
 void aggregate(double[][][] values)
          Aggregates the values of the features specified by the init function accross all windows of the data recieved.
 java.lang.Object clone()
          Create a new aggregator of the same class
 FeatureDefinition getFeatureDefinition()
          Description of a particular instantiation of an aggregate.
 java.lang.String[] getFeaturesToApply()
          Provide a list of features that are to be aggregated by this feature.
 void init(int[] featureIndeci)
          Specifies which Features are to be extracted and the index of these features in the values array that will passed into the aggregate function
 void setSource(FeatureExtractor feature)
           
 
Methods inherited from class jAudioFeatureExtractor.Aggregators.Aggregator
calculateOffset, collapseFeatures, getAggregatorDefinition, getParamaters, getResults, outputACEFeatureKeyEntries, outputACEValueEntries, outputARFFHeaderEntries, outputARFFValueEntries, setParameters
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Mean

public Mean()
Method Detail

getFeaturesToApply

public java.lang.String[] getFeaturesToApply()
Provide a list of features that are to be aggregated by this feature. Returning null indicates that this aggregator accepts only one feature and every feature avaiable should be used.

Overrides:
getFeaturesToApply in class Aggregator
Returns:
list of features to be used by this aggregator or null

getFeatureDefinition

public FeatureDefinition getFeatureDefinition()
Description copied from class: Aggregator
Description of a particular instantiation of an aggregate. This should not be called until after the specific features have been specified by the init function.

Overrides:
getFeatureDefinition in class Aggregator
Returns:
Feature Definition describing this instantiation of this aggregate object
See Also:
Aggregator.getFeatureDefinition()

init

public void init(int[] featureIndeci)
          throws java.lang.Exception
Description copied from class: Aggregator
Specifies which Features are to be extracted and the index of these features in the values array that will passed into the aggregate function

Overrides:
init in class Aggregator
Parameters:
featureIndeci - Indecis of these features in the array passed in aggregate
Throws:
java.lang.Exception - if either parameter is null, of dicffering lengths, or contain invalid index values.

clone

public java.lang.Object clone()
Description copied from class: Aggregator
Create a new aggregator of the same class

Overrides:
clone in class Aggregator

setSource

public void setSource(FeatureExtractor feature)
Overrides:
setSource in class Aggregator

aggregate

public void aggregate(double[][][] values)
Description copied from class: Aggregator
Aggregates the values of the features specified by the init function accross all windows of the data recieved.

Overrides:
aggregate in class Aggregator
Parameters:
values - complete array of the extracted features. Indecis are window, feature, and then feature value.