BoundaryPlotter (interruptible-weka 0.1.2 API)

java.lang.Object
- weka.knowledgeflow.steps.BaseStep
- - weka.knowledgeflow.steps.BoundaryPlotter

All Implemented Interfaces:: java.io.Serializable, BaseStepExtender, DataCollector, Step

@KFStep(name="BoundaryPlotter",
        category="Visualization",
        toolTipText="Visualize class/cluster decision boundaries in a 2D plot",
        iconPath="weka/gui/knowledgeflow/icons/DefaultDataVisualizer.gif")
public class BoundaryPlotter
extends BaseStep
implements DataCollector

A step that computes visualization data for class/cluster decision boundaries.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BoundaryPlotter.RenderingUpdateListener` Interface for something that wants to be informed of rendering progress updates
`protected static class`	`BoundaryPlotter.RowResult` Holds computed image data for a row of an image
`protected static class`	`BoundaryPlotter.SchemeRowTask` A task for computing a row of an image using a trained model

Field Summary

Fields
Modifier and Type	Field and Description
`static java.awt.Color[]`	`DEFAULT_COLORS` default colours for classes
`protected java.util.List<Classifier>`	`m_classifierTemplates` Classifiers to use
`protected java.util.List<DensityBasedClusterer>`	`m_clustererTemplates` Clusterers to use
`protected java.util.List<java.awt.Color>`	`m_Colors` Holds colors to use
`protected java.util.Map<java.lang.String,java.awt.image.BufferedImage>`	`m_completedImages` Completed images
`protected java.lang.String`	`m_currentDescription` The spec of the scheme being used to render the current image
`protected KDDataGenerator`	`m_dataGenerator` The data generator to use
`protected int`	`m_imageHeight` Height of images to generate
`protected int`	`m_imageWidth` Width of images to generate
`protected boolean`	`m_isReset` True if we've been reset
`protected java.lang.String`	`m_kBand` User-specified bandwidth
`protected int`	`m_kernelBandwidth` Parsed bandwidth
`protected int`	`m_maxRowsInParallel` Number of rows of the visualization to compute in parallel.
`protected double`	`m_maxX`
`protected double`	`m_maxY`
`protected double`	`m_minX`
`protected double`	`m_minY`
`protected java.lang.String`	`m_nSamples` User-specified num samples
`protected int`	`m_numSamplesPerRegion` Parsed samples
`protected java.awt.image.BufferedImage`	`m_osi` The currently rendering image
`protected double`	`m_pixHeight`
`protected double`	`m_pixWidth`
`protected BoundaryPlotter.RenderingUpdateListener`	`m_plotListener` Open interactive view?
`protected boolean`	`m_plotTrainingData` Superimpose the training data on the plot?
`protected double`	`m_rangeX`
`protected double`	`m_rangeY`
`protected int`	`m_samplesBase` Parsed base
`protected java.lang.String`	`m_sBase` User-specified base for sampling
`protected Classifier[]`	`m_threadClassifiers` Copies of trained classifier to use in parallel for prediction
`protected Clusterer[]`	`m_threadClusterers` Copies of trained clusterer to use in parallel for prediction
`protected DataGenerator[]`	`m_threadGenerators` Data generator copies to use in parallel
`protected java.lang.String`	`m_xAttName` X axis attribute name/index
`protected int`	`m_xAttribute`
`protected java.lang.String`	`m_yAttName` Y axis attribute name/index
`protected int`	`m_yAttribute`

Fields inherited from class weka.knowledgeflow.steps.BaseStep
m_stepIsResourceIntensive, m_stepManager, m_stepName

Constructor Summary

Constructors
Constructor and Description

BoundaryPlotter()
Constructor

Constructors
Constructor and Description
`BoundaryPlotter()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`computeMinMaxAtts(Instances trainingData)`
`protected void`	`doScheme(Classifier classifier, DensityBasedClusterer clust, Instances trainingData, int setNum, int maxSetNum)`
`protected int`	`getAttIndex(java.lang.String attName, Instances data)`
`java.lang.String`	`getBaseForSampling()` Get the base for sampling
`int`	`getComputeMaxRowsInParallel()` Get the maximum number of threads to use when computing image rows
`java.awt.image.BufferedImage`	`getCurrentImage()` Get the currently rendering image
`java.lang.String`	`getCustomEditorForStep()` Return the fully qualified name of a custom editor component (JComponent) to use for editing the properties of the step.
`int`	`getImageHeight()` Get the image height (in pixels)
`java.util.Map<java.lang.String,java.awt.image.BufferedImage>`	`getImages()` Get the completed images
`int`	`getImageWidth()` Get the image width (in pixels)
`java.util.List<java.lang.String>`	`getIncomingConnectionTypes()` Get a list of incoming connection types that this step can accept.
`java.util.Map<java.lang.String,java.lang.String>`	`getInteractiveViewers()` When running in a graphical execution environment a step can make one or more popup Viewer components available.
`java.lang.String`	`getKernelBandwidth()` Get the kernel bandwidth
`java.lang.String`	`getNumLocationsPerPixel()` Get the number of locations/samples per pixel
`java.util.List<java.lang.String>`	`getOutgoingConnectionTypes()` Get a list of outgoing connection types that this step can produce.
`boolean`	`getPlotTrainingData()` Get whether to superimpose the training data points on the plot or not
`java.lang.String`	`getXAttName()` Get the name/index of the X axis attribute
`java.lang.String`	`getYAttName()` Get the name/index of the Y axis attribute
`protected void`	`initDataGenerator(Instances trainingData)`
`protected java.lang.String`	`makeSchemeSpec(java.lang.Object scheme, int setNum, int maxSetNum)`
`protected void`	`plotPoint(java.awt.image.BufferedImage osi, int x, int y, double[] probs, boolean update)`
`void`	`plotTrainingData(Instances trainingData)`
`void`	`processIncoming(Data data)` Process an incoming data payload (if the step accepts incoming connections)
`void`	`removeRenderingListener(BoundaryPlotter.RenderingUpdateListener l)` Remove the rendering update listener
`void`	`restoreData(java.lang.Object data)` Set a map of images.
`java.lang.Object`	`retrieveData()` Get the map of completed images
`void`	`setBaseForSampling(java.lang.String base)` Set the base for sampling
`void`	`setComputeMaxRowsInParallel(int max)` Set the maximum number of threads to use when computing image rows
`void`	`setImageHeight(int height)` Set the image height (in pixels)
`void`	`setImageWidth(int width)` Set the image width (in pixels)
`void`	`setKernelBandwidth(java.lang.String band)` Set the kernel bandwidth
`void`	`setNumLocationsPerPixel(java.lang.String num)` Set the number of locations/samples per pixel
`void`	`setPlotTrainingData(boolean plot)` Set whether to superimpose the training data points on the plot or not
`void`	`setRenderingListener(BoundaryPlotter.RenderingUpdateListener l)` Set a listener to receive rendering updates
`void`	`setXAttName(java.lang.String xAttName)` Set the name/index of the X axis attribute
`void`	`setYAttName(java.lang.String attName)` Set the name/index of the Y axis attribute
`void`	`stepInit()` Initialize the step.

