java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.transformer.actualvspredictedprocessor.AbstractActualVsPredictedProcessor<String>
      - adams.flow.transformer.actualvspredictedprocessor.AbstractActualVsPredictedHtmlProcessor
        
        adams.flow.transformer.actualvspredictedprocessor.ClassifierErrorsKernelDensityEstimate

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ActualVsPredictedHtmlProcessor, ActualVsPredictedProcessor<String>, Serializable
```
public class ClassifierErrorsKernelDensityEstimate
extends AbstractActualVsPredictedHtmlProcessor
```
Generates a self-contained HTML file displaying a kernel density based scatter plot of actual vs predicted.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ClassifierErrorsKernelDensityEstimate.ColorPaletteType
The type of color palette to use.

Field Summary

Fields
Modifier and Type	Field	Description
`protected double`	`m_Bandwidth`	the bandwidth.
`protected int`	`m_CircleSize`	the circle size.
`protected Color`	`m_ColorEnd`	the end color.
`protected String`	`m_ColorPalettePredefined`	the color palette.
`protected ClassifierErrorsKernelDensityEstimate.ColorPaletteType`	`m_ColorPaletteType`	the type of color palette to use.
`protected Color`	`m_ColorStart`	the start color.
`protected int`	`m_NumBins`	the number of bins to generate on X and Y.
`protected double`	`m_Opacity`	the opacity to use.
`protected boolean`	`m_ShowColorBar`	whether to show the colorbar.
`protected boolean`	`m_ShowLegend`	whether to show the legend.

Fields inherited from class adams.flow.transformer.actualvspredictedprocessor.AbstractActualVsPredictedHtmlProcessor
m_Title

Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

ClassifierErrorsKernelDensityEstimate()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`bandwidthTipText()`	Returns the tip text for this property.
`String`	`circleSizeTipText()`	Returns the tip text for this property.
`String`	`colorEndTipText()`	Returns the tip text for this property.
`String`	`colorPalettePredefinedTipText()`	Returns the tip text for this property.
`String`	`colorPaletteTypeTipText()`	Returns the tip text for this property.
`String`	`colorStartTipText()`	Returns the tip text for this property.
`void`	`defineOptions()`	Adds options to the internal list of options.
`protected String`	`doProcess(SpreadSheet sheet)`	Processes the actual vs predicted data and returns the output generated.
`double`	`getBandwidth()`	Returns the bandwidth for kernel density estimates.
`int`	`getCircleSize()`	Returns the size of the circles.
`Color`	`getColorEnd()`	Returns the end color for the color palette (`ClassifierErrorsKernelDensityEstimate.ColorPaletteType.BICOLOR`).
`String`	`getColorPalettePredefined()`	Returns the color palette to use.
`ClassifierErrorsKernelDensityEstimate.ColorPaletteType`	`getColorPaletteType()`	Returns what color palette type to use.
`Color`	`getColorStart()`	Returns the starting color for the color palette (`ClassifierErrorsKernelDensityEstimate.ColorPaletteType.BICOLOR`).
`int`	`getNumBins()`	Returns the number of bins to generate on X and Y axis.
`double`	`getOpacity()`	Returns the opacity to use.
`boolean`	`getShowColorBar()`	Returns whether to show the colorbar.
`boolean`	`getShowLegend()`	Returns whether to show the legend.
`String`	`globalInfo()`	Returns a string describing the object.
`String`	`numBinsTipText()`	Returns the tip text for this property.
`String`	`opacityTipText()`	Returns the tip text for this property.
`void`	`setBandwidth(double value)`	Sets the bandwidth for kernel density estimates.
`void`	`setCircleSize(int value)`	Sets the size of the circles.
`void`	`setColorEnd(Color value)`	Sets the end color for the color palette (`ClassifierErrorsKernelDensityEstimate.ColorPaletteType.BICOLOR`).
`void`	`setColorPalettePredefined(String value)`	Sets the color palette to use.
`void`	`setColorPaletteType(ClassifierErrorsKernelDensityEstimate.ColorPaletteType value)`	Sets what color palette type to use.
`void`	`setColorStart(Color value)`	Sets the starting color for the color palette (`ClassifierErrorsKernelDensityEstimate.ColorPaletteType.BICOLOR`).
`void`	`setNumBins(int value)`	Sets the number of bins to generate on X and Y axis.
`void`	`setOpacity(double value)`	Sets the opacity to use.
`void`	`setShowColorBar(boolean value)`	Sets whether to show the colorbar.
`void`	`setShowLegend(boolean value)`	Sets whether to show the legend.
`String`	`showColorBarTipText()`	Returns the tip text for this property.
`String`	`showLegendTipText()`	Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.actualvspredictedprocessor.AbstractActualVsPredictedHtmlProcessor
generatedByAdams, generates, getTitle, setTitle, titleTipText

