Class CartesianErrorCoordSet

  • All Implemented Interfaces:
    MultiPointCoordSet

    public class CartesianErrorCoordSet
    extends java.lang.Object
    implements MultiPointCoordSet
    MultiPointCoordSet for bidirectional errors in Cartesian data coordinates.
    Since:
    19 Mar 2013
    Author:
    Mark Taylor
    • Constructor Summary

      Constructors 
      Constructor Description
      CartesianErrorCoordSet​(java.lang.String[] axisNames, int[] iErrDims)
      Constructor.
    • Constructor Detail

      • CartesianErrorCoordSet

        public CartesianErrorCoordSet​(java.lang.String[] axisNames,
                                      int[] iErrDims)
        Constructor. It constructs a coord set for error coordinates in one or more dimensions within in a Cartesian space of nSpaceDim dimensions.
        Parameters:
        axisNames - nSpaceDim-element array of names of Cartesian axes (only those represented in iErrDims are actually used)
        iErrDims - array of axis indices for which errors are to be acquired; each element must be an index in the range 0 <= x < nSpaceDim
    • Method Detail

      • 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,
                                  DataGeom geom,
                                  double[] dpos0,
                                  double[][] dposExtras)
        Description copied from interface: MultiPointCoordSet
        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.
        Specified by:
        readPoints in interface MultiPointCoordSet
        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
      • createAllAxesErrorCoordSet

        public static CartesianErrorCoordSet createAllAxesErrorCoordSet​(java.lang.String[] axisNames)
        Returns a coord set with errors in all of the dimensions of a Cartesian space.
        Parameters:
        axisNames - names of the dimensions; the length of this array defines the dimensionality of the space
        Returns:
        new coord set
      • createSingleAxisErrorCoordSet

        public static CartesianErrorCoordSet createSingleAxisErrorCoordSet​(int ndim,
                                                                           int iErrDim,
                                                                           java.lang.String errAxisName)
        Returns a coord set with errors in a single indicated dimension of a Cartesian space.
        Parameters:
        ndim - dimensionality of the Cartesian space
        iErrDim - index of the dimension for which error coordinates are to be obtained
        errAxisName - label of the axis indicated by iErrDim
        Returns:
        new coord set