Serialized Form


Package ace

Class ace.CommandLine extends java.lang.Object implements Serializable

Serialized Fields

classifier_type

java.lang.String classifier_type
The type of Weka Classifier to be trained.


save_file

java.lang.String save_file
The file to which the results or the TrainedModel (depending on which processing is being performed) will be saved.


feature_selector

java.lang.String feature_selector
A code specifying what type of dimensionality reduction to be performed.


order_randomly

boolean order_randomly
If true, instances are ordered randomly before training, cross validation, or experimenting.


max_spread

double max_spread
The maximum ratio of instances that are permitted belonging to different classes.


max_membership

double max_membership
The maximum number of instances that may belong to any one class.


save_intermediate_arffs

boolean save_intermediate_arffs
Whether or not to save training or testing data to an arff file after parsing, after thinning, and again after feature selection, if any.


project_path

java.lang.String project_path
Specifies the path to the ACE XML project file if loading data from an ACE project file or an ACE zip file.


load_zip

java.lang.String load_zip
Specifies the path to the ACE zip file if loading data from an ACE zip file.


taxonomy_file

java.lang.String taxonomy_file
The path to the ACE XML taxonomy file for this project.


feature_key_file

java.lang.String feature_key_file
The path to the ACE XML feature definitions file for this project.


classifications_file

java.lang.String classifications_file
The path to the ACE XML classifications file for this project.


feature_vector_files

java.lang.String[] feature_vector_files
Array of paths to ACE XML feature vectors files for this project.


arff_file

java.lang.String arff_file
If Instances are being loaded from an ARFF file, this specifies the path to that file.


train

boolean train
Whether or not training is to be performed.


testing_to_load_classifiers_file

java.lang.String testing_to_load_classifiers_file
The name of file from which the TrainModel object to be used for classification is to be read.


cross_validation_string

java.lang.String cross_validation_string
Specifies the number of folds to be used in cross validation.


experimentation_string

java.lang.String experimentation_string
Specifies the number of folds to be used for cross validation during experimentation.


verbose

boolean verbose
Specifies whether or not to include detailed information in the results output.


zip_file

java.lang.String zip_file

file_type

java.lang.String file_type

unzip

boolean unzip

dozip

java.lang.String[] dozip

zip_add

java.lang.String zip_add

zip_extract

java.lang.String zip_extract
The name of the single file that the user would like to exract from the specified zip file.


zip_directory

java.lang.String zip_directory
The directory to which the zip file (if specified) will be unzipped. If not specified at the command line, the default directory name is simply the name of the zip file with the extension removed.


Package ace.datatypes

Class ace.datatypes.DataBoard extends java.lang.Object implements Serializable

serialVersionUID: 5L

Serialized Fields

taxonomy

Taxonomy taxonomy
The taxonomy that instances are classified into. May be hierarchical.

May be null if clustering algorithms are to be used or if the taxonomy is to be derived from the model_classifications field.


feature_definitions

FeatureDefinition[] feature_definitions
Holds meta-data about the feautres that characterize instances.

May be null if the feature_vectors have sufficient self-contained infromation, although this is not recommended.


feature_vectors

DataSet[] feature_vectors
Feature vectors for a set of instances. Can include features for sub-sections of instances as well as for instances as a whole.

In general, these should be taken in conjunction with feature_definitions in order to minimize storage space and processing overhead.


model_classifications

SegmentedClassification[] model_classifications
The model classifications that are used in supervised training. Can include classifications for sub-sections of instances as well as for instances as a whole.

Class names should correspond with those in the taxonomy field. Instances should correspond to those in the feature_vectors field.

May be null if clustering algorithms are to be used of if this DataBoard is being used to classify novel patterns with already trained classifiers.

Class ace.datatypes.DataSet extends java.lang.Object implements Serializable

serialVersionUID: 3L

Serialized Fields

identifier

java.lang.String identifier
The name of the data set. This name should be unique among each group of data sets. Should be null for non-top-level DataSets.


sub_sets

DataSet[] sub_sets
Sub-sets of this DataSet. Each such sub-set can serve as an instance that is individually classifiable. For example, sub-sets could consist of windows of audio extracted from the recording that makes the overall DataSet. The sub_sets field should be null if there are no sub-sets that can be individually classified.


start

double start
Identifies the start of a sub-set of a DataSet. Set to NaN if this object is a top-level DataSet.


stop

double stop
Identifies the end of a sub-set of a DataSet. Set to NaN if this object is a top-level DataSet.


