public class StiltsPlot
extends java.lang.Object
Use a StiltsPlotFormatter
instance to export this object into a
useful external form, such as a shell command line.
Constructor and Description |
---|
StiltsPlot(AbstractPlot2Task task,
java.lang.String taskName,
SettingGroup[] groups)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static StiltsPlot |
createPlot(PlotSpec plotSpec,
StiltsPlotFormatter formatter)
Turns a PlotSpec into an abstract model of a STILTS command line
to regenerate the same plot.
|
SettingGroup[] |
getGroups()
Returns an array of objects that together contain all the parameter
settings required to specify this task to stilts.
|
AbstractPlot2Task |
getTask()
Returns the plot task corresponding to this object.
|
java.lang.String |
getTaskName()
Returns the name of this object's plot task, as used by the
stilts command line.
|
public StiltsPlot(AbstractPlot2Task task, java.lang.String taskName, SettingGroup[] groups)
task
- plot tasktaskName
- name of the plot task as used by stilts command linegroups
- all name-value pairs specifying the configuration
of the task, grouped for cosmetic purposespublic AbstractPlot2Task getTask()
public java.lang.String getTaskName()
public SettingGroup[] getGroups()
public static StiltsPlot createPlot(PlotSpec plotSpec, StiltsPlotFormatter formatter) throws uk.ac.starlink.util.LoadException
This is the method that does the work of mapping the internal plot representation to a STILTS command line. It has to understand how the AbstractPlot2Task parameters are specified, which is a complicated job. So (1) the output is not bulletproof, and may get broken by implementation or interface changes elsewhere in the code base, and therefore (2) lots of tests are a good idea. It works on a best efforts basis.
plotSpec
- programmatic representation of a plotformatter
- defines details of how formatting will take placeuk.ac.starlink.util.LoadException
Copyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.