Class MatrixPlot

  • 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 MatrixPlot
    extends AbstractGraphicalDisplay
    implements DisplayPanelProvider
    Actor for displaying a matrix of scatter plots

    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: MatrixPlot
    -annotation <adams.core.base.BaseText> (property: annotations)
        The annotations to attach to this actor.
    -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: 1600
        minimum: 1
    -height <int> (property: height)
        The height of the dialog.
        default: 800
        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
    -plot-size <int> (property: plotSize)
        Set the size for each plot in the matrix
        default: 100
    -overlay <adams.gui.visualization.stats.scatterplot.AbstractScatterPlotOverlay> [-overlay ...] (property: overlays)
        Overlays to display on each scatterplot
    -paintlet <adams.gui.visualization.stats.paintlet.AbstractScatterPlotPaintlet> (property: paintlet)
        Paintlet to display the data
        default: adams.gui.visualization.stats.paintlet.ScatterPaintletCircle
    -percent <int> (property: percent)
        percentage of sample for sub-sample
        default: 100
    See Also:
    Serialized Form
    • Field Detail

      • m_Plot

        protected Matrix m_Plot
        matrix to display
      • m_PlotSize

        protected int m_PlotSize
        Size of each scatterplot
      • m_Percent

        protected int m_Percent
        Percentage of sample for subsample
    • Constructor Detail

      • MatrixPlot

        public MatrixPlot()
    • Method Detail

      • accepts

        public Class[] accepts()
        Description copied from interface: InputConsumer
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        the Class of objects that can be processed
      • 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
        token - the token to display
      • setPaintlet

        public void setPaintlet​(AbstractScatterPlotPaintlet val)
        Sets the paintlet for each scatter plot
        val - Paintlet to use
      • getPaintlet

        public AbstractScatterPlotPaintlet getPaintlet()
        Gets the paintlet to use for each scatter plot
        Paintlet to use
      • paintletTipText

        public String paintletTipText()
        returns a string for the paintlet option
      • setOverlays

        public void setOverlays​(AbstractScatterPlotOverlay[] val)
        Set the overlays for each scatterplot in the matrix
        val - Array of overlays
      • getOverlays

        public AbstractScatterPlotOverlay[] getOverlays()
        Get the overlays for each scatterplot
        Array of overlays
      • overlaysTipText

        public String overlaysTipText()
        return a string for the overlays option
        String for the property
      • setPlotSize

        public void setPlotSize​(int val)
        Set the size of each scatter plot
        val - Size of each plot in pixels
      • getPlotSize

        public int getPlotSize()
        Get the size of each scatter plot
        Size in pixels
      • plotSizeTipText

        public String plotSizeTipText()
        return a string for the plot size option
        string for the property
      • setPercent

        public void setPercent​(int val)
        Set the percent of the instances for each attribute to work with
        val - int percent of instances
      • getPercent

        public int getPercent()
        Get the percent of the instances in each attribute to work with
        int percent of instances
      • percentTipText

        public String percentTipText()
        Tip text for the percent of instances property
        String describing the property
      • createDisplayPanel

        public DisplayPanel createDisplayPanel​(Token token)
        Creates a new display panel for the token.
        Specified by:
        createDisplayPanel in interface DisplayPanelProvider
        token - the token to display in a new panel, can be null
        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
        true if the display panel requires a scroll pane