PlaneSurfaceFactory (Starlink-UK API)

java.lang.Object
- uk.ac.starlink.ttools.plot2.geom.PlaneSurfaceFactory

All Implemented Interfaces:

SurfaceFactory<PlaneSurfaceFactory.Profile,PlaneAspect>
```
public class PlaneSurfaceFactory
extends Object
implements SurfaceFactory<PlaneSurfaceFactory.Profile,PlaneAspect>
```
Surface factory for flat 2-d plotting.

Since:

19 Feb 2013

Author:

Mark Taylor

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PlaneSurfaceFactory.Config` Specifies configuration options for the PlaneSurfaceFactory.
`static class`	`PlaneSurfaceFactory.Profile` Profile class which defines fixed configuration items for a PlaneSurface.

Field Summary

Fields
Modifier and Type	Field and Description
`static PlaneSurfaceFactory.Config`	`DFLT_CONFIG` Default configuration for plane surface factory.
`static ConfigKey<Boolean>`	`GRID_KEY` Config key to determine if grid lines are drawn.
`static ConfigKey<boolean[]>`	`NAVAXES_KEY` Config key to select which axes navigation actions will operate on.
`static ConfigKey<OrientationPolicy>`	`ORIENTATIONS_KEY_MATRIX` OrientationPolicy key for use with Matrix plot.
`static ConfigKey<OrientationPolicy>`	`ORIENTATIONS_KEY_PLANE` OrientationPolicy key for use with Plane plot.
`static ConfigKey<JELFunction>`	`X2FUNC_KEY` Config key for secondary X axis function.
`static ConfigKey<String>`	`X2LABEL_KEY` Config key for secondary X axis text label.
`static ConfigKey<Boolean>`	`XANCHOR_KEY` Config key to anchor X axis during zooms.
`static ConfigKey<Double>`	`XCROWD_KEY` Config key to control tick mark crowding on X axis.
`static ConfigKey<Boolean>`	`XFLIP_KEY` Config key for X axis flip flag.
`static ConfigKey<String>`	`XLABEL_KEY` Config key for X axis text label.
`static ConfigKey<Boolean>`	`XLOG_KEY` Config key for X axis log scale flag.
`static ConfigKey<Double>`	`XMAX_KEY` Config key for X axis upper bound, before subranging.
`static ConfigKey<Double>`	`XMIN_KEY` Config key for X axis lower bound, before subranging.
`static ConfigKey<Subrange>`	`XSUBRANGE_KEY` Config key for X axis subrange.
`static ConfigKey<Double>`	`XYFACTOR_KEY` Config key for axis aspect ratio fix.
`static ConfigKey<JELFunction>`	`Y2FUNC_KEY` Config key for secondary Y axis function.
`static ConfigKey<String>`	`Y2LABEL_KEY` Config key for secondary Y axis text label.
`static ConfigKey<Boolean>`	`YANCHOR_KEY` Config key to anchor Y axis during zooms.
`static ConfigKey<Double>`	`YCROWD_KEY` Config key to control tick mark crowding on Y axis.
`static ConfigKey<Boolean>`	`YFLIP_KEY` Config key for Y axis flip flag.
`static ConfigKey<String>`	`YLABEL_KEY` Config key for Y axis text label.
`static ConfigKey<Boolean>`	`YLOG_KEY` Config key for Y axis log scale flag.
`static ConfigKey<Double>`	`YMAX_KEY` Config key for Y axis upper bound, before subranging.
`static ConfigKey<Double>`	`YMIN_KEY` Config key for Y axis lower bound, before subranging.
`static ConfigKey<Subrange>`	`YSUBRANGE_KEY` Config key for Y axis subrange.

Constructor Summary

Constructors
Constructor and Description
`PlaneSurfaceFactory()` Constructs a PlaneSurfaceFactory with default characteristics.
`PlaneSurfaceFactory(PlaneSurfaceFactory.Config config)` Constructs a PlaneSurfaceFactory with configurable characteristics.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PlaneAspect`	`createAspect(PlaneSurfaceFactory.Profile profile, ConfigMap config, Range[] ranges)` Creates an aspect from configuration information.
`static ConfigKey<Boolean>`	`createAxisAnchorKey(String axname, boolean dflt)` Creates a config key for determining whether a named axis is to be anchored at a data value of zero.
`static ConfigKey<Double>`	`createAxisCrowdKey(String axname)` Creates a config key for determining tickmark crowding on a named axis.
`static ConfigKey<Boolean>`	`createAxisFlipKey(String axname)` Creates a config key for determining whether a named Cartesian axis is to be reversed.
`static ConfigKey<Double>`	`createAxisLimitKey(String axname, boolean isMax)` Creates a config key for fixing a minimum or maximum limit for a named axis.
`static ConfigKey<Boolean>`	`createAxisLogKey(String axname)` Creates a config key for determining whether a named Cartesian axis is logarithmic or linear.
`static ConfigKey<Subrange>`	`createAxisSubrangeKey(String axname)` Creates a config key for selecting a subrange on a named Cartesian axis.
`Navigator<PlaneAspect>`	`createNavigator(ConfigMap navConfig)` Creates a navigator from configuration information.
`static ConfigKey<OrientationPolicy>`	`createOrientationsKey(OrientationPolicy dflt)` Returns an OrientationPolicy config key suitable for use with this factory, but with a configurable default value.
`PlaneSurfaceFactory.Profile`	`createProfile(ConfigMap config)` Creates a profile that can be used when creating a plot surface.
`static ConfigKey<JELFunction>`	`createSecondaryAxisFunctionKey(String primaryAxisName)` Creates a config key for a secondary axis function.
`static ConfigKey<String>`	`createSecondaryAxisLabelKey(String primaryAxisName)` Returns a labelling config key for a secondary axis.
`Surface`	`createSurface(Rectangle plotBounds, PlaneSurfaceFactory.Profile profile, PlaneAspect aspect)` Returns a new plot surface.
`ConfigMap`	`getAspectConfig(Surface surf)` Returns a ConfigMap that corresponds to the configuration of the given surface, which must have been created by this factory.
`ConfigKey<?>[]`	`getAspectKeys()` Returns the configuration keys that may be used to configure aspect for this surface factory.
`static double[]`	`getLimits(ConfigMap config, ConfigKey<Double> minKey, ConfigKey<Double> maxKey, ConfigKey<Subrange> subrangeKey, boolean isLog, Range range)` Utility method to interrogate axis range configuration variables and work out the actual range to use on a given Cartesian axis.
`static double[]`	`getLimits(double lo, double hi, Subrange subrange, boolean isLog, Range range)` Utility method to determine actual axis limits based on requested high/low values and a subrange.
`ConfigKey<?>[]`	`getNavigatorKeys()` Returns the configuration keys that may be used to configure a navigator for use with this surface factory.
`ConfigKey<OrientationPolicy>`	`getOrientationsKey()` Returns the OrientationPolicy config key used by this factory.
`PlotMetric`	`getPlotMetric()` Returns an object that can assess distances between graphic positions on the plot surface.
`ConfigKey<?>[]`	`getProfileKeys()` Returns the configuration keys used to configure profile for this surface factory.
`XyKeyPair<?>[]`	`getXyKeyPairs()` Returns a list of those keys which apply equally to the X and Y axes.
`Range[]`	`readRanges(PlaneSurfaceFactory.Profile profile, PlotLayer[] layers, DataStore dataStore)` Provides the ranges that may be passed to `createAspect`.
`boolean`	`useRanges(PlaneSurfaceFactory.Profile profile, ConfigMap config)` Indicates whether ranges should be provided to generate an aspect.

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

