Class LinearFitPlotter
- java.lang.Object
-
- uk.ac.starlink.ttools.plot2.layer.AbstractPlotter<LineStyle>
-
- uk.ac.starlink.ttools.plot2.layer.LinearFitPlotter
-
public class LinearFitPlotter extends AbstractPlotter<LineStyle>
Fits a set of 2-d points to a linear equation, and plots the line.- Since:
- 8 Dec 2014
- Author:
- Mark Taylor
-
-
Field Summary
Fields Modifier and Type Field Description static ReportKey<double[]>
COEFFS_KEY
Report key for coefficients of linear fit (2 element array (c, m)).static ReportKey<java.lang.Double>
CORRELATION_KEY
Report key for product moment correlation coefficient.static ReportKey<java.lang.String>
EQUATION_KEY
Report key for text of linear fit equation.
-
Constructor Summary
Constructors Constructor Description LinearFitPlotter(boolean hasWeights)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PlotLayer
createLayer(DataGeom geom, DataSpec dataSpec, LineStyle style)
Creates a PlotLayer based on the given geometry, data and style.LineStyle
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
-
-
-
-
Field Detail
-
COEFFS_KEY
public static final ReportKey<double[]> COEFFS_KEY
Report key for coefficients of linear fit (2 element array (c, m)).
-
EQUATION_KEY
public static final ReportKey<java.lang.String> EQUATION_KEY
Report key for text of linear fit equation.
-
CORRELATION_KEY
public static final ReportKey<java.lang.Double> CORRELATION_KEY
Report key for product moment correlation coefficient.
-
-
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 thePlotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap)
method.- Returns:
- keys used when creating a style for this plotter.
-
createStyle
public LineStyle 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 byPlotter.getStyleKeys()
. The return value can be used as input toPlotter.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, LineStyle 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 toPlotter.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 ifgetCoordGroup()
.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'sDataGeom.hasPosition()
method will return truedataSpec
- specifies the data required for the plotstyle
- data style as obtained fromcreateStyle
- Returns:
- new plot layer, or null if no drawing will take place
-
-