uk.ac.starlink.ttools.plot2.task

Class MatrixPlot2Task

java.lang.Object

uk.ac.starlink.ttools.plot2.task.AbstractPlot2Task

uk.ac.starlink.ttools.plot2.task.TypedPlot2Task<PlaneSurfaceFactory.Profile,PlaneAspect>

uk.ac.starlink.ttools.plot2.task.MatrixPlot2Task

All Implemented Interfaces:

Task, DynamicTask

public class MatrixPlot2Task
extends TypedPlot2Task<PlaneSurfaceFactory.Profile,PlaneAspect>

Plot task for matrix plot.

Since:

22 Aug 2023

Author:

Mark Taylor

Field Summary

Fields inherited from class uk.ac.starlink.ttools.plot2.task.AbstractPlot2Task

DOC_ZONE_SUFFIX, DOMAINMAPPER_SUFFIX, EXAMPLE_LAYER_SUFFIX, EXAMPLE_ZONE_SUFFIX, LAYER_PREFIX, ZONE_PREFIX

Constructor Summary

Constructors

Constructor and Description
MatrixPlot2Task() Constructor.

Method Summary

Modifier and Type	Method and Description
protected <P,A> PlotConfiguration<P,A>	createPlotConfiguration(Environment env, PlotContext<P,A> context) The implementation of this method simply adapts the createPlanePlotConfiguration(uk.ac.starlink.task.Environment, uk.ac.starlink.ttools.plot2.task.PlotContext<uk.ac.starlink.ttools.plot2.geom.PlaneSurfaceFactory.Profile, uk.ac.starlink.ttools.plot2.geom.PlaneAspect>) method to the required signature.
Parameter<?>[]	getParameters() Returns the list of parameters which may be used by this task.
String	getPurpose() Returns a short (one-line) description of the purpose of this task.

Methods inherited from class uk.ac.starlink.ttools.plot2.task.TypedPlot2Task

createDefaultPlotContext, getConfigParamDefault, getPlotContext, getPlotContext, getPlotType

Methods inherited from class uk.ac.starlink.ttools.plot2.task.AbstractPlot2Task

createAuxCrowdParameter, createAuxLabelParameter, createAuxVisibleParameter, createAuxWidthParameter, createBasicConfigMap, createCaptioner, createConfigMap, createCustomConfigMap, createDataParameter, createDomainMapperParameter, createExecutable, createFilterParameter, createLabelParameter, createLayerSuffixedConfigMap, createLayerTypeParameter, createLegend, createLegendPositionParameter, createPaintModeParameter, createPlotComponent, createPlotIcon, createPlotIcon, createShadeAxisFactory, createTableParameter, createTitleParameter, createZoneParameter, getBasicParameters, getBitmapParameter, getCompositorParameter, getContextParameters, getCoordValue, getDataStoreParameter, getInputTable, getLegendBorderParameter, getLegendOpaqueParameter, getLegendParameter, getLegendSequenceParameter, getPaddingParameter, getParameterByName, getPlotters, getSequenceParameter, getXpixParameter, getYpixParameter, getZoneKeyParams, hasDomainMappers, hasZoneSuffixes, testEnv

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MatrixPlot2Task

public MatrixPlot2Task()

Constructor.

Method Detail

getPurpose

public String getPurpose()

Description copied from interface: Task

Returns a short (one-line) description of the purpose of this task.

Specified by:

getPurpose in interface Task

Overrides:

getPurpose in class TypedPlot2Task<PlaneSurfaceFactory.Profile,PlaneAspect>

Returns:

plain text description of this task's purpose

getParameters

public Parameter<?>[] getParameters()

Description copied from interface: Task

Returns the list of parameters which may be used by this task.

Specified by:

getParameters in interface Task

Overrides:

getParameters in class TypedPlot2Task<PlaneSurfaceFactory.Profile,PlaneAspect>

Returns:

an array of the Parameter objects this task may request values for during its invocation

createPlotConfiguration

protected <P,A> PlotConfiguration<P,A> createPlotConfiguration(Environment env,
                                                               PlotContext<P,A> context)
                                                        throws TaskException

The implementation of this method simply adapts the createPlanePlotConfiguration(uk.ac.starlink.task.Environment, uk.ac.starlink.ttools.plot2.task.PlotContext<uk.ac.starlink.ttools.plot2.geom.PlaneSurfaceFactory.Profile, uk.ac.starlink.ttools.plot2.geom.PlaneAspect>) method to the required signature.

Overrides:

createPlotConfiguration in class AbstractPlot2Task

Parameters:

env - execution environment

context - plot context

Returns:

plot configuration

Throws:

TaskException