feature_values

double[][] feature_values
The feature values for this DataSet as a whole. If there are any sub-sets, they will store there own feature values, and these will not be referenced here. The first indice identifies the feature and the second indice identifies the dimension of the feature. It is clear that features of arbitrary dimensions may be accomodated. Features whose value or values are missing are assigned a value of null. This field is assigned a value of null if no features have been extracted. It is assumed that the Java Class calling the DataSet knows the ordering and identity of the features of the DataSet and its sub-sets. The feature_values may be ordered based on FeatureDefinitions using the orderAndCompactFeatures method. Individual features may also be assigned null values if they are unknown or inappropriate.


feature_names

java.lang.String[] feature_names
The names of the features in each corresponding (by first indice) entry of feature_values. These are often only stored here temporarily until they can be accessed and stored externally in a more efficient fashion. This field is therefore often null, even when the feature_values field is not.


parent

DataSet parent
If this object is a sub-set of another DataSet, this field points to that parent dataset. Otherwise this field is null.

Class ace.datatypes.FeatureDefinition extends java.lang.Object implements Serializable

serialVersionUID: 2L

Serialized Fields

name

java.lang.String name
The name of the feature. This name should be unique among each set of features.


description

java.lang.String description
A description of what the feature represents. May be left as an empty string.


is_sequential

boolean is_sequential
Specifies whether a feature can be applied to sub-section of a data set (e.g. a window of audio). A value of true means that it can, and a value of false means that the feature may only be extracted per data set.


dimensions

int 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.

Class ace.datatypes.SegmentedClassification extends java.lang.Object implements Serializable

serialVersionUID: 4L

Serialized Fields

identifier

java.lang.String identifier
The name of the dataset referred to by a top-level SegmentedClassification. Should be set to null for SegmentedClassifications that correspond to sub-sections. Should never be null for top-level SegmentedClassifications.


classifications

java.lang.String[] classifications
The class(es) that this top-level SegmentedClassification or section belongs to. It is possible to have zero, one or no classifications for a given instance. If no classifications are present, then this should be null.


misc_info_info

java.lang.String[] misc_info_info
Can store various pieces of meta-data regarding an instance. Entries correspond to entries of the misc_info_key field. Should be set to null for SegmentedClassifications that correspond to sub-sections. Set to null if no meta-data is stored.


misc_info_key

java.lang.String[] misc_info_key
Stores titles identifying the meta-data in the misc_info_info field. Entries correspond to entries of the misc_info_key field. Should be set to null for SegmentedClassifications that correspond to sub-sections. Set to null if no meta-data is stored.


role