Methods inherited from class weka.knowledgeflow.steps.BaseStep
environmentSubstitute, getDefaultSettings, getInteractiveViewersImpls, getName, getStepManager, globalInfo, isResourceIntensive, isStopRequested, outputStructureForConnectionType, setName, setStepIsResourceIntensive, setStepManager, setStepMustRunSingleThreaded, start, stepMustRunSingleThreaded, stop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_COLORS
```
public static final java.awt.Color[] DEFAULT_COLORS
```
    default colours for classes
  - m_Colors
```
protected java.util.List<java.awt.Color> m_Colors
```
    Holds colors to use
  - m_maxRowsInParallel
```
protected int m_maxRowsInParallel
```
    Number of rows of the visualization to compute in parallel. We don't want to dominate the thread pool that is used for executing all steps and step sub-tasks in the KF (this is currently fixed at 50 threads by FlowRunner).
  - m_imageWidth
```
protected int m_imageWidth
```
    Width of images to generate
  - m_imageHeight
```
protected int m_imageHeight
```
    Height of images to generate
  - m_xAttName
```
protected java.lang.String m_xAttName
```
    X axis attribute name/index
  - m_yAttName
```
protected java.lang.String m_yAttName
```
    Y axis attribute name/index
  - m_plotTrainingData
```
protected boolean m_plotTrainingData
```
    Superimpose the training data on the plot?
  - m_xAttribute
```
protected int m_xAttribute
```
  - m_yAttribute
```
protected int m_yAttribute
```
  - m_minX
```
protected double m_minX
```
  - m_minY
```
protected double m_minY
```
  - m_maxX
```
protected double m_maxX
```
  - m_maxY
```
protected double m_maxY
```
  - m_rangeX
```
protected double m_rangeX
```
  - m_rangeY
```
protected double m_rangeY
```
  - m_pixHeight
```
protected double m_pixHeight
```
  - m_pixWidth
```
protected double m_pixWidth
```
  - m_osi
