Package adams.flow.transformer

Class PredictionEccentricity

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class PredictionEccentricity
extends AbstractTransformer
    Treats the predictions from a regressor as an image and computes the 'eccentricity' of the actual vs predicted plot. Generated values range from 1 to infinity with a value of 1 representing a circular shape.
    Projects the predictions onto the specified grid, using the 'actual' for both axes.

    For more details see:
    https://en.wikipedia.org/wiki/Eccentricity_(mathematics)

    Input/output:
    - accepts:
       adams.data.spreadsheet.SpreadSheet
    - generates:
       adams.flow.container.PredictionEccentricityContainer


    Container information:
    - adams.flow.container.PredictionEccentricityContainer: Predictions, Eccentricity, Matrix 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: PredictionEccentricity
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this 
    actor encounters an error; the error gets propagated; useful for critical 
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing 
    actor handler must have this enabled as well.
    default: false
 
    -actual <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: actual)
    The column with the actual values.
    default: Actual
    example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -predicted <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: predicted)
    The column with the predicted values.
    default: Predicted
    example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -grid <int> (property: grid)
    The size of the grid to project the predictions onto.
    default: 100
    minimum: 1
 
    -morphology <ERODE|DILATE> [-morphology ...] (property: morphologies)
    The morphologies to apply.
    default: DILATE
 
    -num-cycles <int> (property: numCycles)
    The number of cycles to apply.
    default: 1
    minimum: 0
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Grid

        protected int m_Grid
        the size of the grid.

      • m_NumCycles

        protected int m_NumCycles
        the number of cycles to apply.

    • Constructor Detail

      • PredictionEccentricity

        public PredictionEccentricity()

    • Method Detail

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

      • setGrid

        public void setGrid​(int value)
        Sets the size of the grid.
        Parameters:
        value - the size

      • getGrid

        public int getGrid()
        Returns the grid size.
        Returns:
        the size

      • gridTipText

        public String gridTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • morphologiesTipText

        public String morphologiesTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setNumCycles

        public void setNumCycles​(int value)
        Sets the number of cycles to apply.
        Parameters:
        value - the cycles

      • getNumCycles

        public int getNumCycles()
        Returns the number of cycles to apply.
        Returns:
        the cycles

      • numCyclesTipText

        public String numCyclesTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message