Class WekaCostBenefitAnalysis

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ClearableDisplay, DisplayTypeSupporter, ErrorHandler, InputConsumer, ComponentSupplier, DisplayPanelProvider, MenuBarProvider, SendToActionSupporter, Serializable, Comparable

    public class WekaCostBenefitAnalysis
    extends AbstractGraphicalDisplay
    implements DisplayPanelProvider
    Actor for displaying a cost benefit analysis dialog.

    - accepts:

    Container information:
    - adams.flow.container.WekaEvaluationContainer: Evaluation, Model, Prediction output

    -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: WekaCostBenefitAnalysis
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
        The annotations to attach to this actor.
    -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 gets stopped in case this actor encounters an error;
         useful for critical actors.
        default: false
    -silent <boolean> (property: silent)
        If enabled, then no errors are output in the console.
        default: false
    -short-title <boolean> (property: shortTitle)
        If enabled uses just the name for the title instead of the actor's full 
        default: false
    -display-in-editor <boolean> (property: displayInEditor)
        If enabled displays the panel in a tab in the flow editor rather than in 
        a separate frame.
        default: false
    -width <int> (property: width)
        The width of the dialog.
        default: 1200
        minimum: -1
    -height <int> (property: height)
        The height of the dialog.
        default: 700
        minimum: -1
    -x <int> (property: x)
        The X position of the dialog (>=0: absolute, -1: left, -2: center, -3: right
        default: -1
        minimum: -3
    -y <int> (property: y)
        The Y position of the dialog (>=0: absolute, -1: top, -2: center, -3: bottom
        default: -1
        minimum: -3
    -writer <adams.gui.print.JComponentWriter> (property: writer)
        The writer to use for generating the graphics output.
        default: adams.gui.print.NullWriter
    -index <> (property: classIndex)
        The range of class label indices (eg used for AUC).
        default: first
        example: An index is a number starting with 1; apart from label names (case-sensitive), the following placeholders can be used as well: first, second, third, last_2, last_1, last
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_ClassIndex

        protected WekaLabelIndex m_ClassIndex
        the index of the class label.
      • m_CostBenefitPanel

        protected weka.gui.beans.CostBenefitAnalysis m_CostBenefitPanel
        the panel.
    • Constructor Detail

      • WekaCostBenefitAnalysis

        public WekaCostBenefitAnalysis()
    • Method Detail

      • getDefaultWidth

        protected int getDefaultWidth()
        Returns the default width for the dialog.
        getDefaultWidth in class AbstractDisplay
        the default width
      • getDefaultHeight

        protected int getDefaultHeight()
        Returns the default height for the dialog.
        getDefaultHeight in class AbstractDisplay
        the default height
      • setClassIndex

        public void setClassIndex​(WekaLabelIndex value)
        Sets the index of class label (1-based).
        value - the label index
      • getClassIndex

        public WekaLabelIndex getClassIndex()
        Returns the current index of class label (1-based).
        the label index
      • classIndexTipText

        public String classIndexTipText()
        Returns the tip text for this property.
        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.
        Specified by:
        accepts in interface InputConsumer
        weka.classifiers.Evaluation.class, adams.flow.container.WekaEvaluationContainer.class
      • display

        protected void display​(Token token)
        Plots the token (the panel and dialog have already been created at this stage).
        Specified by:
        display in class AbstractDisplay
        token - the token to display
      • getEvaluation

        protected weka.classifiers.Evaluation getEvaluation​(Token token)
        Returns the Evaluation object from the token.
        token - the token to extract the Evaluation object from
        the Evaluation object
      • displayPanelRequiresScrollPane

        public boolean displayPanelRequiresScrollPane()
        Returns whether the created display panel requires a scroll pane or not.
        Specified by:
        displayPanelRequiresScrollPane in interface DisplayPanelProvider
        true if the display panel requires a scroll pane