```
protected transient java.awt.image.BufferedImage m_osi
```
    The currently rendering image
  - m_currentDescription
```
protected java.lang.String m_currentDescription
```
    The spec of the scheme being used to render the current image
  - m_completedImages
```
protected transient java.util.Map<java.lang.String,java.awt.image.BufferedImage> m_completedImages
```
    Completed images
  - m_classifierTemplates
```
protected java.util.List<Classifier> m_classifierTemplates
```
    Classifiers to use
  - m_clustererTemplates
```
protected java.util.List<DensityBasedClusterer> m_clustererTemplates
```
    Clusterers to use
  - m_threadClassifiers
```
protected Classifier[] m_threadClassifiers
```
    Copies of trained classifier to use in parallel for prediction
  - m_threadClusterers
```
protected Clusterer[] m_threadClusterers
```
    Copies of trained clusterer to use in parallel for prediction
  - m_threadGenerators
```
protected DataGenerator[] m_threadGenerators
```
    Data generator copies to use in parallel
  - m_dataGenerator
```
protected KDDataGenerator m_dataGenerator
```
    The data generator to use
  - m_kBand
```
protected java.lang.String m_kBand
```
    User-specified bandwidth
  - m_nSamples
```
protected java.lang.String m_nSamples
```
    User-specified num samples
  - m_sBase
```
protected java.lang.String m_sBase
```
    User-specified base for sampling
  - m_kernelBandwidth
```
protected int m_kernelBandwidth
```
    Parsed bandwidth
  - m_numSamplesPerRegion
```
protected int m_numSamplesPerRegion
```
    Parsed samples
  - m_samplesBase
```
protected int m_samplesBase
```
    Parsed base
  - m_plotListener
```
protected transient BoundaryPlotter.RenderingUpdateListener m_plotListener
```
    Open interactive view?
  - m_isReset
```
protected boolean m_isReset
```
    True if we've been reset
- Constructor Detail
  - BoundaryPlotter
```
public BoundaryPlotter()
```
    Constructor
- Method Detail
  - setXAttName
```
@ProgrammaticProperty
 @OptionMetadata(displayName="X attribute",
                description="Attribute to visualize on the x-axis",
                displayOrder=1)
public void setXAttName(java.lang.String xAttName)
```
    Set the name/index of the X axis attribute
    
    Parameters:
    
    xAttName - name/index of the X axis attribute
  - getXAttName
```
public java.lang.String getXAttName()
```
    Get the name/index of the X axis attribute
    
    Returns:
    
    the name/index of the X axis attribute
  - setYAttName
```
@ProgrammaticProperty
 @OptionMetadata(displayName="Y attribute",
                description="Attribute to visualize on the y-axis",
                displayOrder=2)
public void setYAttName(java.lang.String attName)
```
    Set the name/index of the Y axis attribute
    
    Parameters:
    
    attName - name/index of the Y axis attribute
  - getYAttName
```
public java.lang.String getYAttName()
```
    Get the name/index of the Y axis attribute
    
    Returns:
    
    the name/index of the Y axis attribute
  - setBaseForSampling
```
@OptionMetadata(displayName="Base for sampling (r)",
                description="The base for sampling",
                displayOrder=3)
public void setBaseForSampling(java.lang.String base)
```
    Set the base for sampling
    
    Parameters:
    
    base - the base to use
  - getBaseForSampling
```
public java.lang.String getBaseForSampling()
```
    Get the base for sampling
    
    Returns:
    
    the base to use
  - setNumLocationsPerPixel
```
@OptionMetadata(displayName="Num. locations per pixel",
                description="Number of locations per pixel",
                displayOrder=4)
public void setNumLocationsPerPixel(java.lang.String num)
```
    Set the number of locations/samples per pixel
    
    Parameters:
    
    num - the number of samples to use
  - getNumLocationsPerPixel
```
public java.lang.String getNumLocationsPerPixel()
```
    Get the number of locations/samples per pixel
    
    Returns:
    
    the number of samples to use
  - setKernelBandwidth
```
@OptionMetadata(displayName="Kernel bandwidth (k)",
                description="Kernel bandwidth",
                displayOrder=4)
public void setKernelBandwidth(java.lang.String band)
```
    Set the kernel bandwidth
    
    Parameters:
    
    band - the bandwidth
  - getKernelBandwidth
```
public java.lang.String getKernelBandwidth()
```
    Get the kernel bandwidth
    
    Returns:
    
    the bandwidth
  - setImageWidth
```
@OptionMetadata(displayName="Image width (pixels)",
                description="Image width in pixels",
                displayOrder=5)
public void setImageWidth(int width)
```
    Set the image width (in pixels)
    
    Parameters:
    
    width - the width to use
  - getImageWidth
