Interface MultiPointCoordSet

All Known Implementing Classes:
CartesianErrorCoordSet, CartesianVectorCoordSet, PlaneCorrelationCoordSet, PlaneEllipseCoordSet, SkyCorrelationCoordSet, SkyEllipseCoordSet, SkyVectorCoordSet

public interface MultiPointCoordSet
Defines non-central coordinates used by a MultiPointPlotter.
Since:
18 Feb 2013
Author:
Mark Taylor
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the coordinate definitions.
    int
    Returns the number of (non-central) data positions defined by this coord set.
    boolean
    readPoints(Tuple tuple, int icol, DataGeom geom, double[] dpos0, double[][] dposExtras)
    Reads the non-central points from a appropriate span of columns in a supplied tuple.
  • Method Details

    • getCoords

      Coord[] getCoords()
      Returns the coordinate definitions.
      Returns:
      coords
    • getPointCount

      int getPointCount()
      Returns the number of (non-central) data positions defined by this coord set.
      Returns:
      data position count
    • readPoints

      boolean readPoints(Tuple tuple, int icol, DataGeom geom, double[] dpos0, double[][] dposExtras)
      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 icol value gives the column corresponding to the first coord of this coordinate set in the sequence; the following few columns are assumed to correspod 1:1 to the coords in this coord set.
      Parameters:
      tuple - tuple
      icol - index of tuple field corresponding to the first of the coordinates in this set
      geom - converter between tuple values and data space coordinates; may not be required
      dpos0 - nDataDim-element array giving central data position
      dposExtras - [nPointCount][nDataDim]-shaped array into which the non-central data positions will be written
      Returns:
      true iff the conversion was successful