Methods inherited from class adams.flow.transformer.actualvspredictedprocessor.AbstractActualVsPredictedProcessor
check, getActualNumeric, getAdditional, getPredictedNumeric, process

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, toCommandLine, toString

Methods inherited from class adams.core.logging.CustomLoggingLevelObject
setLoggingLevel

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

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

Methods inherited from interface adams.flow.transformer.actualvspredictedprocessor.ActualVsPredictedProcessor
process

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager, toCommandLine

- Field Detail
  - m_NumBins
```
protected int m_NumBins
```
    the number of bins to generate on X and Y.
  - m_Bandwidth
```
protected double m_Bandwidth
```
    the bandwidth.
  - m_ColorPaletteType
```
protected ClassifierErrorsKernelDensityEstimate.ColorPaletteType m_ColorPaletteType
```
    the type of color palette to use.
  - m_ColorPalettePredefined
```
protected String m_ColorPalettePredefined
```
    the color palette.
  - m_ColorStart
```
protected Color m_ColorStart
```
    the start color.
  - m_ColorEnd
```
protected Color m_ColorEnd
```
    the end color.
  - m_ShowColorBar
```
protected boolean m_ShowColorBar
```
    whether to show the colorbar.
  - m_Opacity
```
protected double m_Opacity
```
    the opacity to use.
  - m_CircleSize
```
protected int m_CircleSize
```
    the circle size.
  - m_ShowLegend
```
protected boolean m_ShowLegend
```
    whether to show the legend.
- Constructor Detail
  - ClassifierErrorsKernelDensityEstimate
```
public ClassifierErrorsKernelDensityEstimate()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Returns a string describing the object.
    
    Specified by:
    
    globalInfo in interface GlobalInfoSupporter
    
    Specified by:
    
    globalInfo in class AbstractOptionHandler
    
    Returns:
    
    a description suitable for displaying in the gui
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractActualVsPredictedHtmlProcessor
  - setNumBins
```
public void setNumBins(int value)
```
    Sets the number of bins to generate on X and Y axis.
    
    Parameters:
    
    value - the number of bins
  - getNumBins
```
public int getNumBins()
```
    Returns the number of bins to generate on X and Y axis.
    
    Returns:
    
    the number of bins
  - numBinsTipText
```
public String numBinsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setBandwidth
```
public void setBandwidth(double value)
```
    Sets the bandwidth for kernel density estimates.
    
    Parameters:
    
    value - the bandwidth
  - getBandwidth
```
public double getBandwidth()
```
    Returns the bandwidth for kernel density estimates.
    
    Returns:
    
    the bandwidth
  - bandwidthTipText
```
public String bandwidthTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setColorPaletteType
```
public void setColorPaletteType(ClassifierErrorsKernelDensityEstimate.ColorPaletteType value)
```
    Sets what color palette type to use.
    
    Parameters:
    
    value - the type
  - getColorPaletteType
```
public ClassifierErrorsKernelDensityEstimate.ColorPaletteType getColorPaletteType()
```
    Returns what color palette type to use.
    
    Returns:
    
    the type
  - colorPaletteTypeTipText
```
public String colorPaletteTypeTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setColorPalettePredefined
```
public void setColorPalettePredefined(String value)
```
    Sets the color palette to use.
    
    Parameters:
    
    value - the palette
  - getColorPalettePredefined
```
public String getColorPalettePredefined()
```
    Returns the color palette to use.
    
    Returns:
    
    the palette
  - colorPalettePredefinedTipText
