Package adams.flow.sink

Class ControlChartPlot

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ClearableDisplay, DisplayTypeSupporter, ErrorHandler, InputConsumer, ComponentSupplier, MenuBarProvider, SendToActionSupporter, ColorProviderHandler, Serializable, Comparable
    public class ControlChartPlot
extends AbstractGraphicalDisplay
implements ColorProviderHandler
    Actor for generating control chart plots.
    The plot needs to be initialized with a class adams.flow.container.ControlChartContainer. After that, individual numbers or arrays, depending on the control chart algorithm used, can be plotted. The last limits encountered (lower/center/upper) are used for all subsequent values. A vertical indicator is used to separate the data that was used for determining the limits and all subsequent data.

    Input/output:
    - accepts:
       adams.flow.container.ControlChartContainer
       java.lang.Double
       java.lang.Float
       java.lang.Integer
       java.lang.Double[]
       double[]
       java.lang.Float[]
       float[]
       java.lang.Integer[]
       int[]


    Container information:
    - adams.flow.container.ControlChartContainer: Algor, Chart, Data, Prepared, Limits 

    -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: ControlChartPlot
 
    -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 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 
    name.
    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: 800
    minimum: -1
 
    -height <int> (property: height)
    The height of the dialog.
    default: 350
    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
 
    -violation-finder <adams.data.spc.ViolationFinder> (property: violationFinder)
    The algorithm for locating violations.
    default: adams.data.spc.NullViolations
 
    -paintlet <adams.flow.sink.controlchartplot.AbstractControlChartPaintlet> (property: paintlet)
    The paintlet to use for painting the data.
    default: adams.flow.sink.controlchartplot.ChartPaintlet
 
    -limit-paintlet <adams.flow.sink.controlchartplot.AbstractControlChartPaintlet> (property: limitPaintlet)
    The paintlet to use for painting the limits.
    default: adams.flow.sink.controlchartplot.LimitPaintlet
 
    -separator-paintlet <adams.flow.sink.sequenceplotter.MarkerPaintlet> (property: separatorPaintlet)
    The paintlet to use for separating data used for initializing the limits 
    and subsequent data.
    default: adams.flow.sink.sequenceplotter.VerticalMarkers
 
    -mouse-click-action <adams.flow.sink.sequenceplotter.MouseClickAction> (property: mouseClickAction)
    The action to use for mouse clicks on the canvas.
    default: adams.flow.sink.sequenceplotter.NullClickAction
 
    -color-provider <adams.gui.visualization.core.ColorProvider> (property: colorProvider)
    The color provider in use for generating the colors for the various plots.
    default: adams.gui.visualization.core.DefaultColorProvider
 
    -title <java.lang.String> (property: title)
    The title for the border around the plot.
    default: 
 
    -axis-x <adams.gui.visualization.core.AxisPanelOptions> (property: axisX)
    The setup for the X axis.
    default: adams.gui.visualization.core.AxisPanelOptions -label sample -tick-generator \"adams.gui.visualization.core.axis.FancyTickGenerator -num-ticks 20\" -nth-value 1 -width 40 -top-margin 0.05 -bottom-margin 0.05 -custom-format 0
 
    -axis-y <adams.gui.visualization.core.AxisPanelOptions> (property: axisY)
    The setup for the Y axis.
    default: adams.gui.visualization.core.AxisPanelOptions -label y -tick-generator adams.gui.visualization.core.axis.FancyTickGenerator -nth-value 2 -width 60 -top-margin 0.05 -bottom-margin 0.05 -custom-format 0.0
 
    -post-processor <adams.flow.sink.sequenceplotter.AbstractSequencePostProcessor> (property: postProcessor)
    The post-processor to use on the sequences after a token has been added.
    default: adams.flow.sink.sequenceplotter.PassThrough
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_ViolationFinder

        protected ViolationFinder m_ViolationFinder
        for locating violations.

      • m_SeparatorPaintlet

        protected MarkerPaintlet m_SeparatorPaintlet
        the paintlet to use for separating initialization data and subsequent data.

      • m_ColorProvider

        protected ColorProvider m_ColorProvider
        the color provider to use.

      • m_MouseClickAction

        protected MouseClickAction m_MouseClickAction
        the mouse click action.

      • m_Title

        protected String m_Title
        the title.

      • m_Chart

        protected ControlChart m_Chart
        the chart algorithm to use.

      • m_ChartName

        protected String m_ChartName
        the chart name.

      • m_Limits

        protected Limits m_Limits
        the limits to use.

      • m_Counter

        protected NamedCounter m_Counter
        for keeping track of the tokens.

    • Constructor Detail

      • ControlChartPlot

        public ControlChartPlot()

    • Method Detail

      • getDefaultWidth

        protected int getDefaultWidth()
        Returns the default width for the dialog.
        Overrides:
        getDefaultWidth in class AbstractDisplay
        Returns:
        the default width

      • getDefaultHeight

        protected int getDefaultHeight()
        Returns the default height for the dialog.
        Overrides:
        getDefaultHeight in class AbstractDisplay
        Returns:
        the default height

      • setViolationFinder

        public void setViolationFinder​(ViolationFinder value)
        Sets the algorithm for locating violations.
        Parameters:
        value - the algorithm

      • getViolationFinder

        public ViolationFinder getViolationFinder()
        Returns the algorithm for locating violations.
        Returns:
        the algorithm

      • violationFinderTipText

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

      • paintletTipText

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

      • setLimitPaintlet

        public void setLimitPaintlet​(AbstractControlChartPaintlet value)
        Sets the paintlet to use for painting the limits.
        Parameters:
        value - the paintlet

      • getLimitPaintlet

        public AbstractControlChartPaintlet getLimitPaintlet()
        Returns the paintlet to use for painting the limits.
        Returns:
        the paintlet

      • limitPaintletTipText

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

      • setSeparatorPaintlet

        public void setSeparatorPaintlet​(MarkerPaintlet value)
        Sets the paintlet to use for separating intialization data and subsequent data.
        Parameters:
        value - the paintlet

      • getSeparatorPaintlet

        public MarkerPaintlet getSeparatorPaintlet()
        Returns the paintlet to use for separating intialization data and subsequent data.
        Returns:
        the paintlet

      • separatorPaintletTipText

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

      • setMouseClickAction

        public void setMouseClickAction​(MouseClickAction value)
        Sets the mouse click action to use.
        Parameters:
        value - the action

      • getMouseClickAction

        public MouseClickAction getMouseClickAction()
        Returns the current mouse click action in use.
        Returns:
        the action

      • mouseClickActionTipText

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

      • colorProviderTipText

        public String colorProviderTipText()
        Returns the tip text for this property.
        Specified by:
        colorProviderTipText in interface ColorProviderHandler
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • getDefaultAxisX

        protected AxisPanelOptions getDefaultAxisX()
        Returns the setup for the X axis.
        Returns:
        the setup

      • getDefaultAxisY

        protected AxisPanelOptions getDefaultAxisY()
        Returns the setup for the Y axis.
        Returns:
        the setup

      • setAxisX

        public void setAxisX​(AxisPanelOptions value)
        Sets the setup for the X axis.
        Parameters:
        value - the setup

      • getAxisX

        public AxisPanelOptions getAxisX()
        Returns the setup for the X axis.
        Returns:
        the setup

      • axisXTipText

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

      • setAxisY

        public void setAxisY​(AxisPanelOptions value)
        Sets the setup for the Y axis.
        Parameters:
        value - the setup

      • getAxisY

        public AxisPanelOptions getAxisY()
        Returns the setup for the Y axis.
        Returns:
        the setup

      • axisYTipText

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

      • setTitle

        public void setTitle​(String value)
        Sets the title for border around the plot.
        Parameters:
        value - the title

      • getTitle

        public String getTitle()
        Returns the title for border around the plot.
        Returns:
        the title

      • titleTipText

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

      • setPostProcessor

        public void setPostProcessor​(AbstractSequencePostProcessor value)
        Sets the post-processor for the sequences.
        Parameters:
        value - the post-processor

      • getPostProcessor

        public AbstractSequencePostProcessor getPostProcessor()
        Returns the limit on the number of data points per sequence.
        Returns:
        the limit

      • postProcessorTipText

        public String postProcessorTipText()
        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.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the classes

      • display

        protected void display​(Token token)
        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