Package adams.flow.sink

Class FourInOneDisplay

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ClearableDisplay, DisplayTypeSupporter, ErrorHandler, FlowControlSubMenuSupporter, HeadlessExecutionSupporter, InputConsumer, ComponentSupplier, DisplayPanelProvider, MenuBarProvider, SendToActionSupporter, Serializable, Comparable
    public class FourInOneDisplay
extends AbstractGraphicalDisplay
implements DisplayPanelProvider
    Actor for displaying a four-in-one plot. Contains a histogram, a normal probability plot, vs fit plot and vs order plot

    Valid options are: 

    -D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: FourInOneDisplay
 
    -annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 
    -stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 
    -width <int> (property: width)
    The width of the dialog.
    default: 1200
    minimum: 1
 
    -height <int> (property: height)
    The height of the dialog.
    default: 750
    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
 
    -actual-attribute <java.lang.String> (property: actualAttribute)
    1-based index of the actual attribute
    default: 1
 
    -predicted-attribute <java.lang.String> (property: predictedAttribute)
    1-based index of the predicted attribute
    default: 2
 
    -normal-plot-options <adams.gui.visualization.stats.probabilityplot.NormalPlotOptions> (property: normalPlotOptions)
    options for normal plot
    default: adams.gui.visualization.stats.probabilityplot.NormalPlotOptions
 
    -versus-fit-options <adams.gui.visualization.stats.fourinone.VersusFitOptions> (property: versusFitOptions)
    options for the versus fit graph
    default: adams.gui.visualization.stats.fourinone.VersusFitOptions -paintlet adams.gui.visualization.stats.paintlet.VsFitPaintlet
 
    -histogram-options <adams.gui.visualization.stats.histogram.HistogramOptions> (property: histogramOptions)
    options for the histogram graph
    default: adams.gui.visualization.stats.histogram.HistogramOptions -paintlet adams.gui.visualization.stats.paintlet.HistogramPaintlet
 
    -versus-order-options <adams.gui.visualization.stats.fourinone.VersusOrderOptions> (property: versusOrderOptions)
    options for the versus order graph
    default: adams.gui.visualization.stats.fourinone.VersusOrderOptions -paintlet adams.gui.visualization.stats.paintlet.VsOrderPaintlet
    Author:
    msf8
    See Also:
    Serialized Form

    • Field Detail

      • m_Plot

        protected FourInOne m_Plot
        panel to display the actor

      • m_NormalPlotOptions

        protected NormalPlotOptions m_NormalPlotOptions
        options for the normal plot

      • m_HistogramOptions

        protected HistogramOptions m_HistogramOptions
        Options for the histogram

      • m_VersusFitOptions

        protected VersusFitOptions m_VersusFitOptions
        Options for the vs fit

      • m_VersusOrderOptions

        protected VersusOrderOptions m_VersusOrderOptions
        Options for the vs order

      • m_Act

        protected String m_Act
        the 0-based index of the actual attribute.

      • m_pred

        protected String m_pred
        the 0-based index of the predicted attribute.

    • Constructor Detail

      • FourInOneDisplay

        public FourInOneDisplay()

    • Method Detail

      • accepts

        public Class[] accepts()
        Description copied from interface: InputConsumer
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the Class of objects that can be processed

      • setActualAttribute

        public void setActualAttribute​(String val)
        Set the string to use as an index for the actual attribute
        Parameters:
        val - String for the index

      • getActualAttribute

        public String getActualAttribute()
        Get the string used for the index for the actual attribute
        Returns:
        String for the index

      • actualAttributeTipText

        public String actualAttributeTipText()
        Tip text for the actual attribute property
        Returns:
        String describing the property

      • setPredictedAttribute

        public void setPredictedAttribute​(String val)
        Set the string to use as an index for the predicted attribute
        Parameters:
        val - String for the index

      • getPredictedAttribute

        public String getPredictedAttribute()
        Get the string used for the index for the predicted attribute
        Returns:
        String for the index

      • predictedAttributeTipText

        public String predictedAttributeTipText()
        Tip text for the predicted attribute property
        Returns:
        String describing the property

      • setHistogramOptions

        public void setHistogramOptions​(HistogramOptions val)
        Set the options for the histogram
        Parameters:
        val - Histogramoptions object containing the options

      • getHistogramOptions

        public HistogramOptions getHistogramOptions()
        Get the options for the histogram
        Returns:
        Histogramoptions object containing the options for the histogram

      • histogramOptionsTipText

        public String histogramOptionsTipText()
        Tip text for the histogram options property
        Returns:
        String describing the property

      • setVersusOrderOptions

        public void setVersusOrderOptions​(VersusOrderOptions val)
        Set the options for the vs order plot
        Parameters:
        val - Versusorderoptions object containing the options

      • getVersusOrderOptions

        public VersusOrderOptions getVersusOrderOptions()
        Get the options for the vsorder plot
        Returns:
        Versusorder object containing the options

      • versusOrderOptionsTipText

        public String versusOrderOptionsTipText()
        Tip text for the vsorder options property
        Returns:
        String describing the property

      • setVersusFitOptions

        public void setVersusFitOptions​(VersusFitOptions val)
        Set the options for the vsfit plot
        Parameters:
        val - Vsfiroptions object containing the options

      • getVersusFitOptions

        public VersusFitOptions getVersusFitOptions()
        Get the options for the vsfit plot
        Returns:
        vsfitoptions object containing the options

      • versusFitOptionsTipText

        public String versusFitOptionsTipText()
        Tip text for the vs fit options property
        Returns:
        String describing the property

      • setNormalPlotOptions

        public void setNormalPlotOptions​(NormalPlotOptions val)
        Set the options for the normal plot
        Parameters:
        val - Normalplotoptions object containing the options

      • getNormalPlotOptions

        public NormalPlotOptions getNormalPlotOptions()
        get the options for the normal plot
        Returns:
        Normalplotoptions object containing the options

      • normalPlotOptionsTipText

        public String normalPlotOptionsTipText()
        tip text for the normalplot options property
        Returns:
        String describing the property

      • display

        protected void display​(Token token)
        Description copied from class: AbstractDisplay
        Displays the token (the panel and dialog have already been created at this stage).
        Specified by:
        display in class AbstractDisplay
        Parameters:
        token - the token to display

      • createDisplayPanel

        public DisplayPanel createDisplayPanel​(Token token)
        Creates a new display panel for the token.
        Specified by:
        createDisplayPanel in interface DisplayPanelProvider
        Parameters:
        token - the token to display in a new panel, can be null
        Returns:
        the generated panel

      • displayPanelRequiresScrollPane

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