IDataPointSetFactory
hep.aida

Interface IDataPointSetFactory

  • All Known Implementing Classes:
    DataPointSetFactory


    public interface IDataPointSetFactory
    Basic user-level interface for creating a factory of IDataPointSet.
    • Method Detail

      • create

        IDataPointSet create(String path,                   String title,                   int dimOfPoints)                     throws IllegalArgumentException
        Create an empty IDataPointSet.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        title - The title of the IDataPointSet.
        dimOfPoints - The dimension of the IDataPoints that can be stored in the set. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   String title,                   int dimOfPoints,                   String options)                     throws IllegalArgumentException
        Create an empty IDataPointSet.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        title - The title of the IDataPointSet.
        dimOfPoints - The dimension of the IDataPoints that can be stored in the set.
        options - The options for the IDataPointSet, currently not specified. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String pathAndTitle,                   int dimOfPoints)                     throws IllegalArgumentException
        Create an empty IDataPointSet.
        Parameters:
        pathAndTitle - The path of the IDataPointSet. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        dimOfPoints - The dimension of the IDataPoints that can be stored in the set. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String pathAndTitle,                   int dimOfPoints,                   String options)                     throws IllegalArgumentException
        Create an empty IDataPointSet.
        Parameters:
        pathAndTitle - The path of the IDataPointSet. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        dimOfPoints - The dimension of the IDataPoints that can be stored in the set.
        options - The options for the IDataPointSet, currently not specified. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createY

        IDataPointSet createY(String path,                    String title,                    double[] y,                    double[] ey)                      throws IllegalArgumentException
        Create a two dimensional IDataPointSet providing the data along y (the x value is the index of the y value in the array).
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        title - The title of the IDataPointSet.
        y - The array of the y values
        ey - The array with the symmetric errors on y
        Returns:
        The created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createY

        IDataPointSet createY(String path,                    String title,                    double[] y,                    double[] eyp,                    double[] eym)                      throws IllegalArgumentException
        Create a two dimensional IDataPointSet providing the data along y (the x value is the index of the y value in the array).
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        title - The title of the IDataPointSet.
        y - The array of the y values
        eyp - The array with the plus errors on y
        eym - The array with the minus errors on y
        Returns:
        The created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createY

        IDataPointSet createY(String pathAndTitle,                    double[] y,                    double[] ey)                      throws IllegalArgumentException
        Create a two dimensional IDataPointSet providing the data along y (the x value is the index of the y value in the array).
        Parameters:
        pathAndTitle - The path of the IDataPointSet. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        y - The array of the y values
        ey - The array with the symmetric errors on y
        Returns:
        The created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createY

        IDataPointSet createY(String pathAndTitle,                    double[] y,                    double[] eyp,                    double[] eym)                      throws IllegalArgumentException
        Create a two dimensional IDataPointSet providing the data along y (the x value is the index of the y value in the array).
        Parameters:
        pathAndTitle - The path of the IDataPointSet. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        y - The array of the y values
        eyp - The array with the plus errors on y
        eym - The array with the minus errors on y
        Returns:
        The created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createX

        IDataPointSet createX(String path,                    String title,                    double[] x,                    double[] ex)                      throws IllegalArgumentException
        Create a two dimensional IDataPointSet providing the data along x (the y value is the index of the x value in the array).
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        title - The title of the IDataPointSet.
        x - The array of the x values
        ex - The array with the symmetric errors on x
        Returns:
        The created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createX

        IDataPointSet createX(String path,                    String title,                    double[] x,                    double[] exp,                    double[] exm)                      throws IllegalArgumentException
        Create a two dimensional IDataPointSet providing the data along x (the y value is the index of the x value in the array).
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        title - The title of the IDataPointSet.
        x - The array of the x values
        exp - The array with the plus errors on x
        exm - The array with the minus errors on x
        Returns:
        The created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createX

        IDataPointSet createX(String pathAndTitle,                    double[] x,                    double[] ex)                      throws IllegalArgumentException
        Create a two dimensional IDataPointSet providing the data along x (the y value is the index of the x value in the array).
        Parameters:
        pathAndTitle - The path of the IDataPointSet. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        x - The array of the x values
        ex - The array with the symmetric errors on x
        Returns:
        The created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createX

        IDataPointSet createX(String pathAndTitle,                    double[] x,                    double[] exp,                    double[] exm)                      throws IllegalArgumentException
        Create a two dimensional IDataPointSet providing the data along x (the y value is the index of the x value in the array).
        Parameters:
        pathAndTitle - The path of the IDataPointSet. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        x - The array of the x values
        exp - The array with the plus errors on x
        exm - The array with the minus errors on x
        Returns:
        The created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createXY

        IDataPointSet createXY(String path,                     String title,                     double[] x,                     double[] y,                     double[] exp,                     double[] eyp,                     double[] exm,                     double[] eym)                       throws IllegalArgumentException
        Create a two dimensional IDataPointSet providing the data.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        title - The title of the IDataPointSet.
        x - The array of the x values
        y - The array of the y values
        exp - The array with the plus errors on x
        eyp - The array with the plus errors on y
        exm - The array with the minus errors on x
        eym - The array with the minus errors on y
        Returns:
        The created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createXY

        IDataPointSet createXY(String path,                     String title,                     double[] x,                     double[] y,                     double[] ex,                     double[] ey)                       throws IllegalArgumentException
        Create a two dimensional IDataPointSet providing the data.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        title - The title of the IDataPointSet.
        x - The array of the x values
        y - The array of the y values
        ex - The array with the symmetric errors on x
        ey - The array with the symmetric errors on y
        Returns:
        The created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createXY

        IDataPointSet createXY(String pathAndTitle,                     double[] x,                     double[] y,                     double[] exp,                     double[] eyp,                     double[] exm,                     double[] eym)                       throws IllegalArgumentException
        Create a two dimensional IDataPointSet providing the data.
        Parameters:
        pathAndTitle - The path of the IDataPointSet. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        x - The array of the x values
        y - The array of the y values
        exp - The array with the plus errors on x
        eyp - The array with the plus errors on y
        exm - The array with the minus errors on x
        eym - The array with the minus errors on y
        Returns:
        The created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createXY

        IDataPointSet createXY(String pathAndTitle,                     double[] x,                     double[] y,                     double[] ex,                     double[] ey)                       throws IllegalArgumentException
        Create a two dimensional IDataPointSet providing the data.
        Parameters:
        pathAndTitle - The path of the IDataPointSet. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        x - The array of the x values
        y - The array of the y values
        ex - The array with the symmetric errors on x
        ey - The array with the symmetric errors on y
        Returns:
        The created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createXYZ

        IDataPointSet createXYZ(String path,                      String title,                      double[] x,                      double[] y,                      double[] z,                      double[] exp,                      double[] eyp,                      double[] ezp,                      double[] exm,                      double[] eym,                      double[] ezm)                        throws IllegalArgumentException
        Create a three dimensional IDataPointSet providing the data.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        title - The title of the IDataPointSet.
        x - The array of the x values
        y - The array of the y values
        z - The array of the z values
        exp - The array with the plus errors on x
        eyp - The array with the plus errors on y
        ezp - The array with the plus errors on z
        exm - The array with the minus errors on x
        eym - The array with the minus errors on y
        ezm - The array with the minus errors on z
        Returns:
        The created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createXYZ

        IDataPointSet createXYZ(String path,                      String title,                      double[] x,                      double[] y,                      double[] z,                      double[] ex,                      double[] ey,                      double[] ez)                        throws IllegalArgumentException
        Create a three dimensional IDataPointSet providing the data.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        title - The title of the IDataPointSet.
        x - The array of the x values
        y - The array of the y values
        z - The array of the z values
        ex - The array with the symmetric errors on x
        ey - The array with the symmetric errors on y
        ez - The array with the symmetric errors on z
        Returns:
        The created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createXYZ

        IDataPointSet createXYZ(String pathAndTitle,                      double[] x,                      double[] y,                      double[] z,                      double[] exp,                      double[] eyp,                      double[] ezp,                      double[] exm,                      double[] eym,                      double[] ezm)                        throws IllegalArgumentException
        Create a two dimensional IDataPointSet providing the data.
        Parameters:
        pathAndTitle - The path of the IDataPointSet. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        x - The array of the x values
        y - The array of the y values
        z - The array of the z values
        exp - The array with the plus errors on x
        eyp - The array with the plus errors on y
        ezp - The array with the plus errors on z
        exm - The array with the minus errors on x
        eym - The array with the minus errors on y
        ezm - The array with the minus errors on z
        Returns:
        The created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createXYZ

        IDataPointSet createXYZ(String pathAndTitle,                      double[] x,                      double[] y,                      double[] z,                      double[] ex,                      double[] ey,                      double[] ez)                        throws IllegalArgumentException
        Create a two dimensional IDataPointSet providing the data.
        Parameters:
        pathAndTitle - The path of the IDataPointSet. The path can either be a relative or full path. The last part of the path is used as the title. ("/folder1/folder2/dataTitle" and "../folder/dataTitle" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        x - The array of the x values
        y - The array of the y values
        z - The array of the z values
        exp - The array with the symmetric errors on x
        eyp - The array with the symmetric errors on y
        ezp - The array with the symmetric errors on z
        Returns:
        The created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • createCopy

        IDataPointSet createCopy(String path,                       IDataPointSet dataPointSet)                         throws IllegalArgumentException
        Make a copy of a given IDataPointSet.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        dataPointSet - The IDataPointSet to be copied.
        Returns:
        The copy of the given IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   IHistogram1D hist)                     throws IllegalArgumentException
        Create an IDataPointSet from an IHistogram1D.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        hist - The IHistogram1D from which the data is taken. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   IHistogram1D hist,                   String options)                     throws IllegalArgumentException
        Create an IDataPointSet from an IHistogram1D.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        hist - The IHistogram1D from which the data is taken.
        options - Options, currently not specified. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   IHistogram2D hist)                     throws IllegalArgumentException
        Create an IDataPointSet from an IHistogram2D.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        hist - The IHistogram2D from which the data is taken. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   IHistogram2D hist,                   String options)                     throws IllegalArgumentException
        Create an IDataPointSet from an IHistogram2D.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        hist - The IHistogram2D from which the data is taken.
        options - Options, currently not specified. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   IHistogram3D hist)                     throws IllegalArgumentException
        Create an IDataPointSet from an IHistogram3D.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        hist - The IHistogram3D from which the data is taken. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   IHistogram3D hist,                   String options)                     throws IllegalArgumentException
        Create an IDataPointSet from an IHistogram3D.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        hist - The IHistogram3D from which the data is taken.
        options - Options, currently not specified. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   ICloud1D cloud)                     throws IllegalArgumentException
        Create an IDataPointSet from an ICloud1D.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        cloud - The ICloud1D from which the data is taken. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   ICloud1D cloud,                   String options)                     throws IllegalArgumentException
        Create an IDataPointSet from an ICloud1D.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        cloud - The ICloud1D from which the data is taken.
        options - Options, currently not specified. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   ICloud2D cloud)                     throws IllegalArgumentException
        Create an IDataPointSet from an ICloud2D.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        cloud - The ICloud2D from which the data is taken. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   ICloud2D cloud,                   String options)                     throws IllegalArgumentException
        Create an IDataPointSet from an ICloud2D.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        cloud - The ICloud2D from which the data is taken.
        options - Options, currently not specified Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   ICloud3D cloud)                     throws IllegalArgumentException
        Create an IDataPointSet from an ICloud3D.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        cloud - The ICloud3D from which the data is taken. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   ICloud3D cloud,                   String options)                     throws IllegalArgumentException
        Create an IDataPointSet from an ICloud3D.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        cloud - The ICloud3D from which the data is taken.
        options - Options, currently not specified. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   IProfile1D profile)                     throws IllegalArgumentException
        Create an IDataPointSet from an IProfile1D.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        profile - The IProfile1D from which the data is taken. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   IProfile1D profile,                   String options)                     throws IllegalArgumentException
        Create an IDataPointSet from an IProfile1D.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        profile - The IProfile1D from which the data is taken.
        options - Options, currently not specified. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   IProfile2D profile)                     throws IllegalArgumentException
        Create an IDataPointSet from an IProfile2D.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        profile - The IProfile2D from which the data is taken. Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • create

        IDataPointSet create(String path,                   IProfile2D profile,                   String options)                     throws IllegalArgumentException
        Create an IDataPointSet from an IProfile2D.
        Parameters:
        path - The path of the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        profile - The IProfile2D from which the data is taken.
        options - Options, currently not specified. The default is "". Options string must consist of series of parameters or key-value pairs that are separated by comma or semicolon ( "," or ";" ), white spaces are disregarded and will be trimmed away during parsing. Key-value pairs must be in a form: key=value, or key="value" (for values that contain spaces, commas, or other special characters). Single parameters may be converted to a parameter=true pair during parsing, like "verbose" -> "verbose=true". Any key that starts with "annotation." will be stripped of this prefix and put into annotation of newly created AIDA object.
        Returns:
        The newly created IDataPointSet.
        Throws:
        IllegalArgumentException - if a directory in the path does not exist, or the path is illegal.
      • add

        IDataPointSet add(String path,                IDataPointSet dataPointSet1,                IDataPointSet dataPointSet2)                  throws IllegalArgumentException
        Add two IDataSetPoint, point by point and measurement by measurement.
        Parameters:
        path - The path of resulting the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        dataPointSet1 - The first member of the addition.
        dataPointSet2 - The second member of the addition.
        Throws:
        IllegalArgumentException - if the two IDataPointSet to be added have different dimensions and/or sizes, or if a directory in the path does not exist, or the path is illegal.
      • subtract

        IDataPointSet subtract(String path,                     IDataPointSet dataPointSet1,                     IDataPointSet dataPointSet2)                       throws IllegalArgumentException
        Subtract two IDataSetPoint, point by point and measurement by measurement.
        Parameters:
        path - The path of the resulting IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        dataPointSet1 - The first member of the subtraction.
        dataPointSet2 - The second member of the subtraction. uncorrelated Gaussian error propagation.
        Throws:
        IllegalArgumentException - if the two IDataPointSet to be subtracted have different dimensions and/or sizes, or if a directory in the path does not exist, or the path is illegal.
      • multiply

        IDataPointSet multiply(String path,                     IDataPointSet dataPointSet1,                     IDataPointSet dataPointSet2)                       throws IllegalArgumentException
        Multiply two IDataSetPoint, point by point and measurement by measurement.
        Parameters:
        path - The path of the resulting IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        dataPointSet1 - The first member of the multiplication.
        dataPointSet2 - The second member of the multiplication. uncorrelated Gaussian error propagation.
        Throws:
        IllegalArgumentException - if the two IDataPointSet to be multiplied have different dimensions and/or sizes, or if a directory in the path does not exist, or the path is illegal.
      • divide

        IDataPointSet divide(String path,                   IDataPointSet dataPointSet1,                   IDataPointSet dataPointSet2)                     throws IllegalArgumentException
        Divide two IDataSetPoint, point by point and measurement by measurement.
        Parameters:
        path - The path of resulting the IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        dataPointSet1 - The first member of the division.
        dataPointSet2 - The second member of the division. uncorrelated Gaussian error propagation.
        Throws:
        IllegalArgumentException - if the two IDataPointSet to be divided have different dimensions and/or sizes, or if a directory in the path does not exist, or the path is illegal.
      • weightedMean

        IDataPointSet weightedMean(String path,                         IDataPointSet dataPointSet1,                         IDataPointSet dataPointSet2)                           throws IllegalArgumentException
        Calculate weighted means of two IDataSetPoint, point by point and measurement by measurement.
        Parameters:
        path - The path of the resulting IDataPointSet. The path can either be a relative or full path. ("/folder1/folder2/dataName" and "../folder/dataName" are valid paths). All the directories in the path must exist. The characther `/` cannot be used in names; it is only used to delimit directories within paths.
        dataPointSet1 - The first IDataPointSet.
        dataPointSet2 - The second IDataPointSet. uncorrelated Gaussian error propagation.
        Throws:
        IllegalArgumentException - if the two IDataPointSet have different dimensions and/or sizes, or if a directory in the path does not exist, or the path is illegal.

SCaVis 2.2 © jWork.ORG