TracePlotter (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.ttools.plot2.layer.AbstractPlotter<TracePlotter.TraceStyle>
- - uk.ac.starlink.ttools.plot2.layer.TracePlotter

All Implemented Interfaces:

Plotter<TracePlotter.TraceStyle>
```
public class TracePlotter
extends AbstractPlotter<TracePlotter.TraceStyle>
```
Plots a line through a cloud of points in 2d, tracing a given quantile or pair of quantiles at each column (or row) of pixels.

Since:

9 Dec 2016

Author:

Mark Taylor

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class TracePlotter.TraceStyle
Style for trace plot.

Nested Classes
Modifier and Type	Class	Description
`static class`	`TracePlotter.TraceStyle`	Style for trace plot.

Field Summary

Fields
Modifier and Type	Field	Description
`static ConfigKey<java.lang.Boolean>`	`HORIZONTAL_KEY`	Key to configure whether trace is vertical or horizontal.
`static ConfigKey<Kernel1dShape>`	`KERNEL_KEY`	Config key for smoothing kernel shape.
`static ConfigKey<Subrange>`	`QUANTILES_KEY`	Key to configure target quantile range.
`static ConfigKey<BinSizer>`	`SMOOTHSIZER_KEY`	Config key for smoothing width configuration.
`static ReportKey<java.lang.Double>`	`SMOOTHWIDTH_KEY`	Report key for smoothing width.
`static ConfigKey<java.lang.Integer>`	`THICK_KEY`	Key to configure line thickness.

Constructor Summary

Constructors
Constructor Description

TracePlotter(boolean hasVertical)
Constructor.

Constructors
Constructor	Description
`TracePlotter(boolean hasVertical)`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PlotLayer`	`createLayer(DataGeom geom, DataSpec dataSpec, TracePlotter.TraceStyle style)`	Creates a PlotLayer based on the given geometry, data and style.
`TracePlotter.TraceStyle`	`createStyle(ConfigMap config)`	Creates a style that can be used when creating a plot layer.
`java.lang.String`	`getPlotterDescription()`	Returns an XML description of this plotter.
`ConfigKey[]`	`getStyleKeys()`	Returns the configuration keys used to configure style for this plotter.

Methods inherited from class uk.ac.starlink.ttools.plot2.layer.AbstractPlotter
getCoordGroup, getPlotterIcon, getPlotterName, hasReports

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

- Field Detail
  - HORIZONTAL_KEY
```
public static final ConfigKey<java.lang.Boolean> HORIZONTAL_KEY
```
    Key to configure whether trace is vertical or horizontal.
  - THICK_KEY
```
public static final ConfigKey<java.lang.Integer> THICK_KEY
```
    Key to configure line thickness.
  - QUANTILES_KEY
```
public static final ConfigKey<Subrange> QUANTILES_KEY
```
    Key to configure target quantile range.
  - SMOOTHWIDTH_KEY
```
public static final ReportKey<java.lang.Double> SMOOTHWIDTH_KEY
```
    Report key for smoothing width.
  - SMOOTHSIZER_KEY
```
public static final ConfigKey<BinSizer> SMOOTHSIZER_KEY
```
    Config key for smoothing width configuration.
  - KERNEL_KEY
```
public static final ConfigKey<Kernel1dShape> KERNEL_KEY
```
    Config key for smoothing kernel shape.
- Constructor Detail
  - TracePlotter
```
public TracePlotter(boolean hasVertical)
```
    Constructor.
    
    Parameters:
    
    hasVertical - true iff vertical fill is offered (otherwise only horizontal)
- Method Detail
  - getPlotterDescription
```
public java.lang.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
  - getStyleKeys
```
public ConfigKey[] getStyleKeys()
```
    Description copied from interface: Plotter
    
    Returns the configuration keys used to configure style for this plotter. The keys in the return value are used in the map supplied to the Plotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap) method.
    
    Returns:
    
    keys used when creating a style for this plotter.
  - createStyle
```
public TracePlotter.TraceStyle createStyle(ConfigMap config)
```
    Description copied from interface: Plotter
    
    Creates a style that can be used when creating a plot layer. The keys that are significant in the supplied config map are those returned by Plotter.getStyleKeys(). The return value can be used as input to Plotter.createLayer(uk.ac.starlink.ttools.plot2.DataGeom, uk.ac.starlink.ttools.plot2.data.DataSpec, S).
    
    Parameters:
    
    config - map of style configuration items
    
    Returns:
    
    plotter-specific plot style
  - createLayer
```
public PlotLayer createLayer(DataGeom geom,
                             DataSpec dataSpec,
                             TracePlotter.TraceStyle style)
```
    Description copied from interface: Plotter
    
    Creates a PlotLayer based on the given geometry, data and style.
    The style parameter is the result of a call to Plotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap).
    The dataSpec parameter must contain the coordinates defined by this plotter's CoordGroup.
    The pointDataGeom parameter is only used if getCoordGroup(). getPositionCount returns a non-zero value, otherwise the plot does not have point positions.
    It is legal to supply null for any of the parameters; if insufficient data is supplied to generate a plot, then the method should return null.
    Creating a layer should be cheap; layers may be created and not used.
    
    Parameters:
    
    geom - indicates base position coordinates and their mapping to points in the data space; if non-null, the data geom's DataGeom.hasPosition() method will return true
    
    dataSpec - specifies the data required for the plot
    
    style - data style as obtained from createStyle
    
    Returns:
    
    new plot layer, or null if no drawing will take place

Class TracePlotter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

HORIZONTAL_KEY

THICK_KEY

QUANTILES_KEY

SMOOTHWIDTH_KEY

SMOOTHSIZER_KEY

KERNEL_KEY

Constructor Detail

TracePlotter

Method Detail

getPlotterDescription

getStyleKeys

createStyle

createLayer