```
public int getImageWidth()
```
    Get the image width (in pixels)
    
    Returns:
    
    the width to use
  - setImageHeight
```
@OptionMetadata(displayName="Image height (pixels)",
                description="Image height in pixels",
                displayOrder=6)
public void setImageHeight(int height)
```
    Set the image height (in pixels)
    
    Parameters:
    
    height - the height to use
  - getImageHeight
```
public int getImageHeight()
```
    Get the image height (in pixels)
    
    Returns:
    
    the height to use
  - setComputeMaxRowsInParallel
```
@OptionMetadata(displayName="Max image rows to compute in parallel",
                description="Use this many tasks for computing rows of the image",
                displayOrder=7)
public void setComputeMaxRowsInParallel(int max)
```
    Set the maximum number of threads to use when computing image rows
    
    Parameters:
    
    max - maximum number of rows to compute in parallel
  - getComputeMaxRowsInParallel
```
public int getComputeMaxRowsInParallel()
```
    Get the maximum number of threads to use when computing image rows
    
    Returns:
    
    the maximum number of rows to compute in parallel
  - setPlotTrainingData
```
@OptionMetadata(displayName="Plot training points",
                description="Superimpose the training data over the top of the plot",
                displayOrder=8)
public void setPlotTrainingData(boolean plot)
```
    Set whether to superimpose the training data points on the plot or not
    
    Parameters:
    
    plot - true to plot the training data
  - getPlotTrainingData
```
public boolean getPlotTrainingData()
```
    Get whether to superimpose the training data points on the plot or not
    
    Returns:
    
    true if plotting the training data
  - stepInit
```
public void stepInit()
              throws WekaException
```
    Initialize the step.
    
    Specified by:
    
    stepInit in interface BaseStepExtender
    
    Specified by:
    
    stepInit in interface Step
    
    Throws:
    
    WekaException - if a problem occurs during initialization
  - computeMinMaxAtts
```
protected void computeMinMaxAtts(Instances trainingData)
```
  - getAttIndex
```
protected int getAttIndex(java.lang.String attName,
                          Instances data)
                   throws WekaException
```
    Throws:
    
    WekaException
  - initDataGenerator
```
protected void initDataGenerator(Instances trainingData)
                          throws WekaException
```
    Throws:
    
    WekaException
  - processIncoming
```
public void processIncoming(Data data)
                     throws WekaException
```
    Description copied from class: BaseStep
    
    Process an incoming data payload (if the step accepts incoming connections)
    
    Specified by:
    
    processIncoming in interface BaseStepExtender
    
    Specified by:
    
    processIncoming in interface Step
    
    Overrides:
    
    processIncoming in class BaseStep
    
    Parameters:
    
    data - the payload to process
    
    Throws:
    
    WekaException - if a problem occurs
  - doScheme
```
protected void doScheme(Classifier classifier,
                        DensityBasedClusterer clust,
                        Instances trainingData,
                        int setNum,
                        int maxSetNum)
                 throws WekaException
```
    Throws:
    
    WekaException
  - makeSchemeSpec
```
protected java.lang.String makeSchemeSpec(java.lang.Object scheme,
                                          int setNum,
                                          int maxSetNum)
```
  - plotPoint
```
protected void plotPoint(java.awt.image.BufferedImage osi,
                         int x,
                         int y,
                         double[] probs,
                         boolean update)
```
  - plotTrainingData
```
public void plotTrainingData(Instances trainingData)
```
  - getIncomingConnectionTypes
```
public java.util.List<java.lang.String> getIncomingConnectionTypes()
```
    Get a list of incoming connection types that this step can accept. Ideally (and if appropriate), this should take into account the state of the step and any existing incoming connections. E.g. a step might be able to accept one (and only one) incoming batch data connection.
    
    Specified by:
    
    getIncomingConnectionTypes in interface BaseStepExtender
    
    Specified by:
    
    getIncomingConnectionTypes in interface Step
    
    Returns:
    
    a list of incoming connections that this step can accept given its current state
  - getOutgoingConnectionTypes
```
public java.util.List<java.lang.String> getOutgoingConnectionTypes()
```
    Get a list of outgoing connection types that this step can produce. Ideally (and if appropriate), this should take into account the state of the step and the incoming connections. E.g. depending on what incoming connection is present, a step might be able to produce a trainingSet output, a testSet output or neither, but not both.
    
    Specified by:
    
    getOutgoingConnectionTypes in interface BaseStepExtender
    
    Specified by:
    
    getOutgoingConnectionTypes in interface Step
    
    Returns:
    
    a list of outgoing connections that this step can produce
  - getImages