java.lang.String role
Can be used internally by ACE to determine what a particular instance is for (e.g. training, testing, resulting classification of an unknown. Set to null if not used.


sub_classifications

SegmentedClassification[] sub_classifications
Classifications corresponding to sub-sections of an instance. Set to null if there are no sub-sections.


start

double start
Identifies the start of a sub-classification. Set to NaN if this object is a top-level SegmentedClassification.


stop

double stop
Identifies the end of a sub-classification. Set to NaN if this object is a top-level SegmentedClassification.

Class ace.datatypes.Taxonomy extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

taxonomy

javax.swing.tree.DefaultTreeModel taxonomy
The tree holding the taxonomy. The root element is the name of the taxonomy.

Class ace.datatypes.TrainedModel extends java.lang.Object implements Serializable

serialVersionUID: 100L

Serialized Fields

classifier

weka.classifiers.Classifier classifier
A Weka Classifier to be trained based on the training Instances.


attribute_selector

weka.attributeSelection.AttributeSelection attribute_selector
A feature selector to be used to select features of a feature set.


class_attribute

weka.core.Attribute class_attribute
Attribute describing the possible classes to which an Instance may belong.


Package ace.gui

Class ace.gui.ClassificationSettingsPanel extends javax.swing.JPanel implements Serializable

Serialized Fields

parent

MainGUIFrame parent

Class ace.gui.ExperimentationPanel extends javax.swing.JPanel implements Serializable

Serialized Fields

parent

MainGUIFrame parent

Class ace.gui.FeatureDefinitionsPanel extends javax.swing.JPanel implements Serializable

Serialized Fields

parent

MainGUIFrame parent

features_table

javax.swing.JTable features_table

features_display_panel

javax.swing.JPanel features_display_panel

button_panel

javax.swing.JPanel button_panel

features_display_scroll_pane

javax.swing.JScrollPane features_display_scroll_pane

status_bar

javax.swing.JTextField status_bar

view_feature_descriptions_button

javax.swing.JButton view_feature_descriptions_button

add_feature_definition_button

javax.swing.JButton add_feature_definition_button

delete_feature_definitions_button

javax.swing.JButton delete_feature_definitions_button

load_features_definitions_button

javax.swing.JButton load_features_definitions_button

save_features_definitions_button

javax.swing.JButton save_features_definitions_button

save_features_definitions_as_button

javax.swing.JButton save_features_definitions_as_button

Class ace.gui.FeatureDefinitionsTableModel extends javax.swing.table.DefaultTableModel implements Serializable

Class ace.gui.GUIPreferencesPanel extends javax.swing.JPanel implements Serializable

Serialized Fields

parent

MainGUIFrame parent

Class ace.gui.InstancesPanel extends javax.swing.JPanel implements Serializable

Serialized Fields

parent

MainGUIFrame parent

instances_table

javax.swing.JTable instances_table

instances_display_panel

javax.swing.JPanel instances_display_panel

button_panel

javax.swing.JPanel button_panel

instances_display_scroll_pane

javax.swing.JScrollPane instances_display_scroll_pane

status_bar

javax.swing.JTextField status_bar

load_classification_button

javax.swing.JButton load_classification_button

load_feature_vectors_button

javax.swing.JButton load_feature_vectors_button

save_classification_button

javax.swing.JButton save_classification_button

save_feature_vectors_button

javax.swing.JButton save_feature_vectors_button

save_as_classification_button

javax.swing.JButton save_as_classification_button

save_as_feature_vectors_button

javax.swing.JButton save_as_feature_vectors_button

add_instance_button

javax.swing.JButton add_instance_button

delete_instance_button

javax.swing.JButton delete_instance_button

display_feature_values_checkbox

javax.swing.JCheckBox display_feature_values_checkbox

show_misc_info_checkbox

javax.swing.JCheckBox show_misc_info_checkbox

display_meta_data

boolean display_meta_data

display_feature_values

boolean display_feature_values

Class ace.gui.InstancesTableModel extends javax.swing.table.DefaultTableModel implements Serializable

Serialized Fields

display_meta_data

boolean display_meta_data
Whether or not to display additional columns of meta-data for instances.


display_feature_values

boolean display_feature_values
Whether or not to display additional columns of feature values for instances.


has_sections

boolean has_sections
Whether or not this table includes instances that have sub-sections.

Class ace.gui.MainGUIFrame extends javax.swing.JFrame implements Serializable

Serialized Fields

data_board

DataBoard data_board
The object that stores the current taxonomy, feature settings, instance feature values and model classifications.


project

Project project
This object stores the path names to all component ACE XML files of an ACE project.


temp_files

java.util.LinkedList<E> temp_files
List of files and/or directories to be deleted when ACE closes. example: The temporary directory into which zipfiles are extracted will be deleted when ACE closes.


project_previously_loaded

boolean project_previously_loaded
Notes whether a project has already been loaded


zipfile_loaded

boolean zipfile_loaded
Notes whether a zipfile has been loaded.


project_files_dialog_box

ProjectFilesDialogBox project_files_dialog_box
Dialog box that stores paths of ACE XML or Weka ACE files used in current project.


taxonomy_panel

TaxonomyPanel taxonomy_panel
The panel used to view and edit the current taxonomy.


instances_panel

InstancesPanel instances_panel
The panel used to view and edit instances.


feature_definitions_panel

FeatureDefinitionsPanel feature_definitions_panel
The panel used to view and edit feature settings.


gui_preferences_panel

GUIPreferencesPanel gui_preferences_panel
The panel used to view and edit GUI preferences.


classification_settings_panel

ClassificationSettingsPanel classification_settings_panel
The panel used to view and edit the settings used for training and classification of instances.


experimentation_panel

ExperimentationPanel experimentation_panel
The panel used to run training and classification experiments.


help_dialog

mckay.utilities.gui.templates.HelpDialog help_dialog
A dialog box allowing the user to view the on-line help.


tabbed_pane

javax.swing.JTabbedPane tabbed_pane

content_pane

java.awt.Container content_pane

menu_bar

javax.swing.JMenuBar menu_bar

file_menu

javax.swing.JMenu file_menu

help_menu

javax.swing.JMenu help_menu

load_configuration_files_menu_item

javax.swing.JMenuItem load_configuration_files_menu_item

save_project_menu_item

javax.swing.JMenuItem save_project_menu_item

save_project_paths_menu_item

javax.swing.JMenuItem save_project_paths_menu_item

about_menu_item

javax.swing.JMenuItem about_menu_item

view_manual_menu_item

javax.swing.JMenuItem view_manual_menu_item

quit_menu_item

javax.swing.JMenuItem quit_menu_item

load_zip_item

javax.swing.JMenuItem load_zip_item

Class ace.gui.ProjectFilesDialogBox extends javax.swing.JFrame implements Serializable

Serialized Fields

project_path

java.lang.String project_path
Path of the current ACE XML project file.


zip_path

java.lang.String zip_path
If current files were loaded from a zip file, this specified the file path to the file from which they were originally extracted.


use_arff_rather_than_ace_xml

boolean use_arff_rather_than_ace_xml
Denotes whether data is to be be loaded from ACE XML files or a Weka ARFF file.


parent

MainGUIFrame parent
Path of the current trained_classifiers_file that holds a set of trained classifiers.


current_directory

java.lang.String current_directory

project_field

javax.swing.JTextField project_field

arff_field

javax.swing.JTextField arff_field

taxonomy_field

javax.swing.JTextField taxonomy_field

feature_settings_field

javax.swing.JTextField feature_settings_field

feature_vectors_field

javax.swing.JList feature_vectors_field

model_classifications_field

javax.swing.JTextField model_classifications_field

gui_preferences_field

javax.swing.JTextField gui_preferences_field

classifier_settings_field

javax.swing.JTextField classifier_settings_field

trained_classifiers_field

javax.swing.JTextField trained_classifiers_field

ace_xml_or_arff_checkbox

javax.swing.JCheckBox ace_xml_or_arff_checkbox

browse_project_button

javax.swing.JButton browse_project_button

browse_arff_button

javax.swing.JButton browse_arff_button

browse_taxonomy_button

javax.swing.JButton browse_taxonomy_button

browse_feature_settings_file_button

javax.swing.JButton browse_feature_settings_file_button

add_feature_vectors_file_button

javax.swing.JButton add_feature_vectors_file_button

remove_feature_vectors_file_button

javax.swing.JButton remove_feature_vectors_file_button

browse_model_classifications_file_button

javax.swing.JButton browse_model_classifications_file_button

browse_gui_preferences_button

javax.swing.JButton browse_gui_preferences_button

browse_classifier_settings_button

javax.swing.JButton browse_classifier_settings_button

browse_trained_classifiers_button

javax.swing.JButton browse_trained_classifiers_button

clear_button

javax.swing.JButton clear_button

new_project_button

javax.swing.JButton new_project_button

save_this_project_button

javax.swing.JButton save_this_project_button

save_as_defaults_button

javax.swing.JButton save_as_defaults_button

cancel_button

javax.swing.JButton cancel_button

ok_button

javax.swing.JButton ok_button

Class ace.gui.ShowSectionsColumnRenderer extends javax.swing.table.DefaultTableCellRenderer implements Serializable

Serialized Fields

expandable

java.lang.String[] expandable
Contains the identifiers of the instances that are expandable.

Class ace.gui.TaxonomyPanel extends javax.swing.JPanel implements Serializable

Serialized Fields

parent

MainGUIFrame parent

taxonomy_display

javax.swing.JTree taxonomy_display

tree_display_panel

javax.swing.JPanel tree_display_panel

ancestry_display_panel

javax.swing.JPanel ancestry_display_panel

button_panel

javax.swing.JPanel button_panel

taxonomy_display_scroll_pane

javax.swing.JScrollPane taxonomy_display_scroll_pane

status_bar

javax.swing.JTextField status_bar

display_hierarchy_button

javax.swing.JButton display_hierarchy_button

display_ancestry_button

javax.swing.JButton display_ancestry_button

new_taxonomy_button

javax.swing.JButton new_taxonomy_button

load_taxonomy_button

javax.swing.JButton load_taxonomy_button

save_taxonomy_button

javax.swing.JButton save_taxonomy_button

save_taxonomy_as_button

javax.swing.JButton save_taxonomy_as_button

add_new_sibling_category_button

javax.swing.JButton add_new_sibling_category_button

add_new_child_category_button

javax.swing.JButton add_new_child_category_button

delete_branch_button

javax.swing.JButton delete_branch_button