hep.aida
Interface IDataPointSetFactory

public interface IDataPointSetFactory

Basic user-level interface for creating a factory of IDataPointSet.

Author:

The AIDA team (http://aida.freehep.org/)

Method Summary

IDataPointSet	add(String name, IDataPointSet dataPointSet1, IDataPointSet dataPointSet2) Add two IDataSetPoint, point by point and measurement by measurement.
IDataPointSet	create(String name, ICloud1D cloud) Create an IDataPointSet from an ICloud1D.
IDataPointSet	create(String name, ICloud2D cloud) Create an IDataPointSet from an ICloud2D.
IDataPointSet	create(String name, ICloud3D cloud) Create an IDataPointSet from an ICloud3D.
IDataPointSet	create(String name, IHistogram1D hist) Create an IDataPointSet from an IHistogram1D.
IDataPointSet	create(String name, IHistogram2D hist) Create an IDataPointSet from an IHistogram2D.
IDataPointSet	create(String name, IHistogram3D hist) Create an IDataPointSet from an IHistogram3D.
IDataPointSet	create(String nameAndTitle, int dimOfPoints) Create an empty IDataPointSet.
IDataPointSet	create(String name, IProfile1D profile) Create an IDataPointSet from an IProfile1D.
IDataPointSet	create(String name, IProfile2D profile) Create an IDataPointSet from an IProfile2D.
IDataPointSet	create(String name, String title, int dimOfPoints) Create an empty IDataPointSet.
IDataPointSet	createCopy(String name, IDataPointSet dataPointSet) Make a copy of a given IDataPointSet.
void	destroy(IDataPointSet dataPointSet) Destroy a given IDataPointSet.
IDataPointSet	divide(String name, IDataPointSet dataPointSet1, IDataPointSet dataPointSet2) Divide two IDataSetPoint, point by point and measurement by measurement.
IDataPointSet	multiply(String name, IDataPointSet dataPointSet1, IDataPointSet dataPointSet2) Multiply two IDataSetPoint, point by point and measurement by measurement.
IDataPointSet	subtract(String name, IDataPointSet dataPointSet1, IDataPointSet dataPointSet2) Subtract two IDataSetPoint, point by point and measurement by measurement.
IDataPointSet	weightedMean(String name, IDataPointSet dataPointSet1, IDataPointSet dataPointSet2) Calculate weighted means of two IDataSetPoint, point by point and measurement by measurement.

Method Detail

create

public IDataPointSet create(String name,
                            String title,
                            int dimOfPoints)

Create an empty IDataPointSet.

Parameters:

name - The name of the IDataPointSet.

title - The title of the IDataPointSet.

dimOfPoints - The dimension of the IDataPoints that can be stored in the set.

Returns:

The newly created IDataPointSet.

create

public IDataPointSet create(String nameAndTitle,
                            int dimOfPoints)

Create an empty IDataPointSet.

Parameters:

nameAndTitle - The name and the title of the IDataPointSet.

dimOfPoints - The dimension of the IDataPoints that can be stored in the set.

Returns:

The newly created IDataPointSet.

createCopy

public IDataPointSet createCopy(String name,
                                IDataPointSet dataPointSet)

Make a copy of a given IDataPointSet.

Parameters:

name - The name of the copy IDataPointSet.

dataPointSet - The IDataPointSet to be copied.

Returns:

The copy of the given IDataPointSet.

destroy

public void destroy(IDataPointSet dataPointSet)
             throws IllegalArgumentException

Destroy a given IDataPointSet.

Parameters:

dataPointSet - The IDataPointSet to be destroyed.

Throws:

IllegalArgumentException - If dataPointSet cannot be destroyed.

create

public IDataPointSet create(String name,
                            IHistogram1D hist)

Create an IDataPointSet from an IHistogram1D.

Parameters:

name - The name of the IDataPointSet.

hist - The IHistogram1D from which the data is taken.

Returns:

The newly created IDataPointSet.

create

public IDataPointSet create(String name,
                            IHistogram2D hist)

Create an IDataPointSet from an IHistogram2D.

Parameters:

name - The name of the IDataPointSet.

hist - The IHistogram2D from which the data is taken.

Returns:

The newly created IDataPointSet.

create

public IDataPointSet create(String name,
                            IHistogram3D hist)

Create an IDataPointSet from an IHistogram3D.

Parameters:

name - The name of the IDataPointSet.

hist - The IHistogram3D from which the data is taken.

Returns:

The newly created IDataPointSet.

create

public IDataPointSet create(String name,
                            ICloud1D cloud)

Create an IDataPointSet from an ICloud1D.

Parameters:

name - The name of the IDataPointSet.

cloud - The ICloud1D from which the data is taken.

Returns:

The newly created IDataPointSet.

create

public IDataPointSet create(String name,
                            ICloud2D cloud)

Create an IDataPointSet from an ICloud2D.

Parameters:

name - The name of the IDataPointSet.

cloud - The ICloud2D from which the data is taken.

Returns:

The newly created IDataPointSet.

create

public IDataPointSet create(String name,
                            ICloud3D cloud)

Create an IDataPointSet from an ICloud3D.

Parameters:

name - The name of the IDataPointSet.

cloud - The ICloud3D from which the data is taken.

Returns:

The newly created IDataPointSet.

create

public IDataPointSet create(String name,
                            IProfile1D profile)

Create an IDataPointSet from an IProfile1D.

Parameters:

name - The name of the IDataPointSet.

profile - The IProfile1D from which the data is taken.

Returns:

The newly created IDataPointSet.

create

public IDataPointSet create(String name,
                            IProfile2D profile)

Create an IDataPointSet from an IProfile2D.

Parameters:

name - The name of the IDataPointSet.

profile - The IProfile2D from which the data is taken.

Returns:

The newly created IDataPointSet.

add

public IDataPointSet add(String name,
                         IDataPointSet dataPointSet1,
                         IDataPointSet dataPointSet2)
                  throws IllegalArgumentException

Add two IDataSetPoint, point by point and measurement by measurement.

Parameters:

name - The name of the resulting IDataPointSet

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.

subtract

public IDataPointSet subtract(String name,
                              IDataPointSet dataPointSet1,
                              IDataPointSet dataPointSet2)
                       throws IllegalArgumentException

Subtract two IDataSetPoint, point by point and measurement by measurement.

Parameters:

name - The name of the resulting IDataPointSet

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.

multiply

public IDataPointSet multiply(String name,
                              IDataPointSet dataPointSet1,
                              IDataPointSet dataPointSet2)
                       throws IllegalArgumentException

Multiply two IDataSetPoint, point by point and measurement by measurement.

Parameters:

name - The name of the resulting IDataPointSet

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.

divide

public IDataPointSet divide(String name,
                            IDataPointSet dataPointSet1,
                            IDataPointSet dataPointSet2)
                     throws IllegalArgumentException

Divide two IDataSetPoint, point by point and measurement by measurement.

Parameters:

name - The name of the resulting IDataPointSet

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.

weightedMean

public IDataPointSet weightedMean(String name,
                                  IDataPointSet dataPointSet1,
                                  IDataPointSet dataPointSet2)
                           throws IllegalArgumentException

Calculate weighted means of two IDataSetPoint, point by point and measurement by measurement.

Parameters:

name - The name of the resulting IDataPointSet

dataPointSet1 - The first IDataPointSet.

dataPointSet2 - The second IDataPointSet. uncorrelated Gaussian error propagation.

Throws:

IllegalArgumentException - if the two IDataPointSet have different dimensions and/or sizes.