adams.flow.sink
Class MatrixPlot

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.core.AbstractDisplay
                  adams.flow.sink.AbstractDisplay
                      adams.flow.sink.AbstractGraphicalDisplay
                          adams.flow.sink.MatrixPlot

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, Actor, ErrorHandler, InputConsumer, ComponentSupplier, MenuBarProvider, SendToActionSupporter, Serializable, Comparable

public class MatrixPlot
extends AbstractGraphicalDisplay

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.
    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: 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
    default:
 

-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
 

Version:

$Revision: 4584 $

Author:

msf8

See Also:

Serialized Form

Field Summary

protected AbstractScatterPlotOverlay[]	m_Overlays Array of overlays for each scatterplot
protected AbstractScatterPlotPaintlet	m_Paintlet Paintlet for plotting the data on each scatter plot
protected int	m_Percent Percentage of sample for subsample
protected Matrix	m_Plot matrix to display
protected int	m_PlotSize Size of each scatterplot

Fields inherited from class adams.flow.sink.AbstractGraphicalDisplay

m_GraphicFileChooser, m_MenuBar, m_MenuItemFileClear, m_MenuItemFileClose, m_MenuItemFileSaveAs, m_MenuItemFileSaveTextAs, m_TextFileChooser, m_Writer

Fields inherited from class adams.flow.core.AbstractDisplay

BACKUP_INPUT, m_CreateFrame, m_Frame, m_Height, m_InputToken, m_Panel, m_ShortTitle, m_Updating, m_Width, m_X, m_Y

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

MatrixPlot()

Method Summary

Class[]	accepts()
void	clearPanel()
void	defineOptions()
protected void	display(Token token)
protected int	getDefaultHeight()
protected int	getDefaultWidth()
AbstractScatterPlotOverlay[]	getOverlays() Get the overlays for each scatterplot
AbstractScatterPlotPaintlet	getPaintlet() Gets the paintlet to use for each scatter plot
int	getPercent() Get the percent of the the instances in each attribute to work with
int	getPlotSize() Get the size of each scatter plot
String	globalInfo()
protected BasePanel	newPanel()
String	overlaysTipText() return a string for the overlays option
String	paintletTipText() returns a string for the paintlet option
String	percentTipText() Tip text for the percent of instances property
String	plotSizeTipText() return a string for the plot size option
void	setOverlays(AbstractScatterPlotOverlay[] val) Set the overlays for each scatterplot in the matrix
void	setPaintlet(AbstractScatterPlotPaintlet val) Sets the paintlet for each scatter plot
void	setPercent(int val) Set the percent of the instances for each attribute to work with
void	setPlotSize(int val) Set the size of each scatter plot

Methods inherited from class adams.flow.sink.AbstractGraphicalDisplay

cleanUpGUI, clear, close, createMenuBar, getGraphicFileChooser, getMenuBar, getSendToClasses, getSendToItem, getTextFileChooser, getWriter, hasPanel, hasSendToItem, postDisplay, preDisplay, saveAs, saveTextAs, setWriter, supplyComponent, supportsClear, updateMenu, writerTipText

Methods inherited from class adams.flow.sink.AbstractDisplay

newDisplayRunnable

Methods inherited from class adams.flow.core.AbstractDisplay

backupState, cleanUp, createFrame, createTitle, doCreateFrame, doExecute, getCreateFrame, getDefaultX, getDefaultY, getFrame, getHeight, getPanel, getQuickInfo, getShortTitle, getWidth, getX, getY, heightTipText, initialize, input, postCreateFrame, preCreateFrame, reset, restoreState, setCreateFrame, setHeight, setShortTitle, setWidth, setX, setY, shortTitleTipText, stopExecution, widthTipText, wrapUp, xTipText, yTipText

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, compareTo, debug, destroy, equals, execute, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, postExecute, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.core.InputConsumer

input

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, debug, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getQuickInfo, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, sizeOf, stopExecution, stopExecution, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Field Detail

m_Plot

protected Matrix m_Plot

matrix to display

m_PlotSize

protected int m_PlotSize

Size of each scatterplot

m_Paintlet

protected AbstractScatterPlotPaintlet m_Paintlet

Paintlet for plotting the data on each scatter plot

m_Overlays

protected AbstractScatterPlotOverlay[] m_Overlays

Array of overlays for each scatterplot

m_Percent

protected int m_Percent

Percentage of sample for subsample

Constructor Detail

MatrixPlot

public MatrixPlot()

Method Detail

accepts

public Class[] accepts()

defineOptions

public void defineOptions()

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractGraphicalDisplay

clearPanel

public void clearPanel()

Specified by:

clearPanel in class AbstractDisplay

newPanel

protected BasePanel newPanel()

Specified by:

newPanel in class AbstractDisplay

display

protected void display(Token token)

Specified by:

display in class AbstractDisplay

globalInfo

public String globalInfo()

Specified by:

globalInfo in class AbstractOptionHandler

getDefaultHeight

protected int getDefaultHeight()

Overrides:

getDefaultHeight in class AbstractDisplay

getDefaultWidth

protected int getDefaultWidth()

Overrides:

getDefaultWidth in class AbstractDisplay

setPaintlet

public void setPaintlet(AbstractScatterPlotPaintlet val)

Sets the paintlet for each scatter plot

Parameters:

val - Paintlet to use

getPaintlet

public AbstractScatterPlotPaintlet getPaintlet()

Gets the paintlet to use for each scatter plot

Returns:

Paintlet to use

paintletTipText

public String paintletTipText()

returns a string for the paintlet option

Returns:

setOverlays

public void setOverlays(AbstractScatterPlotOverlay[] val)

Set the overlays for each scatterplot in the matrix

Parameters:

val - Array of overlays

getOverlays

public AbstractScatterPlotOverlay[] getOverlays()

Get the overlays for each scatterplot

Returns:

Array of overlays

overlaysTipText

public String overlaysTipText()

return a string for the overlays option

Returns:

String for the property

setPlotSize

public void setPlotSize(int val)

Set the size of each scatter plot

Parameters:

val - Size of each plot in pixels

getPlotSize

public int getPlotSize()

Get the size of each scatter plot

Returns:

Size in pixels

plotSizeTipText

public String plotSizeTipText()

return a string for the plot size option

Returns:

string for the property

setPercent

public void setPercent(int val)

Set the percent of the instances for each attribute to work with

Parameters:

val - int percent of instances

getPercent

public int getPercent()

Get the percent of the the instances in each attribute to work with

Returns:

int percent of instances

percentTipText

public String percentTipText()

Tip text for the percent of instances property

Returns:

String describing the property