Package adams.flow.sink

Class ZScoreDisplay

  • 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 ZScoreDisplay
extends AbstractGraphicalDisplay
implements DisplayPanelProvider
    Actor for displaying a z score 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: ZScoreDisplay
 
    -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: 700
    minimum: 1
 
    -height <int> (property: height)
    The height of the dialog.
    default: 500
    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
 
    -overlay <adams.gui.visualization.stats.zscore.AbstractZScoreOverlay> [-overlay ...] (property: overlays)
    Add overlays to the z score plot
    default: adams.gui.visualization.stats.zscore.Mean, adams.gui.visualization.stats.zscore.StdDev -color #ffc800 -standard-deviations 2.0, adams.gui.visualization.stats.zscore.StdDev -color #ff0000 -standard-deviations 3.0
 
    -paintlet <adams.gui.visualization.stats.paintlet.AbstractZScorePaintlet> (property: paintlet)
    Choose paintlet for plotting data
    default: adams.gui.visualization.stats.paintlet.ZScoreCircle
 
    -attribute-name <adams.core.base.BaseRegExp> (property: attributeName)
    Name of attribute to display, used if set,otherwise the index is used
    default:
 
    -attribute <java.lang.String> (property: attribute)
    Set the attribute to display using an index, used only if regular expression
    not set
    default: 1
    Author:
    msf8
    See Also:
    Serialized Form

    • Field Detail

      • m_ZScore

        protected ZScore m_ZScore
        zscore to display using the actor

      • m_Att

        protected BaseRegExp m_Att
        String for regular expression for attribute

      • m_AttIndex

        protected String m_AttIndex
        String for index to set attribute

      • m_ShowOptions

        protected boolean m_ShowOptions
        whether to show the options in the display or not.

    • Constructor Detail

      • ZScoreDisplay

        public ZScoreDisplay()

    • 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

      • setAttributeName

        public void setAttributeName​(BaseRegExp val)
        Set the attribute to use with a regular expression
        Parameters:
        val - String for regular expression

      • getAttributeName

        public BaseRegExp getAttributeName()
        Get the string to set the attribute using a regular expression
        Returns:
        String for regular expression

      • attributeNameTipText

        public String attributeNameTipText()
        Return a tip text for the attribute name property
        Returns:
        tip text for the property

      • setShowOptions

        public void setShowOptions​(boolean value)
        Sets whether to show the options panel or not.
        Parameters:
        value - true if to show the options

      • getShowOptions

        public boolean getShowOptions()
        Returns whether to show the options or not.
        Returns:
        true if the options are shown

      • showOptionsTipText

        public String showOptionsTipText()
        Return a tip text for the attribute name property
        Returns:
        tip text for the property

      • setAttribute

        public void setAttribute​(String val)
        Set the string to use for setting the attribute using an index
        Parameters:
        val - String for the attribute index

      • getAttribute

        public String getAttribute()
        Get the string used to set the attribute using an index
        Returns:
        String for the index

      • attributeTipText

        public String attributeTipText()
        return a tip text for the attribute index property
        Returns:
        tip text for the property

      • setOverlays

        public void setOverlays​(AbstractZScoreOverlay[] over)
        set the overlays to be drawn on the z score plot
        Parameters:
        over - Array containing the overlays

      • getOverlays

        public AbstractZScoreOverlay[] getOverlays()
        get the overlays to be drawn on the z score plot
        Returns:
        Array containing the overlays

      • overlaysTipText

        public String overlaysTipText()
        Returns a tip text for the overlays property
        Returns:
        Tip text for the property

      • setPaintlet

        public void setPaintlet​(AbstractZScorePaintlet paintlet)
        Setbefore regular expression if this is provide the paintlet to be used for displaying the data
        Parameters:
        paintlet - Paintlet to be used

      • getPaintlet

        public AbstractZScorePaintlet getPaintlet()
        Get the paintlet to be used for plotting the data
        Returns:
        Paintlet to be used

      • paintletTipText

        public String paintletTipText()
        Returns a tip text for the paintlet property
        Returns:
        Tip text for this 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

      • 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