Class KnnKernelDensityPlotter
java.lang.Object
uk.ac.starlink.ttools.plot2.layer.Pixel1dPlotter<AbstractKernelDensityPlotter.KDenseStyle>
uk.ac.starlink.ttools.plot2.layer.AbstractKernelDensityPlotter
uk.ac.starlink.ttools.plot2.layer.KnnKernelDensityPlotter
- All Implemented Interfaces:
Plotter<AbstractKernelDensityPlotter.KDenseStyle>
Kernel Density Plotter that uses a variable-width kernel whose width
is assigned using K-Nearest-Neighbours counting.
- Since:
- 30 Mar 2015
- Author:
- Mark Taylor
-
Nested Class Summary
Nested classes/interfaces inherited from class AbstractKernelDensityPlotter
AbstractKernelDensityPlotter.KDenseStyle, AbstractKernelDensityPlotter.KernelFigureNested classes/interfaces inherited from class Pixel1dPlotter
Pixel1dPlotter.BinArray, Pixel1dPlotter.Pixel1dPlan -
Field Summary
FieldsModifier and TypeFieldDescriptionConfig key for number of nearest neighbours.Config key for maximum smoothing width configuration.Report key for actual maximum smoothing width.Config key for minimum smoothing width.Report key for actual minimum smoothing width.Config key for determining symmetry of KNN search.Fields inherited from class AbstractKernelDensityPlotter
BINS_KEY, NORMALISE_KEY, THICK_KEYFields inherited from class Pixel1dPlotter
KERNEL_KEY, SMOOTHSIZER_KEY, SMOOTHWIDTH_KEY -
Constructor Summary
ConstructorsConstructorDescriptionKnnKernelDensityPlotter(FloatingCoord xCoord, boolean hasWeight, PerUnitConfigKey<Unit> unitKey) Constructor. -
Method Summary
Modifier and TypeMethodDescriptioncreateKernelFigure(ConfigMap config) Constructs an object for plot-time kernel construction based on a particular config map.protected ConfigKey<?>[]Returns a list of keys that specify how the smoothing kernel will be configured.Returns an XML description of this plotter.Methods inherited from class AbstractKernelDensityPlotter
createStyle, extendPixel1dCoordinateRanges, getCombiner, getLayerOpt, getPixel1dReport, getPixelPadding, getRangeStyleKey, getStyleKeys, isY, paintBinsMethods inherited from class Pixel1dPlotter
createKernel, createLayer, getCombinerKey, getCoordGroup, getDataBins, getEffectiveExtent, getPixelWidth, getPlotterIcon, getPlotterName, getWeightCoordIndex, getWeightingDescription, hasReports, readBins
-
Field Details
-
MINWIDTH_RKEY
-
MAXWIDTH_RKEY
-
KNN_CKEY
-
SYMMETRIC_CKEY
-
MINSIZER_CKEY
-
MAXSIZER_CKEY
-
-
Constructor Details
-
KnnKernelDensityPlotter
public KnnKernelDensityPlotter(FloatingCoord xCoord, boolean hasWeight, PerUnitConfigKey<Unit> unitKey) Constructor.- Parameters:
xCoord- X axis coordinatehasWeight- true to permit histogram weightingunitKey- config key to select X axis physical units, or null if no unit selection required
-
-
Method Details
-
getPlotterDescription
-
getKernelConfigKeys
Description copied from class:AbstractKernelDensityPlotterReturns a list of keys that specify how the smoothing kernel will be configured.- Specified by:
getKernelConfigKeysin classAbstractKernelDensityPlotter- Returns:
- list of implementation-specific kernel config keys
-
createKernelFigure
protected AbstractKernelDensityPlotter.KernelFigure createKernelFigure(ConfigMap config) throws ConfigException Description copied from class:AbstractKernelDensityPlotterConstructs an object for plot-time kernel construction based on a particular config map.- Specified by:
createKernelFigurein classAbstractKernelDensityPlotter- Parameters:
config- config map with kernel config keys in it- Throws:
ConfigException- See Also:
-