uk.ac.starlink.ttools.plot2.layer

Class FixedKernelDensityPlotter

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.FixedKernelDensityPlotter

All Implemented Interfaces:

Plotter<AbstractKernelDensityPlotter.KDenseStyle>

public class FixedKernelDensityPlotter
extends AbstractKernelDensityPlotter

Kernel density plotter that uses fixed-width kernels.

Since:

30 Mar 2015

Author:

Mark Taylor

Nested Class Summary

Nested classes/interfaces inherited from class uk.ac.starlink.ttools.plot2.layer.AbstractKernelDensityPlotter

AbstractKernelDensityPlotter.KDenseStyle, AbstractKernelDensityPlotter.KernelFigure

Nested classes/interfaces inherited from class uk.ac.starlink.ttools.plot2.layer.Pixel1dPlotter

Pixel1dPlotter.BinArray, Pixel1dPlotter.Pixel1dPlan

Field Summary

Fields inherited from class uk.ac.starlink.ttools.plot2.layer.AbstractKernelDensityPlotter

BINS_KEY, NORMALISE_KEY, THICK_KEY

Fields inherited from class uk.ac.starlink.ttools.plot2.layer.Pixel1dPlotter

KERNEL_KEY, SMOOTHSIZER_KEY, SMOOTHWIDTH_KEY

Constructor Summary

Constructors

Constructor and Description
FixedKernelDensityPlotter(FloatingCoord xCoord, boolean hasWeight, PerUnitConfigKey<Unit> unitKey) Constructor.

Method Summary

Modifier and Type	Method and Description
protected AbstractKernelDensityPlotter.KernelFigure	createKernelFigure(ConfigMap config) Constructs an object for plot-time kernel construction based on a particular config map.
protected ConfigKey<?>[]	getKernelConfigKeys() Returns a list of keys that specify how the smoothing kernel will be configured.
String	getPlotterDescription() Returns an XML description of this plotter.

Methods inherited from class uk.ac.starlink.ttools.plot2.layer.AbstractKernelDensityPlotter

createStyle, extendPixel1dCoordinateRanges, getCombiner, getLayerOpt, getPixel1dReport, getPixelPadding, getRangeStyleKey, getStyleKeys, isY, paintBins

Methods inherited from class uk.ac.starlink.ttools.plot2.layer.Pixel1dPlotter

createKernel, createLayer, getCombinerKey, getCoordGroup, getDataBins, getEffectiveExtent, getPixelWidth, getPlotterIcon, getPlotterName, getWeightCoordIndex, getWeightingDescription, hasReports, readBins

Methods inherited from class java.lang.Object

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

Constructor Detail

FixedKernelDensityPlotter

public FixedKernelDensityPlotter(FloatingCoord xCoord,
                                 boolean hasWeight,
                                 PerUnitConfigKey<Unit> unitKey)

Constructor.

Parameters:

xCoord - X axis coordinate

hasWeight - true to permit histogram weighting

unitKey - config key to select X axis physical units, or null if no unit selection required

Method Detail

getKernelConfigKeys

protected ConfigKey<?>[] getKernelConfigKeys()

Description copied from class: AbstractKernelDensityPlotter

Returns a list of keys that specify how the smoothing kernel will be configured.

Specified by:

getKernelConfigKeys in class AbstractKernelDensityPlotter

Returns:

list of implementation-specific kernel config keys

createKernelFigure

protected AbstractKernelDensityPlotter.KernelFigure createKernelFigure(ConfigMap config)

Description copied from class: AbstractKernelDensityPlotter

Constructs an object for plot-time kernel construction based on a particular config map.

Specified by:

createKernelFigure in class AbstractKernelDensityPlotter

Parameters:

config - config map with kernel config keys in it

See Also:

AbstractKernelDensityPlotter.getKernelConfigKeys()

getPlotterDescription

public String getPlotterDescription()

Description copied from interface: Plotter

Returns an XML description of this plotter.

Note: really this should appear at the LayerType level.

Returns:

one or more <p> elements