```
public String colorPalettePredefinedTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setColorStart
```
public void setColorStart(Color value)
```
    Sets the starting color for the color palette (ClassifierErrorsKernelDensityEstimate.ColorPaletteType.BICOLOR).
    
    Parameters:
    
    value - the color
  - getColorStart
```
public Color getColorStart()
```
    Returns the starting color for the color palette (ClassifierErrorsKernelDensityEstimate.ColorPaletteType.BICOLOR).
    
    Returns:
    
    the color
  - colorStartTipText
```
public String colorStartTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setColorEnd
```
public void setColorEnd(Color value)
```
    Sets the end color for the color palette (ClassifierErrorsKernelDensityEstimate.ColorPaletteType.BICOLOR).
    
    Parameters:
    
    value - the color
  - getColorEnd
```
public Color getColorEnd()
```
    Returns the end color for the color palette (ClassifierErrorsKernelDensityEstimate.ColorPaletteType.BICOLOR).
    
    Returns:
    
    the color
  - colorEndTipText
```
public String colorEndTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setShowColorBar
```
public void setShowColorBar(boolean value)
```
    Sets whether to show the colorbar.
    
    Parameters:
    
    value - true if to show
  - getShowColorBar
```
public boolean getShowColorBar()
```
    Returns whether to show the colorbar.
    
    Returns:
    
    true if to show
  - showColorBarTipText
```
public String showColorBarTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setOpacity
```
public void setOpacity(double value)
```
    Sets the opacity to use.
    
    Parameters:
    
    value - the opacity
  - getOpacity
```
public double getOpacity()
```
    Returns the opacity to use.
    
    Returns:
    
    the opacity
  - opacityTipText
```
public String opacityTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setCircleSize
```
public void setCircleSize(int value)
```
    Sets the size of the circles.
    
    Parameters:
    
    value - the size
  - getCircleSize
```
public int getCircleSize()
```
    Returns the size of the circles.
    
    Returns:
    
    the size
  - circleSizeTipText
```
public String circleSizeTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setShowLegend
```
public void setShowLegend(boolean value)
```
    Sets whether to show the legend.
    
    Parameters:
    
    value - true if to show
  - getShowLegend
```
public boolean getShowLegend()
```
    Returns whether to show the legend.
    
    Returns:
    
    true if to show
  - showLegendTipText
```
public String showLegendTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - doProcess
```
protected String doProcess(SpreadSheet sheet)
```
    Processes the actual vs predicted data and returns the output generated.
    
    Specified by:
    
    doProcess in class AbstractActualVsPredictedProcessor<String>
    
    Parameters:
    
    sheet - the data to process
    
    Returns:
    
    the output

Class ClassifierErrorsKernelDensityEstimate

Nested Class Summary

Field Summary

Fields inherited from class adams.flow.transformer.actualvspredictedprocessor.AbstractActualVsPredictedHtmlProcessor

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Constructor Summary

Method Summary

Methods inherited from class adams.flow.transformer.actualvspredictedprocessor.AbstractActualVsPredictedHtmlProcessor

Methods inherited from class adams.flow.transformer.actualvspredictedprocessor.AbstractActualVsPredictedProcessor

Methods inherited from class adams.core.option.AbstractOptionHandler

Methods inherited from class adams.core.logging.CustomLoggingLevelObject

Methods inherited from class adams.core.logging.LoggingObject

Methods inherited from class java.lang.Object

Methods inherited from interface adams.flow.transformer.actualvspredictedprocessor.ActualVsPredictedProcessor

Methods inherited from interface adams.core.Destroyable

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Methods inherited from interface adams.core.option.OptionHandler

Field Detail

m_NumBins

m_Bandwidth

m_ColorPaletteType

m_ColorPalettePredefined

m_ColorStart

m_ColorEnd

m_ShowColorBar

m_Opacity

m_CircleSize

m_ShowLegend

Constructor Detail

ClassifierErrorsKernelDensityEstimate

Method Detail

globalInfo

defineOptions

setNumBins

getNumBins

numBinsTipText

setBandwidth

getBandwidth

bandwidthTipText

setColorPaletteType

getColorPaletteType

colorPaletteTypeTipText

setColorPalettePredefined

getColorPalettePredefined

colorPalettePredefinedTipText

setColorStart

getColorStart

colorStartTipText

setColorEnd

getColorEnd

colorEndTipText

setShowColorBar

getShowColorBar

showColorBarTipText

setOpacity

getOpacity

opacityTipText

setCircleSize

getCircleSize

circleSizeTipText

setShowLegend

getShowLegend

showLegendTipText

doProcess