magpie.attributes.selectors

Class UserSpecifiedAttributeSelector

java.lang.Object

magpie.attributes.selectors.BaseAttributeSelector

magpie.attributes.selectors.UserSpecifiedAttributeSelector

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Commandable, Options, Printable

Direct Known Subclasses:

MeredigAttributeSelector, UserSpecifiedExcludingAttributeSelector

public class UserSpecifiedAttributeSelector
extends BaseAttributeSelector

Use only attributes with a specified name or ID number.

Usage: <names...>
names: Names of attributes to select

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	SelectedAttributes Names of attributes to be used

Fields inherited from class magpie.attributes.selectors.BaseAttributeSelector

trained

Constructor Summary

Constructors

Constructor and Description
UserSpecifiedAttributeSelector()

Method Summary

Modifier and Type	Method and Description
void	addAttributeSpecification(java.lang.String attribute) Add an attribute to the list of attributes to be selected
void	clearSpecifiedAttributes() Clear list of user-specified attributes
UserSpecifiedAttributeSelector	clone()
java.lang.String	printDescription(boolean htmlFormat) Print full name of object, and a simple description of the options.
java.lang.String	printUsage() Print out required format for options.
void	selectAttributes(java.util.List<java.lang.String> Attributes) Define a list of attributes that will be used when training a model
void	setOptions(java.util.List<java.lang.Object> OptionsObj) Sets the object to select only attributes listed in input
protected java.util.List<java.lang.Integer>	train_protected(Dataset Data) Operation that actually does the work for training.

Methods inherited from class magpie.attributes.selectors.BaseAttributeSelector

about, applyAttributeSelection, getSelectionNames, getSelections, isTrained, printCommand, printSelections, run, runCommand, train

Methods inherited from class java.lang.Object

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

Field Detail

SelectedAttributes

protected java.util.List<java.lang.String> SelectedAttributes

Names of attributes to be used

Constructor Detail

UserSpecifiedAttributeSelector

public UserSpecifiedAttributeSelector()

Method Detail

setOptions

public void setOptions(java.util.List<java.lang.Object> OptionsObj)
                throws java.lang.Exception

Sets the object to select only attributes listed in input

Parameters:

OptionsObj - List of attributes to use

Throws:

java.lang.Exception

printUsage

public java.lang.String printUsage()

Description copied from interface: Options

Print out required format for options. For consistency, should start with "Usage: ".

Returns:

Usage for this function

clone

public UserSpecifiedAttributeSelector clone()

Overrides:

clone in class BaseAttributeSelector

clearSpecifiedAttributes

public void clearSpecifiedAttributes()

Clear list of user-specified attributes

addAttributeSpecification

public void addAttributeSpecification(java.lang.String attribute)

Add an attribute to the list of attributes to be selected

Parameters:

attribute - Name of attribute

selectAttributes

public void selectAttributes(java.util.List<java.lang.String> Attributes)

Define a list of attributes that will be used when training a model

Parameters:

Attributes - List of desired attributes

train_protected

protected java.util.List<java.lang.Integer> train_protected(Dataset Data)

Description copied from class: BaseAttributeSelector

Operation that actually does the work for training. Must generate a list of attribute IDs

Specified by:

train_protected in class BaseAttributeSelector

Parameters:

Data - Dataset used to train selector

Returns:

List of indexes of selected attributes

printDescription

public java.lang.String printDescription(boolean htmlFormat)

Description copied from interface: Printable

Print full name of object, and a simple description of the options. This description should print enough information to reproduce how this object was created, but not necessarily enough to run it (e.g., coefficients for the model).

Example: For a model training a separate WekaRegression for intermetallics

magpie.models.regression.SplitRegression

Splitter: AllMetalsSplitter
All Metals: magpie.models.regression.WekaRegression trees.REPTree
Contains Nonmetal: magpie.regression.LASSORegreession -maxterms 2

Specified by:

printDescription in interface Printable

Overrides:

printDescription in class BaseAttributeSelector

Parameters:

htmlFormat - Whether format for output to an HTML page (e.g., <div> to create indentation) or for printing to screen.

Returns:

String describing the model

See Also:

#printModel()