java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - weka.core.AbstractSimpleOptionHandler
      - weka.classifiers.simple.AbstractSimpleClassifier
        
        weka.classifiers.functions.FromPredictions

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable, weka.classifiers.Classifier, weka.core.CapabilitiesHandler, weka.core.OptionHandler
```
public class FromPredictions
extends AbstractSimpleClassifier
```
Encapsulates predictions from a spreadsheet. Dummy classifier for the Investigator.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected SpreadSheetColumnIndex`	`m_Actual`	the column with the actual values.
`protected int`	`m_ActualIndex`	the actual column index.
`protected SpreadSheetColumnRange`	`m_Additional`	the additional columns in the spreadsheet to add to the plot containers.
`protected int[]`	`m_AdditionalIndices`	the additional column indices.
`protected SpreadSheetUnorderedColumnRange`	`m_ClassDistribution`	the class distribution columns (if any).
`protected int[]`	`m_ClassDistributionIndices`	the class distribution column indices.
`protected SpreadSheetColumnIndex`	`m_Predicted`	the column with the predicted values.
`protected int`	`m_PredictedIndex`	the predicted column index.
`protected SpreadSheet`	`m_Predictions`	the actual predictions.
`protected PlaceholderFile`	`m_PredictionsFile`	the predictions to use.
`protected SpreadSheetReader`	`m_Reader`	the spreadsheet reader to use.
`protected SpreadSheetColumnIndex`	`m_Weight`	the column with the error values (optional).
`protected int`	`m_WeightIndex`	the weight column index.

Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

FromPredictions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`actualTipText()`	Returns the tip text for this property.
`String`	`additionalTipText()`	Returns the tip text for this property.
`void`	`buildClassifier(weka.core.Instances data)`	Just loads the predictions.
`String`	`classDistributionTipText()`	Returns the tip text for this property.
`double`	`classifyInstance(weka.core.Instance instance)`	Always returns 0.
`void`	`defineOptions()`	Adds options to the internal list of options.
`SpreadSheetColumnIndex`	`getActual()`	Returns the column with the actual values.
`int`	`getActualIndex()`	Returns the actual 0-based index.
`SpreadSheetColumnRange`	`getAdditional()`	Returns the additional columns to add to the plot containers.
`int[]`	`getAdditionalIndices()`	Returns the 0-based indices of the additional columns.
`SpreadSheetUnorderedColumnRange`	`getClassDistribution()`	Returns the class distribution columns.
`int[]`	`getClassDistributionIndices()`	Returns the 0-based indices of the class distribution columns.
`SpreadSheetColumnIndex`	`getPredicted()`	Returns the column with the predicted values.
`int`	`getPredictedIndex()`	Returns the predicted 0-based index.
`SpreadSheet`	`getPredictions()`	Returns the predictions that were loaded.
`PlaceholderFile`	`getPredictionsFile()`	Returns the file with the predictions.
`SpreadSheetReader`	`getReader()`	Returns the spreadsheet reader to use.
`SpreadSheetColumnIndex`	`getWeight()`	Returns the column with the weight values.
`int`	`getWeightIndex()`	Returns the weight 0-based index.
`String`	`globalInfo()`	Returns a string describing the object.
`String`	`predictedTipText()`	Returns the tip text for this property.
`String`	`predictionsFileTipText()`	Returns the tip text for this property.
`String`	`readerTipText()`	Returns the tip text for this property.
`void`	`setActual(SpreadSheetColumnIndex value)`	Sets the column with the actual values.
`void`	`setAdditional(SpreadSheetColumnRange value)`	Sets the additional columns to add to the plot containers.
`void`	`setClassDistribution(SpreadSheetUnorderedColumnRange value)`	Sets the class distribution columns.
`void`	`setPredicted(SpreadSheetColumnIndex value)`	Sets the column with the predicted values.
`void`	`setPredictionsFile(PlaceholderFile value)`	Sets the file with the predictions.
`void`	`setReader(SpreadSheetReader value)`	Sets the spreadsheet reader to use.
`void`	`setWeight(SpreadSheetColumnIndex value)`	Sets the column with the weight values.
`String`	`weightTipText()`	Returns the tip text for this property.

Methods inherited from class weka.classifiers.simple.AbstractSimpleClassifier
distributionForInstance, getCapabilities, runClassifier

Methods inherited from class weka.core.AbstractSimpleOptionHandler
getOptions, listOptions, setOptions

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

- Field Detail
  - m_PredictionsFile
```
protected PlaceholderFile m_PredictionsFile
```
    the predictions to use.
  - m_Reader
```
protected SpreadSheetReader m_Reader
```
    the spreadsheet reader to use.
  - m_Actual
```
protected SpreadSheetColumnIndex m_Actual
```
    the column with the actual values.
  - m_ActualIndex
```
protected int m_ActualIndex
```
    the actual column index.
  - m_Predicted
```
protected SpreadSheetColumnIndex m_Predicted
```
    the column with the predicted values.
  - m_PredictedIndex
```
protected int m_PredictedIndex
```
    the predicted column index.
  - m_Weight
```
protected SpreadSheetColumnIndex m_Weight
```
    the column with the error values (optional).
  - m_WeightIndex
```
protected int m_WeightIndex
```
    the weight column index.
  - m_ClassDistribution
```
protected SpreadSheetUnorderedColumnRange m_ClassDistribution
```
    the class distribution columns (if any).
  - m_ClassDistributionIndices
```
protected int[] m_ClassDistributionIndices
```
    the class distribution column indices.
  - m_Additional
```
protected SpreadSheetColumnRange m_Additional
```
    the additional columns in the spreadsheet to add to the plot containers.
  - m_AdditionalIndices
```
protected int[] m_AdditionalIndices
```
    the additional column indices.
  - m_Predictions
```
protected SpreadSheet m_Predictions
```
    the actual predictions.
- Constructor Detail
  - FromPredictions
```
public FromPredictions()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Returns a string describing the object.
    
    Specified by:
    
    globalInfo in interface GlobalInfoSupporter
    
    Specified by:
    
    globalInfo in class AbstractOptionHandler
    
    Returns:
    
    a description suitable for displaying in the gui
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractOptionHandler
  - setPredictionsFile