```
public java.util.Map<java.lang.String,java.awt.image.BufferedImage> getImages()
```
    Get the completed images
    
    Returns:
    
    a map of completed images
  - getCurrentImage
```
public java.awt.image.BufferedImage getCurrentImage()
```
    Get the currently rendering image
    
    Returns:
    
    the current image
  - setRenderingListener
```
public void setRenderingListener(BoundaryPlotter.RenderingUpdateListener l)
```
    Set a listener to receive rendering updates
    
    Parameters:
    
    l - the RenderingUpdateListener to add
  - removeRenderingListener
```
public void removeRenderingListener(BoundaryPlotter.RenderingUpdateListener l)
```
    Remove the rendering update listener
    
    Parameters:
    
    l - the RenderingUpdateListener to remove
  - getInteractiveViewers
```
public java.util.Map<java.lang.String,java.lang.String> getInteractiveViewers()
```
    When running in a graphical execution environment a step can make one or more popup Viewer components available. These might be used to display results, graphics etc. Returning null indicates that the step has no such additional graphical views. The map returned by this method should be keyed by action name (e.g. "View results"), and values should be fully qualified names of the corresponding StepInteractiveView implementation. Furthermore, the contents of this map can (and should) be dependent on whether a particular viewer should be made available - i.e. if execution hasn't occurred yet, or if a particular incoming connection type is not present, then it might not be possible to view certain results. Viewers can implement StepInteractiveView directly (in which case they need to extends JPanel), or extends the AbstractInteractiveViewer class. The later extends JPanel, uses a BorderLayout, provides a "Close" button and a method to add additional buttons.
    
    Specified by:
    
    getInteractiveViewers in interface Step
    
    Overrides:
    
    getInteractiveViewers in class BaseStep
    
    Returns:
    
    a map of viewer component names, or null if this step has no graphical views
  - getCustomEditorForStep
```
public java.lang.String getCustomEditorForStep()
```
    Return the fully qualified name of a custom editor component (JComponent) to use for editing the properties of the step. This method can return null, in which case the system will dynamically generate an editor using the GenericObjectEditor
    
    Specified by:
    
    getCustomEditorForStep in interface Step
    
    Overrides:
    
    getCustomEditorForStep in class BaseStep
    
    Returns:
    
    the fully qualified name of a step editor component
  - retrieveData
```
public java.lang.Object retrieveData()
```
    Get the map of completed images
    
    Specified by:
    
    retrieveData in interface DataCollector
    
    Returns:
    
    the map of completed images
  - restoreData
```
public void restoreData(java.lang.Object data)
                 throws WekaException
```
    Set a map of images.
    
    Specified by:
    
    restoreData in interface DataCollector
    
    Parameters:
    
    data - the images to set
    
    Throws:
    
    WekaException - if a problem occurs

Class BoundaryPlotter

Nested Class Summary

Field Summary

Fields inherited from class weka.knowledgeflow.steps.BaseStep

Constructor Summary

Method Summary

Methods inherited from class weka.knowledgeflow.steps.BaseStep

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_COLORS

m_Colors

m_maxRowsInParallel

m_imageWidth

m_imageHeight

m_xAttName

m_yAttName

m_plotTrainingData

m_xAttribute

m_yAttribute

m_minX

m_minY

m_maxX

m_maxY

m_rangeX

m_rangeY

m_pixHeight

m_pixWidth

m_osi

m_currentDescription

m_completedImages

m_classifierTemplates

m_clustererTemplates

m_threadClassifiers

m_threadClusterers

m_threadGenerators

m_dataGenerator

m_kBand

m_nSamples

m_sBase

m_kernelBandwidth

m_numSamplesPerRegion

m_samplesBase

m_plotListener

m_isReset

Constructor Detail

BoundaryPlotter

Method Detail

setXAttName

getXAttName

setYAttName

getYAttName

setBaseForSampling

getBaseForSampling

setNumLocationsPerPixel

getNumLocationsPerPixel

setKernelBandwidth

getKernelBandwidth

setImageWidth

getImageWidth

setImageHeight

getImageHeight

setComputeMaxRowsInParallel

getComputeMaxRowsInParallel

setPlotTrainingData

getPlotTrainingData

stepInit

computeMinMaxAtts

getAttIndex

initDataGenerator

processIncoming

doScheme

makeSchemeSpec

plotPoint

plotTrainingData

getIncomingConnectionTypes

getOutgoingConnectionTypes

getImages

getCurrentImage

setRenderingListener

removeRenderingListener