uk.ac.starlink.ttools.plot2.layer

Class PlaneEllipseCoordSet

java.lang.Object

uk.ac.starlink.ttools.plot2.layer.PlaneEllipseCoordSet

All Implemented Interfaces:

CartesianMultiPointCoordSet, MultiPointCoordSet

public class PlaneEllipseCoordSet
extends Object
implements CartesianMultiPointCoordSet

MultiPointCoordSet for ellipses on a plane.

Since:

18 Feb 2013

Author:

Mark Taylor

Constructor Summary

Constructors

Constructor and Description
PlaneEllipseCoordSet() Constructor.

Method Summary

Modifier and Type	Method and Description
static MultiPointForm	createForm() Creates a MultiPointForm that can plot ellipses on the plane, corresponding to this coordset.
Coord[]	getCoords() Returns the coordinate definitions.
int	getPointCount() Returns the number of (non-central) data positions defined by this coord set.
boolean	readPoints(Tuple tuple, int icol, double[] xy0, double[][] xyExtras) Reads the non-central points from a appropriate span of columns in a supplied tuple.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaneEllipseCoordSet

public PlaneEllipseCoordSet()

Constructor.

Method Detail

getCoords

public Coord[] getCoords()

Description copied from interface: MultiPointCoordSet

Returns the coordinate definitions.

Specified by:

getCoords in interface MultiPointCoordSet

Returns:

coords

getPointCount

public int getPointCount()

Description copied from interface: MultiPointCoordSet

Returns the number of (non-central) data positions defined by this coord set.

Specified by:

getPointCount in interface MultiPointCoordSet

Returns:

data position count

readPoints

public boolean readPoints(Tuple tuple,
                          int icol,
                          double[] xy0,
                          double[][] xyExtras)

Description copied from interface: CartesianMultiPointCoordSet

Reads the non-central points from a appropriate span of columns in a supplied tuple. The central data position must be supplied as input. The icExtra value gives the column corresponding to the first coord of this coordinate set in the sequence; the following few columns are assumed to correspond 1:1 to the coords in this coord set.

Specified by:

readPoints in interface CartesianMultiPointCoordSet

Parameters:

tuple - tuple

icol - index of tuple field corresponding to the first of the coordinates in this set

xy0 - nDataDim-element array giving central data position

xyExtras - [nPointCount][nDataDim]-shaped array into which the non-central data positions will be written

Returns:

true iff the conversion was successful

createForm

public static MultiPointForm createForm()

Creates a MultiPointForm that can plot ellipses on the plane, corresponding to this coordset.

Returns:

new form