```
public void setPredictionsFile(PlaceholderFile value)
```
    Sets the file with the predictions.
    
    Parameters:
    
    value - the file
  - getPredictionsFile
```
public PlaceholderFile getPredictionsFile()
```
    Returns the file with the predictions.
    
    Returns:
    
    the file
  - predictionsFileTipText
```
public String predictionsFileTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setReader
```
public void setReader(SpreadSheetReader value)
```
    Sets the spreadsheet reader to use.
    
    Parameters:
    
    value - the reader
  - getReader
```
public SpreadSheetReader getReader()
```
    Returns the spreadsheet reader to use.
    
    Returns:
    
    the reader
  - readerTipText
```
public String readerTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setActual
```
public void setActual(SpreadSheetColumnIndex value)
```
    Sets the column with the actual values.
    
    Parameters:
    
    value - the column
  - getActual
```
public SpreadSheetColumnIndex getActual()
```
    Returns the column with the actual values.
    
    Returns:
    
    the range
  - actualTipText
```
public String actualTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setPredicted
```
public void setPredicted(SpreadSheetColumnIndex value)
```
    Sets the column with the predicted values.
    
    Parameters:
    
    value - the column
  - getPredicted
```
public SpreadSheetColumnIndex getPredicted()
```
    Returns the column with the predicted values.
    
    Returns:
    
    the range
  - predictedTipText
```
public String predictedTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setWeight
```
public void setWeight(SpreadSheetColumnIndex value)
```
    Sets the column with the weight values.
    
    Parameters:
    
    value - the column
  - getWeight
