bodhidharma.data_structures
Class FeatureSettings

java.lang.Object
  extended by bodhidharma.data_structures.FeatureSettings

public class FeatureSettings
extends java.lang.Object

Part of the Bodhidharma automatic music classification project. Holds the data relating to how an individual feature is to be used.

See Also:
FeaturessPanel, Feature, FeatureSet
Author:
Cory McKay

Field Summary
 boolean candidate_feature
          Whether or not the feature is a candidate for feature selection
 boolean extract_feature
          Whether or not the feature should be extracted
 boolean one_dimensional_feature
          Whether or not the feature has only one value.
 boolean overide_feature
          Whether or not the feature is to be used if a classification is performed in overide mode (without automatic feature selection).
 
Constructor Summary
FeatureSettings()
          Basic constructor that sets feature to null and all other fields to defaults (all true except overide_feature, which is false).
FeatureSettings(Feature dummy_feature, boolean extract, boolean candidate, boolean overide)
          Basic constructor that fills in the fields directly with no alterations.
 
Method Summary
 Feature getFeature()
          Returns the dummy feature stored in the feature field.
 void setFeature(Feature dummy_feature)
          Sets the feature field based on the given parameter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

extract_feature

public boolean extract_feature
Whether or not the feature should be extracted


candidate_feature

public boolean candidate_feature
Whether or not the feature is a candidate for feature selection


overide_feature

public boolean overide_feature
Whether or not the feature is to be used if a classification is performed in overide mode (without automatic feature selection).


one_dimensional_feature

public boolean one_dimensional_feature
Whether or not the feature has only one value.

Constructor Detail

FeatureSettings

public FeatureSettings(Feature dummy_feature,
                       boolean extract,
                       boolean candidate,
                       boolean overide)
Basic constructor that fills in the fields directly with no alterations. dummy_feature is a feature with no value but of the correct type.


FeatureSettings

public FeatureSettings()
Basic constructor that sets feature to null and all other fields to defaults (all true except overide_feature, which is false).

Method Detail

setFeature

public void setFeature(Feature dummy_feature)
Sets the feature field based on the given parameter.

Parameters:
dummy_feature - The dummy feature to be stored.

getFeature

public Feature getFeature()
Returns the dummy feature stored in the feature field.

Returns:
The dummy feature stored in the feature field.