HistogramPlotter (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.ttools.plot2.layer.HistogramPlotter

All Implemented Interfaces:

Plotter<HistogramPlotter.HistoStyle>
```
public class HistogramPlotter
extends java.lang.Object
implements Plotter<HistogramPlotter.HistoStyle>
```
Plotter for 1-dimensional histograms. This only works on plane plots.

Since:

8 Jan 2014

Author:

Mark Taylor

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class HistogramPlotter.HistoStyle
Style subclass for histogram plots.

Nested Classes
Modifier and Type	Class	Description
`static class`	`HistogramPlotter.HistoStyle`	Style subclass for histogram plots.

Field Summary

Fields
Modifier and Type	Field	Description
`static ReportKey<BinBag>`	`BINS_KEY`	ReportKey for histogram bins.
`static ConfigKey<BinSizer>`	`BINSIZER_KEY`	Config key for bin size configuration.
`static ReportKey<java.lang.Double>`	`BINWIDTH_KEY`	ReportKey for actual bin width.
`static ConfigKey<java.lang.Double>`	`PHASE_KEY`	Config key for bar phase.
`static ConfigKey<java.lang.Integer>`	`THICK_KEY`	Config key for bar line thickness.

Constructor Summary

Constructors
Constructor Description

HistogramPlotter(FloatingCoord xCoord, boolean hasWeight, ConfigKey<Normalisation> normKey)
Constructor.

Constructors
Constructor	Description
`HistogramPlotter(FloatingCoord xCoord, boolean hasWeight, ConfigKey<Normalisation> normKey)`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PlotLayer`	`createLayer(DataGeom geom, DataSpec dataSpec, HistogramPlotter.HistoStyle style)`	The supplied `geom` is ignored.
`HistogramPlotter.HistoStyle`	`createStyle(ConfigMap config)`	Creates a style that can be used when creating a plot layer.
`CoordGroup`	`getCoordGroup()`	Returns an object describing which data coordinates are used for this plotter and how they are arranged in supplied DataSpec objects.
`java.lang.String`	`getPlotterDescription()`	Returns an XML description of this plotter.
`javax.swing.Icon`	`getPlotterIcon()`	Returns an icon for this plotter for use in user interface.
`java.lang.String`	`getPlotterName()`	Returns the name of this plotter for use in user interface.
`ConfigKey[]`	`getStyleKeys()`	Returns the configuration keys used to configure style for this plotter.
`int`	`getWeightCoordIndex()`	Returns the DataSpec coord index used for the weighting data for this plotter.
`boolean`	`hasReports()`	Indicates whether the drawings produced by this plotter will return general interest report information to upstream plotting code.

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

- Field Detail
  - BINS_KEY
```
public static final ReportKey<BinBag> BINS_KEY
```
    ReportKey for histogram bins.
  - BINWIDTH_KEY
```
public static final ReportKey<java.lang.Double> BINWIDTH_KEY
```
    ReportKey for actual bin width.
  - BINSIZER_KEY
```
public static final ConfigKey<BinSizer> BINSIZER_KEY
```
    Config key for bin size configuration.
  - THICK_KEY
```
public static final ConfigKey<java.lang.Integer> THICK_KEY
```
    Config key for bar line thickness.
  - PHASE_KEY
```
public static final ConfigKey<java.lang.Double> PHASE_KEY
```
    Config key for bar phase.
- Constructor Detail
  - HistogramPlotter
```
public HistogramPlotter(FloatingCoord xCoord,
                        boolean hasWeight,
                        ConfigKey<Normalisation> normKey)
```
    Constructor.
    
    Parameters:
    
    xCoord - X axis coordinate
    
    hasWeight - true to permit histogram weighting
    
    normKey - config key for normalisation options
- Method Detail
  - getPlotterName
```
public java.lang.String getPlotterName()
```
    Description copied from interface: Plotter
    
    Returns the name of this plotter for use in user interface.
    
    Specified by:
    
    getPlotterName in interface Plotter<HistogramPlotter.HistoStyle>
    
    Returns:
    
    user-directed plotter name
  - getPlotterIcon
```
public javax.swing.Icon getPlotterIcon()
```
    Description copied from interface: Plotter
    
    Returns an icon for this plotter for use in user interface.
    
    Specified by:
    
    getPlotterIcon in interface Plotter<HistogramPlotter.HistoStyle>
    
    Returns:
    
    plotter icon
  - 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.
    
    Specified by:
    
    getPlotterDescription in interface Plotter<HistogramPlotter.HistoStyle>
    
    Returns:
    
    one or more <p> elements
  - getCoordGroup
```
public CoordGroup getCoordGroup()
```
    Description copied from interface: Plotter
    
    Returns an object describing which data coordinates are used for this plotter and how they are arranged in supplied DataSpec objects.
    
    Specified by:
    
    getCoordGroup in interface Plotter<HistogramPlotter.HistoStyle>
    
    Returns:
    
    coordinate group
  - 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.
    
    Specified by:
    
    getStyleKeys in interface Plotter<HistogramPlotter.HistoStyle>
    
    Returns:
    
    keys used when creating a style for this plotter.
  - createStyle
```
public HistogramPlotter.HistoStyle 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).
    
    Specified by:
    
    createStyle in interface Plotter<HistogramPlotter.HistoStyle>
    
    Parameters:
    
    config - map of style configuration items
    
    Returns:
    
    plotter-specific plot style
  - hasReports
```
public boolean hasReports()
```
    Description copied from interface: Plotter
    
    Indicates whether the drawings produced by this plotter will return general interest report information to upstream plotting code.
    
    Specified by:
    
    hasReports in interface Plotter<HistogramPlotter.HistoStyle>
    
    Returns:
    
    true if the plot report may return interesting information
    
    See Also:
    
    Drawing.getReport(java.lang.Object)
  - createLayer
```
public PlotLayer createLayer(DataGeom geom,
                             DataSpec dataSpec,
                             HistogramPlotter.HistoStyle style)
```
    The supplied geom is ignored.
    
    Specified by:
    
    createLayer in interface Plotter<HistogramPlotter.HistoStyle>
    
    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
  - getWeightCoordIndex
```
public int getWeightCoordIndex()
```
    Returns the DataSpec coord index used for the weighting data for this plotter. If weighting is not supported, a negative value is returned.
    
    Returns:
    
    weight coord index, or -1

Class HistogramPlotter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BINS_KEY

BINWIDTH_KEY

BINSIZER_KEY

THICK_KEY

PHASE_KEY

Constructor Detail

HistogramPlotter

Method Detail

getPlotterName

getPlotterIcon

getPlotterDescription

getCoordGroup

getStyleKeys

createStyle

hasReports

createLayer

getWeightCoordIndex