StagedAttributeSelector (magpie API)

Field Summary

Fields
Modifier and Type Field and Description

protected java.util.List<BaseAttributeSelector> Selectors
List of attribute selectors to use for selection.
- Fields inherited from class magpie.attributes.selectors.BaseAttributeSelector
  trained

Fields
Modifier and Type	Field and Description
`protected java.util.List<BaseAttributeSelector>`	`Selectors` List of attribute selectors to use for selection.

Constructor Summary

Constructors
Constructor and Description

StagedAttributeSelector()

Constructors
Constructor and Description
`StagedAttributeSelector()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSelector(BaseAttributeSelector selector)` Add new selector to list, will be run last
`void`	`clearSelectorList()` Clear the list of selectors
`BaseAttributeSelector`	`clone()`
`java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,Citation>>`	`getCitations()` Return a list of citations for this object and any underlying objects.
`java.util.List<BaseAttributeSelector>`	`getSelectors()` Get the current list of selectors
`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`	`setOptions(java.util.List<java.lang.Object> Options)` Set any options for this object.
`void`	`setSelectors(java.util.List<BaseAttributeSelector> selectors)` Set the list of selectors used by this tool
`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
  - Selectors
```
protected java.util.List<BaseAttributeSelector> Selectors
```
    List of attribute selectors to use for selection. [0] is the first selector to be run.
- Constructor Detail
  - StagedAttributeSelector
```
public StagedAttributeSelector()
```
- Method Detail
  - clone
```
public BaseAttributeSelector clone()
```
    Overrides:
    
    clone in class BaseAttributeSelector
  - setOptions
```
public void setOptions(java.util.List<java.lang.Object> Options)
                throws java.lang.Exception
```
    Description copied from interface: Options
    
    Set any options for this object. If parsing the options fails, return an Exception with the usage as its message.
    
    Specified by:
    
    setOptions in interface Options
    
    Parameters:
    
    Options - Array of options as Objects - can be null
    
    Throws:
    
    java.lang.Exception - if problem with inputs
  - printUsage
```
public java.lang.String printUsage()
```
    Description copied from interface: Options
    
    Print out required format for options. For consistency, should start with "Usage: ".
    
    Specified by:
    
    printUsage in interface Options
    
    Returns:
    
    Usage for this function
  - clearSelectorList
```
public void clearSelectorList()
```
    Clear the list of selectors
  - setSelectors
```
public void setSelectors(java.util.List<BaseAttributeSelector> selectors)
```
    Set the list of selectors used by this tool
    
    Parameters:
    
    selectors - List of selectors in desired order
  - addSelector
```
public void addSelector(BaseAttributeSelector selector)
```
    Add new selector to list, will be run last
    
    Parameters:
    
    selector - Selector to add
  - getSelectors
```
public java.util.List<BaseAttributeSelector> getSelectors()
```
    Get the current list of selectors
    
    Returns:
    
    List of selectors
  - 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()
  - getCitations
```
public java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,Citation>> getCitations()
```
    Description copied from interface: Citable
    
    Return a list of citations for this object and any underlying objects.
    
    Specified by:
    
    getCitations in interface Citable
    
    Returns:
    
    List of pairs: [Reason for Citation], [Citation]

Class StagedAttributeSelector

Field Summary

Fields inherited from class magpie.attributes.selectors.BaseAttributeSelector

Constructor Summary

Method Summary

Methods inherited from class magpie.attributes.selectors.BaseAttributeSelector

Methods inherited from class java.lang.Object

Field Detail

Selectors

Constructor Detail

StagedAttributeSelector

Method Detail

clone

setOptions

printUsage

clearSelectorList

setSelectors

addSelector

getSelectors

train_protected

printDescription

getCitations