- Field Detail
  - XMIN_KEY
```
public static final ConfigKey<Double> XMIN_KEY
```
    Config key for X axis lower bound, before subranging.
  - XMAX_KEY
```
public static final ConfigKey<Double> XMAX_KEY
```
    Config key for X axis upper bound, before subranging.
  - XSUBRANGE_KEY
```
public static final ConfigKey<Subrange> XSUBRANGE_KEY
```
    Config key for X axis subrange.
  - YMIN_KEY
```
public static final ConfigKey<Double> YMIN_KEY
```
    Config key for Y axis lower bound, before subranging.
  - YMAX_KEY
```
public static final ConfigKey<Double> YMAX_KEY
```
    Config key for Y axis upper bound, before subranging.
  - YSUBRANGE_KEY
```
public static final ConfigKey<Subrange> YSUBRANGE_KEY
```
    Config key for Y axis subrange.
  - XLOG_KEY
```
public static final ConfigKey<Boolean> XLOG_KEY
```
    Config key for X axis log scale flag.
  - YLOG_KEY
```
public static final ConfigKey<Boolean> YLOG_KEY
```
    Config key for Y axis log scale flag.
  - XFLIP_KEY
```
public static final ConfigKey<Boolean> XFLIP_KEY
```
    Config key for X axis flip flag.
  - YFLIP_KEY
```
public static final ConfigKey<Boolean> YFLIP_KEY
```
    Config key for Y axis flip flag.
  - XLABEL_KEY
```
public static final ConfigKey<String> XLABEL_KEY
```
    Config key for X axis text label.
  - YLABEL_KEY
```
public static final ConfigKey<String> YLABEL_KEY
```
    Config key for Y axis text label.
  - X2FUNC_KEY
```
public static final ConfigKey<JELFunction> X2FUNC_KEY
```
    Config key for secondary X axis function.
  - Y2FUNC_KEY
```
public static final ConfigKey<JELFunction> Y2FUNC_KEY
```
    Config key for secondary Y axis function.
  - X2LABEL_KEY
```
public static final ConfigKey<String> X2LABEL_KEY
```
    Config key for secondary X axis text label.
  - Y2LABEL_KEY
```
public static final ConfigKey<String> Y2LABEL_KEY
```
    Config key for secondary Y axis text label.
  - XYFACTOR_KEY
```
public static final ConfigKey<Double> XYFACTOR_KEY
```
    Config key for axis aspect ratio fix.
  - GRID_KEY
```
public static final ConfigKey<Boolean> GRID_KEY
```
    Config key to determine if grid lines are drawn.
  - XCROWD_KEY
```
public static final ConfigKey<Double> XCROWD_KEY
```
    Config key to control tick mark crowding on X axis.
  - YCROWD_KEY
```
public static final ConfigKey<Double> YCROWD_KEY
```
    Config key to control tick mark crowding on Y axis.
  - NAVAXES_KEY
```
public static final ConfigKey<boolean[]> NAVAXES_KEY
```
    Config key to select which axes navigation actions will operate on.
  - XANCHOR_KEY
```
public static final ConfigKey<Boolean> XANCHOR_KEY
```
    Config key to anchor X axis during zooms.
  - YANCHOR_KEY
```
public static final ConfigKey<Boolean> YANCHOR_KEY
```
    Config key to anchor Y axis during zooms.
  - ORIENTATIONS_KEY_PLANE
```
public static final ConfigKey<OrientationPolicy> ORIENTATIONS_KEY_PLANE
```
    OrientationPolicy key for use with Plane plot.
  - ORIENTATIONS_KEY_MATRIX
```
public static final ConfigKey<OrientationPolicy> ORIENTATIONS_KEY_MATRIX
```
    OrientationPolicy key for use with Matrix plot.
  - DFLT_CONFIG
```
public static final PlaneSurfaceFactory.Config DFLT_CONFIG
```
    Default configuration for plane surface factory.
- Constructor Detail
  - PlaneSurfaceFactory
```
public PlaneSurfaceFactory()
```
    Constructs a PlaneSurfaceFactory with default characteristics.
  - PlaneSurfaceFactory
```
public PlaneSurfaceFactory(PlaneSurfaceFactory.Config config)
```
    Constructs a PlaneSurfaceFactory with configurable characteristics.
    
    Parameters:
    
    config - configuration options
- Method Detail
  - createSurface
```
public Surface createSurface(Rectangle plotBounds,
                             PlaneSurfaceFactory.Profile profile,
                             PlaneAspect aspect)
```
    Description copied from interface: SurfaceFactory
    
    Returns a new plot surface.
    
    Specified by:
    
    createSurface in interface SurfaceFactory<PlaneSurfaceFactory.Profile,PlaneAspect>
    
    Parameters:
    
    plotBounds - rectangle to containing actual plot data (not insets)
    
    profile - configuration object defining plot style
    
    aspect - configuration object defining plot viewpoint
    
    Returns:
    
    new plot surface
  - getProfileKeys
```
public ConfigKey<?>[] getProfileKeys()
```
    Description copied from interface: SurfaceFactory
    
    Returns the configuration keys used to configure profile for this surface factory. The returned keys are used in the map supplied to the createProfile method.
    
    Specified by:
    
    getProfileKeys in interface SurfaceFactory<PlaneSurfaceFactory.Profile,PlaneAspect>
    
    Returns:
    
    profile configuration keys
  - createProfile
```
public PlaneSurfaceFactory.Profile createProfile(ConfigMap config)
```
    Description copied from interface: SurfaceFactory
    
    Creates a profile that can be used when creating a plot surface. The keys that are significant in the supplied config map are those returned by getProfileKeys. The return value can be used as input to createSurface and other methods in this class.
    
    Specified by:
    
    createProfile in interface SurfaceFactory<PlaneSurfaceFactory.Profile,PlaneAspect>
    
    Parameters:
    
    config - map of profile configuration items
    
    Returns:
    
    factory-specific plot surface profile
  - getAspectKeys
```
public ConfigKey<?>[] getAspectKeys()
```
    Description copied from interface: SurfaceFactory
    
    Returns the configuration keys that may be used to configure aspect for this surface factory. The returned keys are used in the map supplied to the useRanges and createAspect methods.
    
    Specified by:
    
    getAspectKeys in interface SurfaceFactory<PlaneSurfaceFactory.Profile,PlaneAspect>
    
    Returns:
    
    aspect configuration keys
  - useRanges
```
public boolean useRanges(PlaneSurfaceFactory.Profile profile,
                         ConfigMap config)
```
    Description copied from interface: SurfaceFactory
    
    Indicates whether ranges should be provided to generate an aspect. If true, it is beneficial to pass the result of readRanges to createAspect alongside the arguments of this method. If false, any such ranges will be ignored.
    
    Specified by:
    
    useRanges in interface SurfaceFactory<PlaneSurfaceFactory.Profile,PlaneAspect>
    
    Parameters:
    
    profile - surface configuration profile
    
    config - configuration map that may contain keys from getAspectKeys
    
    Returns:
    
    true iff calculated ranges will be of use
  - createAspect
```
public PlaneAspect createAspect(PlaneSurfaceFactory.Profile profile,
                                ConfigMap config,
                                Range[] ranges)
```
    Description copied from interface: SurfaceFactory
    
    Creates an aspect from configuration information. The ranges argument will be used only if useRanges returns true. It is legal to give the ranges argument as null in any case. In all cases, the returned value must be non-null and usable by createSurface.
    
    Specified by:
    
    createAspect in interface SurfaceFactory<PlaneSurfaceFactory.Profile,PlaneAspect>
    
    Parameters:
    
    profile - surface configuration profile
    
    config - configuration map that may contain keys from getAspectKeys
    
    ranges - range data filled in from layers, or null
    
    Returns:
    
    new aspect
  - getAspectConfig
```
public ConfigMap getAspectConfig(Surface surf)
```
    Description copied from interface: SurfaceFactory
    
    Returns a ConfigMap that corresponds to the configuration of the given surface, which must have been created by this factory. The intention is that supplying the returned config items to this object's createAspect method with the right profile should come up with approximately the same surface, preferably without reference to any supplied ranges.
    The returned config items should be optimised for presentation to the user, so that for instance decimal values are reported to a reasonable level of precision. Because of this, and perhaps for other reasons related to implementation, a surface resulting from feeding the returned config back to this factory may not be identical to the supplied surface, so round-tripping is not guaranteed to be exact.
    
    Specified by:
    
    getAspectConfig in interface SurfaceFactory<PlaneSurfaceFactory.Profile,PlaneAspect>
    
    Parameters:
    
    surf - plot surface; if it was not created by this factory, behaviour is undefined
    
    Returns:
    
    config map populated with items that should approximately reproduce the supplied surface
  - readRanges
```
public Range[] readRanges(PlaneSurfaceFactory.Profile profile,
                          PlotLayer[] layers,
                          DataStore dataStore)
```
    Description copied from interface: SurfaceFactory
    
    Provides the ranges that may be passed to createAspect. There is only any point calling this if useRanges returns true.
    
    Specified by:
    
    readRanges in interface SurfaceFactory<PlaneSurfaceFactory.Profile,PlaneAspect>
    
    Parameters:
    
    profile - surface configuration profile
    
    layers - plot layers to be plotted
    
    dataStore - contains actual data
    
    Returns:
    
    data ranges covered by the given layers filled in from data
  - getNavigatorKeys
```
public ConfigKey<?>[] getNavigatorKeys()
```
    Description copied from interface: SurfaceFactory
    
    Returns the configuration keys that may be used to configure a navigator for use with this surface factory. The returned keys are used in the map supplied to the SurfaceFactory.createNavigator(uk.ac.starlink.ttools.plot2.config.ConfigMap) method.
    
    Specified by:
    
    getNavigatorKeys in interface SurfaceFactory<PlaneSurfaceFactory.Profile,PlaneAspect>
    
    Returns:
    
    navigator configuration keys
  - createNavigator
```
public Navigator<PlaneAspect> createNavigator(ConfigMap navConfig)
```
    Description copied from interface: SurfaceFactory
    
    Creates a navigator from configuration information. The returned value will be non-null.
    
    Specified by:
    
    createNavigator in interface SurfaceFactory<PlaneSurfaceFactory.Profile,PlaneAspect>
    
    Parameters:
    
    navConfig - configuration map that may contain keys from getNavigatorKeys
    
    Returns:
    
    navigator for use with surfaces produced by this factory
  - getPlotMetric
```
public PlotMetric getPlotMetric()
```
    Description copied from interface: SurfaceFactory
    
    Returns an object that can assess distances between graphic positions on the plot surface. If no such metric exists, null may be returned.
    
    Specified by:
    
    getPlotMetric in interface SurfaceFactory<PlaneSurfaceFactory.Profile,PlaneAspect>
    
    Returns:
    
    plot metric, or null
  - getXyKeyPairs
```
public XyKeyPair<?>[] getXyKeyPairs()
```
    Returns a list of those keys which apply equally to the X and Y axes.
    
    Returns:
    
    paired X/Y key objects
  - getOrientationsKey
```
public ConfigKey<OrientationPolicy> getOrientationsKey()
```
    Returns the OrientationPolicy config key used by this factory.
    
    Returns:
    
    orientations key
  - createAxisAnchorKey
```
public static ConfigKey<Boolean> createAxisAnchorKey(String axname,
                                                     boolean dflt)
```
    Creates a config key for determining whether a named axis is to be anchored at a data value of zero.
    
    Parameters:
    
    axname - axis name
    
    dflt - anchor default value
    
    Returns:
    
    config key
  - createAxisLimitKey
```
public static ConfigKey<Double> createAxisLimitKey(String axname,
                                                   boolean isMax)
```
    Creates a config key for fixing a minimum or maximum limit for a named axis.
    
    Parameters:
    
    axname - axis name
    
    isMax - true for upper limit, false for lower limit
    
    Returns:
    
    new config key
  - createAxisLogKey
```
public static ConfigKey<Boolean> createAxisLogKey(String axname)
```
    Creates a config key for determining whether a named Cartesian axis is logarithmic or linear.
    
    Parameters:
    
    axname - axis name
    
    Returns:
    
    new config key, true for log scaling
  - createAxisFlipKey
```
public static ConfigKey<Boolean> createAxisFlipKey(String axname)
```
    Creates a config key for determining whether a named Cartesian axis is to be reversed.
    
    Parameters:
    
    axname - axis name
    
    Returns:
    
    new config key, true if sense is reversed
  - createAxisSubrangeKey
```
public static ConfigKey<Subrange> createAxisSubrangeKey(String axname)
```
    Creates a config key for selecting a subrange on a named Cartesian axis.
    
    Parameters:
    
    axname - axis name
    
    Returns:
    
    new config key
  - createAxisCrowdKey
```
public static ConfigKey<Double> createAxisCrowdKey(String axname)
```
    Creates a config key for determining tickmark crowding on a named axis.
    
    Parameters:
    
    axname - axis name
    
    Returns:
    
    new config key for dimensionless crowding figure
  - createSecondaryAxisFunctionKey
```
public static ConfigKey<JELFunction> createSecondaryAxisFunctionKey(String primaryAxisName)
```
    Creates a config key for a secondary axis function.
    
    Parameters:
    
    primaryAxisName - name of primary axis, for instance "X"
    
    Returns:
    
    new config key
  - createSecondaryAxisLabelKey
```
public static ConfigKey<String> createSecondaryAxisLabelKey(String primaryAxisName)
```
    Returns a labelling config key for a secondary axis.
    
    Parameters:
    
    primaryAxisName - name of primary axis to which the secondary axis relates
    
    Returns:
    
    new key
  - createOrientationsKey
```
public static ConfigKey<OrientationPolicy> createOrientationsKey(OrientationPolicy dflt)
```
    Returns an OrientationPolicy config key suitable for use with this factory, but with a configurable default value.
    
    Returns:
    
    config key
  - getLimits
```
public static double[] getLimits(ConfigMap config,
                                 ConfigKey<Double> minKey,
                                 ConfigKey<Double> maxKey,
                                 ConfigKey<Subrange> subrangeKey,
                                 boolean isLog,
                                 Range range)
```
    Utility method to interrogate axis range configuration variables and work out the actual range to use on a given Cartesian axis. If not enough information is supplied to determine the definite range, null is returned.
    
    Parameters:
    
    config - config map containing config values
    
    minKey - config key giving axis lower bound before subranging
    
    maxKey - config key giving axis upper bound before subranging
    
    subrangeKey - config key giving subrange value
    
    isLog - true for logarithmic axis, false for linear
    
    range - data range on axis; may be partially populated or null
    
    Returns:
    
    2-element array giving definite axis (lower,upper) bounds, or null
  - getLimits
```
public static double[] getLimits(double lo,
                                 double hi,
                                 Subrange subrange,
                                 boolean isLog,
                                 Range range)
```
    Utility method to determine actual axis limits based on requested high/low values and a subrange. If not enough information is supplied to determine the definite range, null is returned.
    
    Parameters:
    
    lo - requested lower bound before subranging, may be NaN
    
    hi - requested upper bound before subranging, may be NaN
    
    subrange - requested subrange
    
    isLog - true for logarithmic axis, false for linear
    
    range - actual data range on axis; may be partially populated or null
    
    Returns:
    
    2-element array giving definite axis (lower,upper) bounds, or null

Class PlaneSurfaceFactory

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

XMIN_KEY

XMAX_KEY

XSUBRANGE_KEY

YMIN_KEY

YMAX_KEY

YSUBRANGE_KEY

XLOG_KEY

YLOG_KEY

XFLIP_KEY

YFLIP_KEY

XLABEL_KEY

YLABEL_KEY

X2FUNC_KEY

Y2FUNC_KEY

X2LABEL_KEY

Y2LABEL_KEY

XYFACTOR_KEY

GRID_KEY

XCROWD_KEY

YCROWD_KEY

NAVAXES_KEY

XANCHOR_KEY

YANCHOR_KEY

ORIENTATIONS_KEY_PLANE

ORIENTATIONS_KEY_MATRIX

DFLT_CONFIG

Constructor Detail

PlaneSurfaceFactory

PlaneSurfaceFactory

Method Detail

createSurface

getProfileKeys

createProfile

getAspectKeys

useRanges

createAspect

getAspectConfig

readRanges

getNavigatorKeys

createNavigator

getPlotMetric

getXyKeyPairs

getOrientationsKey

createAxisAnchorKey

createAxisLimitKey

createAxisLogKey

createAxisFlipKey

createAxisSubrangeKey

createAxisCrowdKey

createSecondaryAxisFunctionKey

createSecondaryAxisLabelKey

createOrientationsKey

getLimits

getLimits