```
public SpreadSheetColumnIndex getWeight()
```
    Returns the column with the weight values.
    
    Returns:
    
    the column
  - weightTipText
```
public String weightTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setClassDistribution
```
public void setClassDistribution(SpreadSheetUnorderedColumnRange value)
```
    Sets the class distribution columns.
    
    Parameters:
    
    value - the columns
  - getClassDistribution
```
public SpreadSheetUnorderedColumnRange getClassDistribution()
```
    Returns the class distribution columns.
    
    Returns:
    
    the columns
  - classDistributionTipText
```
public String classDistributionTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAdditional
```
public void setAdditional(SpreadSheetColumnRange value)
```
    Sets the additional columns to add to the plot containers.
    
    Parameters:
    
    value - the columns
  - getAdditional
```
public SpreadSheetColumnRange getAdditional()
```
    Returns the additional columns to add to the plot containers.
    
    Returns:
    
    the columns
  - additionalTipText
```
public String additionalTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - getPredictions
```
public SpreadSheet getPredictions()
```
    Returns the predictions that were loaded.
    
    Returns:
    
    the predictions, null if not available
  - getActualIndex
```
public int getActualIndex()
```
    Returns the actual 0-based index.
    
    Returns:
    
    the index, -1 if not initialized
  - getPredictedIndex
```
public int getPredictedIndex()
```
    Returns the predicted 0-based index.
    
    Returns:
    
    the index, -1 if not initialized
  - getWeightIndex
```
public int getWeightIndex()
```
    Returns the weight 0-based index.
    
    Returns:
    
    the index, -1 if not initialized
  - getClassDistributionIndices
```
public int[] getClassDistributionIndices()
```
    Returns the 0-based indices of the class distribution columns.
    
    Returns:
    
    the indices, 0-length array if not initialized or not used
  - getAdditionalIndices
```
public int[] getAdditionalIndices()
```
    Returns the 0-based indices of the additional columns.
    
    Returns:
    
    the indices, 0-length array if not initialized or not used
  - buildClassifier
```
public void buildClassifier(weka.core.Instances data)
                     throws Exception
```
    Just loads the predictions.
    
    Parameters:
    
    data - ignored
    
    Throws:
    
    Exception - if loading of predictions failed
  - classifyInstance
```
public double classifyInstance(weka.core.Instance instance)
                        throws Exception
```
    Always returns 0.
    
    Specified by:
    
    classifyInstance in interface weka.classifiers.Classifier
    
    Overrides:
    
    classifyInstance in class AbstractSimpleClassifier
    
    Parameters:
    
    instance - the instance to be classified
    
    Returns:
    
    always 0
    
    Throws:
    
    Exception - never thrown

Class FromPredictions

Field Summary

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Constructor Summary

Method Summary

Methods inherited from class weka.classifiers.simple.AbstractSimpleClassifier

Methods inherited from class weka.core.AbstractSimpleOptionHandler

Methods inherited from class adams.core.option.AbstractOptionHandler

Methods inherited from class adams.core.logging.LoggingObject

Methods inherited from class java.lang.Object

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Field Detail

m_PredictionsFile

m_Reader

m_Actual

m_ActualIndex

m_Predicted

m_PredictedIndex

m_Weight

m_WeightIndex

m_ClassDistribution

m_ClassDistributionIndices

m_Additional

m_AdditionalIndices

m_Predictions

Constructor Detail

FromPredictions

Method Detail

globalInfo

defineOptions

setPredictionsFile

getPredictionsFile

predictionsFileTipText

setReader

getReader

readerTipText

setActual

getActual

actualTipText

setPredicted

getPredicted

predictedTipText

setWeight

getWeight

weightTipText

setClassDistribution

getClassDistribution

classDistributionTipText

setAdditional

getAdditional

additionalTipText

getPredictions

getActualIndex

getPredictedIndex

getWeightIndex

getClassDistributionIndices

getAdditionalIndices

buildClassifier

classifyInstance