IDataPointSet
hep.aida

Interface IDataPointSet

  • All Known Implementing Classes:
    DataPointSet


    public interface IDataPointSet
    Basic user-level interface class for holding and managing a single set of "data points".
    • Method Summary

      Methods 
      Modifier and TypeMethod and Description
      IDataPointaddPoint()
      Add a new empty IDataPoint at the end of the set.
      voidaddPoint(IDataPoint point)
      Add a copy of an IDataPoint at the end of the set.
      IAnnotationannotation()
      Get the IAnnotation of the IDataPointSet.
      voidclear()
      Remove all the IDataPoints in the set.
      intdimension()
      Get the dimension of the IDataPoints that can be stored in the set.
      doublelowerExtent(int coord)
      Get the lower value for a give axis.
      IDataPointpoint(int index)
      Get the IDataPoint at a give index in the set.
      voidremovePoint(int index)
      Remove the IDataPoint at a given index.
      voidscale(double scaleFactor)
      Scales the values and the errors of all the measurements of each point by a given factor.
      voidscaleErrors(double scaleFactor)
      Scales the errors of all the measurements of each point by a given factor.
      voidscaleValues(double scaleFactor)
      Scales the values of all the measurements of each point by a given factor.
      voidsetCoordinate(int coord, double[] val, double[] err)
      Set the values and errors of a given coordinate all at once.
      voidsetCoordinate(int coord, double[] val, double[] errp, double[] errm)
      Set the values and errors of a given coordinate all at once.
      voidsetTitle(String title)
      Set the title of the IDataPointSet.
      intsize()
      Get the current size of the IDataPointSet, i.e.
      Stringtitle()
      Get the title of the IDataPointSet.
      doubleupperExtent(int coord)
      Get the upper value for a give axis.
    • Method Detail

      • annotation

        IAnnotation annotation()
        Get the IAnnotation of the IDataPointSet.
        Returns:
        The IAnnotation.
      • title

        String title()
        Get the title of the IDataPointSet.
        Returns:
        The title.
      • dimension

        int dimension()
        Get the dimension of the IDataPoints that can be stored in the set.
        Returns:
        The dimension of the IDataPoints storable in the set.
      • clear

        void clear()
        Remove all the IDataPoints in the set. After this the IDataPointSet is as just created.
      • size

        int size()
        Get the current size of the IDataPointSet, i.e. the number of IDataPoints contained in the set.
        Returns:
        The size of the IDataPointSet.
      • point

        IDataPoint point(int index)
        Get the IDataPoint at a give index in the set.
        Parameters:
        index - The IDataPoint index.
        Returns:
        The corresponding IDataPoint.
      • setCoordinate

        void setCoordinate(int coord,                 double[] val,                 double[] err)                   throws IllegalArgumentException
        Set the values and errors of a given coordinate all at once. If this method is called on an empty IDataPointSet, a number of points equal to the size of the arrays provided is created; if the IDataPointSet is not empty the dimension of the array must match with the size of the IDataPointSet.
        Parameters:
        coord - The coordinate's index
        val - The array of the values for the given coordinate
        err - The array with the symmetric errors.
        Throws:
        IllegalArgumentException - if an illegal coordinate is provided or if there is a mismatch between the size of the array and the size of the IDataPointSet.
      • setCoordinate

        void setCoordinate(int coord,                 double[] val,                 double[] errp,                 double[] errm)                   throws IllegalArgumentException
        Set the values and errors of a given coordinate all at once. If this method is called on an empty IDataPointSet, a number of points equal to the size of the arrays provided is created; if the IDataPointSet is not empty the dimension of the array must match with the size of the IDataPointSet.
        Parameters:
        coord - The coordinate's index
        val - The array of the values for the given coordinate
        errp - The array with the plus errors.
        errm - The array with the minus errors.
        Throws:
        IllegalArgumentException - if an illegal coordinate is provided or if there is a mismatch between the size of the array and the size of the IDataPointSet.
      • lowerExtent

        double lowerExtent(int coord)                   throws IllegalArgumentException
        Get the lower value for a give axis.
        Parameters:
        coord - The coordinate of the axis.
        Returns:
        The lower edge of the corresponding axis.
        Throws:
        IllegalArgumentException - if coord < 0 or coord >= dimension() or if the set is empty.
      • upperExtent

        double upperExtent(int coord)                   throws IllegalArgumentException
        Get the upper value for a give axis.
        Parameters:
        coord - The coordinate of the axis.
        Returns:
        The upper edge of the corresponding axis.
        Throws:
        IllegalArgumentException - if coord < 0 or coord >= dimension() or if the set is empty.
      • scale

        void scale(double scaleFactor)           throws IllegalArgumentException
        Scales the values and the errors of all the measurements of each point by a given factor.
        Parameters:
        scaleFactor - The scale factor.
        Throws:
        IllegalArgumentException - If an illegal scaleFactor is provided.
      • scaleValues

        void scaleValues(double scaleFactor)                 throws IllegalArgumentException
        Scales the values of all the measurements of each point by a given factor.
        Parameters:
        scaleFactor - The scale factor.
        Throws:
        IllegalArgumentException - If an illegal scaleFactor is provided.
      • scaleErrors

        void scaleErrors(double scaleFactor)                 throws IllegalArgumentException
        Scales the errors of all the measurements of each point by a given factor.
        Parameters:
        scaleFactor - The scale factor.
        Throws:
        IllegalArgumentException - If an illegal scaleFactor is provided.

SCaVis 2.2 © jWork.ORG