|
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.ObjectjAudioFeatureExtractor.ACE.DataTypes.FeatureDefinition
public class FeatureDefinition
Objects of this class each hold meta-data about a feature, as specified by the five public fields. Objects of this class do not hold any feature values of particular instances.
Methods are available for viewing the features, veryifying the uniqueness of their names, saving them to disk and loading the, from disk.
Daniel McEnnis 05-07-05 Added attributes to definition that describe the names (and implicitly number) of editable features.
フィールドの概要 | |
---|---|
java.lang.String[] |
attributes
names of each editable attribute this feature has |
java.lang.String |
description
A description of what the feature represents. |
int |
dimensions
The number of values that exist for the feature for a given section of a data set. |
boolean |
is_sequential
Specifies whether a feature can be applied to sub-section of a data set (e.g. a window of audio). |
java.lang.String |
name
The name of the feature. |
コンストラクタの概要 | |
---|---|
FeatureDefinition()
Generate an empty FeatureDefinition with the name "Undefined Feature". |
|
FeatureDefinition(java.lang.String name,
java.lang.String description,
boolean is_sequential,
int dimensions)
Explicitly define a new Feature Definition with no editable attributes. |
|
FeatureDefinition(java.lang.String name,
java.lang.String description,
boolean is_sequential,
int dimensions,
java.lang.String[] attributes)
Explicitly define a feature along with a description of editable attributes. |
メソッドの概要 | |
---|---|
java.lang.String |
getFeatureDescription()
Returns a formatted text description of the FeatureDescription object. |
static java.lang.String |
getFeatureDescriptions(FeatureDefinition[] definitions)
Returns a formatted text description of the given FeatureDescription objects. |
static FeatureDefinition[] |
parseFeatureDefinitionsFile(java.lang.String feature_key_file_path)
Parses a feature_key_file_path XML file and returns an array of FeatureDefinitionwith objects holding its contents. |
static void |
saveFeatureDefinitions(FeatureDefinition[] definitions,
java.io.File to_save_to,
java.lang.String comments)
Saves a feature_key_file_path XML file with the contents specified in the given FeatureDefinition array and the comments specified in the comments parameter. |
static java.lang.String |
verifyFeatureNameUniqueness(FeatureDefinition[] definitions)
Checks if the given FeatureDefinitions hold any features with the same names. |
クラス java.lang.Object から継承されたメソッド |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
フィールドの詳細 |
---|
public java.lang.String name
public java.lang.String description
public boolean is_sequential
public int dimensions
public java.lang.String[] attributes
コンストラクタの詳細 |
---|
public FeatureDefinition()
public FeatureDefinition(java.lang.String name, java.lang.String description, boolean is_sequential, int dimensions)
name
- The name of the feature. This name should be unique among each
set of features.description
- A description of what the feature represents. May be left as
an empty string.is_sequential
- Specifies whether a feature can be applied to sequential
windows of a data set. A value of true means that it can, and
a value of false means that only one feature value may be
extracted per data set.dimensions
- The number of values that exist for the feature for a given
section of a data set. This value will be 1, except for
multi-dimensional features.public FeatureDefinition(java.lang.String name, java.lang.String description, boolean is_sequential, int dimensions, java.lang.String[] attributes)
name
- The name of the feature. This name should be unique among each
set of features.description
- A description of what the feature represents. May be left as
an empty string.is_sequential
- Specifies whether a feature can be applied to sequential
windows of a data set. A value of true means that it can, and
a value of false means that only one feature value may be
extracted per data set.dimensions
- The number of values that exist for the feature for a given
section of a data set. This value will be 1, except for
multi-dimensional features.attributes
- The names of all editable attributes in the featureメソッドの詳細 |
---|
public java.lang.String getFeatureDescription()
public static java.lang.String getFeatureDescriptions(FeatureDefinition[] definitions)
definitions
- The feature definitions to describe.
public static FeatureDefinition[] parseFeatureDefinitionsFile(java.lang.String feature_key_file_path) throws java.lang.Exception
feature_key_file_path
- The path of the XML file to parse.
java.lang.Exception
- Informative exceptions is thrown if an invalid file or file
path is specified or if the file holds multiple features with
the same name.public static void saveFeatureDefinitions(FeatureDefinition[] definitions, java.io.File to_save_to, java.lang.String comments) throws java.lang.Exception
definitions
- The FeatureDefinitions to save.to_save_to
- The file to save to.comments
- Any comments to be saved inside the comments element of the
XML file.
java.lang.Exception
- An informative exception is thrown if the file cannot be
saved or if any of the given definitions have the same name.public static java.lang.String verifyFeatureNameUniqueness(FeatureDefinition[] definitions)
definitions
- The FeatureDefinitions to check for duplicate names.
|
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |