Class SkyMultiPointForm

java.lang.Object
uk.ac.starlink.ttools.plot2.layer.MultiPointForm
uk.ac.starlink.ttools.plot2.layer.SkyMultiPointForm
All Implemented Interfaces:
ModePlotter.Form, ShapeForm

public class SkyMultiPointForm extends MultiPointForm
MultiPointForm with scaling options that make sense for plotting markers on the sky with potentially absolute angular extents.
Since:
2 Aug 2017
Author:
Mark Taylor
  • Field Details

    • SCALE_KEY

      public static final ConfigKey<Double> SCALE_KEY
      Config key for angular extent scaling.
    • UNIT_KEY

      public static final ConfigKey<AngleUnit> UNIT_KEY
      Config key for selecting angular extent units.
  • Constructor Details

    • SkyMultiPointForm

      public SkyMultiPointForm(String name, Icon icon, String description, MultiPointCoordSet extraCoordSet, MultiPointConfigKey rendererKey)
      Constructor.
      Parameters:
      name - shapeform name
      icon - shapeform icon
      description - XML description
      extraCoordSet - defines the extra positional coordinates used to plot multipoint shapes
      rendererKey - config key for the renderer, defining the plotted shape; any renderer specified must be expecting data corresponding to the extraCoordSet parameter
  • Method Details

    • getScaleFactor

      protected double getScaleFactor(ConfigMap config)
      Description copied from class: MultiPointForm
      Returns a fixed constant by which to scale all (autoscaled or not autoscaled) offset values before plotting.
      Specified by:
      getScaleFactor in class MultiPointForm
      Parameters:
      config - config map
      Returns:
      constant scaling factor
    • isAutoscale

      protected boolean isAutoscale(ConfigMap config)
      Description copied from class: MultiPointForm
      Indicates whether autoscaling should be applied. If true, before plotting is carried out a scan of all the data values is performed to determine the range of values, and the supplied offsets are scaled accordingly, so that the largest ones are a reasonable size on the screen.
      Specified by:
      isAutoscale in class MultiPointForm
      Parameters:
      config - config map
      Returns:
      true for autoscaling false to use raw values
    • getCoordUnitText

      public static String getCoordUnitText()
      Returns a sentence of XML text describing the units of a scaled coordinate are specified. This is suitable for inclusion in the description of the relevant FloatingCoord.
      Returns:
      description text
    • getScalingDescription

      public static String getScalingDescription(FloatingCoord[] scaledCoords, String shapename)
      Returns XML text suitable for inclusion in a MultiPointForm description explaining how the scaling of marker sizes is controlled.
      Parameters:
      scaledCoords - coordinates that will be scaled by the scale and unit config options
      shapename - human-readable name of the shape being plotted by this form
      Returns:
      description text <p> element