hep.aida.ref.fitter.fitdata
Class FitData

java.lang.Object
  hep.aida.ref.fitter.fitdata.FitData

All Implemented Interfaces:

hep.aida.dev.IDevFitData, IFitData

public class FitData
extends Object
implements hep.aida.dev.IDevFitData

Constructor Summary

FitData()
Creates a new instance of FitData

Method Summary

void	create1DConnection(double[] x, double[] y, double[] corrMatrix) Create a one dimensional connection to a set of measurements with corresponding correlation matrix.
void	create1DConnection(ICloud1D cloud) Create a one dimensional connection to an ICloud1D.
void	create1DConnection(IDataPointSet dataPointSet, int xIndex, int valIndex) Create a one dimensional connection to an IDataPointSet.
void	create1DConnection(IHistogram1D hist) 1D connections.
void	create1DConnection(IProfile1D profile) Create a one dimensional connection to an IProfile1D.
void	create1DConnection(Object data)
void	create2DConnection(ICloud2D cloud) Create a two dimensional connection to an ICloud2D.
void	create2DConnection(ICloud2D cloud, int xIndex, int yIndex) Create a two dimensional connection to an ICloud2D.
void	create2DConnection(IDataPointSet dataPointSet, int xIndex, int yIndex, int valIndex) Create a two dimensional connection to an IDataPointSet.
void	create2DConnection(IHistogram2D hist) 2D connections.
void	create2DConnection(IHistogram2D hist, int xIndex, int yIndex) Create a two dimensional connection to an IHistogram2D.
void	create2DConnection(IProfile2D profile) Create a two dimensional connection to an IProfile2D.
void	create2DConnection(IProfile2D profile, int xIndex, int yIndex) Create a two dimensional connection to an IProfile2D.
void	create3DConnection(ICloud3D cloud) Create a three dimensional connection to an ICloud3D.
void	create3DConnection(ICloud3D cloud, int xIndex, int yIndex, int zIndex) Create a three dimensional connection to an ICloud3D.
void	create3DConnection(IDataPointSet dataPointSet, int xIndex, int yIndex, int zIndex, int valIndex) Create a three dimensional connection to an IDataPointSet.
void	create3DConnection(IHistogram3D hist) 3D connections.
void	create3DConnection(IHistogram3D hist, int xIndex, int yIndex, int zIndex) Create a three dimensional connection to an IHistogram3D.
void	createConnection(IDataPointSet dataPointSet, int[] indeces, int valIndex) Generic connections.
void	createConnection(ITuple tuple, IEvaluator[] evals) Create a connection to an ITuple.
void	createConnection(ITuple tuple, String[] colNames) Create a connection to an ITuple.
String	dataDescription()
hep.aida.dev.IDevFitDataIterator	dataIterator() Get the iterator on the data.
int	dimension() The dimension of this IFitData, i.e.
int	fitType() Get the type of fit this data is suitable for.
IRangeSet	range(int index) Get Range of the corresponding connection by index.
void	reset() Remove all Ranges and connections; after this is like newly create.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FitData

public FitData()

Creates a new instance of FitData

Method Detail

create1DConnection

public void create1DConnection(Object data)

create1DConnection

public void create1DConnection(IHistogram1D hist)
                        throws IllegalArgumentException

1D connections.

Specified by:

create1DConnection in interface IFitData

Parameters:

hist - The 1D histogram to which to connect to.

Throws:

IllegalArgumentException - If something is wrong.

create1DConnection

public void create1DConnection(IProfile1D profile)
                        throws IllegalArgumentException

Description copied from interface: IFitData

Create a one dimensional connection to an IProfile1D.

Specified by:

create1DConnection in interface IFitData

Parameters:

profile - The 1D profile to which to connect to.

Throws:

IllegalArgumentException - If something is wrong.

create1DConnection

public void create1DConnection(ICloud1D cloud)
                        throws IllegalArgumentException

Description copied from interface: IFitData

Create a one dimensional connection to an ICloud1D.

Specified by:

create1DConnection in interface IFitData

Parameters:

cloud - The 1D cloud to which to connect to.

Throws:

IllegalArgumentException - If something is wrong.

create1DConnection

public void create1DConnection(IDataPointSet dataPointSet,
                               int xIndex,
                               int valIndex)
                        throws IllegalArgumentException

Description copied from interface: IFitData

Create a one dimensional connection to an IDataPointSet.

Specified by:

create1DConnection in interface IFitData

Parameters:

dataPointSet - The dataPointSet to which to connect to.

xIndex - The index of the coordinate to which the variable is connected.

valIndex - The index of the coordinate used as "height".

Throws:

IllegalArgumentException - If something is wrong.

create1DConnection

public void create1DConnection(double[] x,
                               double[] y,
                               double[] corrMatrix)
                        throws IllegalArgumentException

Description copied from interface: IFitData

Create a one dimensional connection to a set of measurements with corresponding correlation matrix.

Specified by:

create1DConnection in interface IFitData

Parameters:

x - The x coordinate of the measurement.

y - The y coordinate of the measurement.

corrMatrix - The correlation matrix provided as a simple array. Please refer to the specific implementation's documentation on how to convert a matrix to a one dimensional array.

Throws:

IllegalArgumentException - If something is wrong (if the dimensions of the arrays are incompatible).

create2DConnection

public void create2DConnection(IHistogram2D hist)
                        throws IllegalArgumentException

2D connections.

Specified by:

create2DConnection in interface IFitData

Parameters:

hist - The 2D histogram to which to connect to.

Throws:

IllegalArgumentException - If something is wrong.

create2DConnection

public void create2DConnection(IHistogram2D hist,
                               int xIndex,
                               int yIndex)
                        throws IllegalArgumentException

Description copied from interface: IFitData

Create a two dimensional connection to an IHistogram2D.

Specified by:

create2DConnection in interface IFitData

Parameters:

hist - The 2D histogram to which to connect to.

xIndex - The index of the axis to which the x variable is connected.

yIndex - The index of the axis to which the y variable is connected.

Throws:

IllegalArgumentException - If something is wrong.

create2DConnection

public void create2DConnection(IProfile2D profile)
                        throws IllegalArgumentException

Description copied from interface: IFitData

Create a two dimensional connection to an IProfile2D.

Specified by:

create2DConnection in interface IFitData

Parameters:

profile - The 2D profile to which to connect to.

Throws:

IllegalArgumentException - If something is wrong.

create2DConnection

public void create2DConnection(IProfile2D profile,
                               int xIndex,
                               int yIndex)
                        throws IllegalArgumentException

Description copied from interface: IFitData

Create a two dimensional connection to an IProfile2D.

Specified by:

create2DConnection in interface IFitData

Parameters:

profile - The 2D profile to which to connect to.

xIndex - The index of the axis to which the x variable is connected.

yIndex - The index of the axis to which the y variable is connected.

Throws:

IllegalArgumentException - If something is wrong.

create2DConnection

public void create2DConnection(ICloud2D cloud)
                        throws IllegalArgumentException

Description copied from interface: IFitData

Create a two dimensional connection to an ICloud2D.

Specified by:

create2DConnection in interface IFitData

Parameters:

cloud - The 2D cloud to which to connect to.

Throws:

IllegalArgumentException - If something is wrong.

create2DConnection

public void create2DConnection(ICloud2D cloud,
                               int xIndex,
                               int yIndex)
                        throws IllegalArgumentException

Description copied from interface: IFitData

Create a two dimensional connection to an ICloud2D.

Specified by:

create2DConnection in interface IFitData

Parameters:

cloud - The 2D cloud to which to connect to.

xIndex - The index of the axis to which the x variable is connected.

yIndex - The index of the axis to which the y variable is connected.

Throws:

IllegalArgumentException - If something is wrong.

create2DConnection

public void create2DConnection(IDataPointSet dataPointSet,
                               int xIndex,
                               int yIndex,
                               int valIndex)
                        throws IllegalArgumentException

Description copied from interface: IFitData

Create a two dimensional connection to an IDataPointSet.

Specified by:

create2DConnection in interface IFitData

Parameters:

dataPointSet - The dataPointSet to which to connect to.

xIndex - The index of the coordinate to which the x variable is connected.

yIndex - The index of the coordinate to which the y variable is connected.

valIndex - The index of the coordinate used as "height".

Throws:

IllegalArgumentException - If something is wrong.

create3DConnection

public void create3DConnection(IHistogram3D hist)
                        throws IllegalArgumentException

3D connections.

Specified by:

create3DConnection in interface IFitData

Parameters:

hist - The 3D histogram to which to connect to.

Throws:

IllegalArgumentException - If something is wrong.

create3DConnection

public void create3DConnection(IHistogram3D hist,
                               int xIndex,
                               int yIndex,
                               int zIndex)
                        throws IllegalArgumentException

Description copied from interface: IFitData

Create a three dimensional connection to an IHistogram3D.

Specified by:

create3DConnection in interface IFitData

Parameters:

hist - The 3D histogram to which to connect to.

xIndex - The index of the axis to which the x variable is connected.

yIndex - The index of the axis to which the y variable is connected.

zIndex - The index of the axis to which the z variable is connected.

Throws:

IllegalArgumentException - If something is wrong.

create3DConnection

public void create3DConnection(ICloud3D cloud)
                        throws IllegalArgumentException

Description copied from interface: IFitData

Create a three dimensional connection to an ICloud3D.

Specified by:

create3DConnection in interface IFitData

Parameters:

cloud - The 3D cloud to which to connect to.

Throws:

IllegalArgumentException - If something is wrong.

create3DConnection

public void create3DConnection(ICloud3D cloud,
                               int xIndex,
                               int yIndex,
                               int zIndex)
                        throws IllegalArgumentException

Description copied from interface: IFitData

Create a three dimensional connection to an ICloud3D.

Specified by:

create3DConnection in interface IFitData

Parameters:

cloud - The 3D cloud to which to connect to.

xIndex - The index of the axis to which the x variable is connected.

yIndex - The index of the axis to which the y variable is connected.

zIndex - The index of the axis to which the z variable is connected.

Throws:

IllegalArgumentException - If something is wrong.

create3DConnection

public void create3DConnection(IDataPointSet dataPointSet,
                               int xIndex,
                               int yIndex,
                               int zIndex,
                               int valIndex)
                        throws IllegalArgumentException

Description copied from interface: IFitData

Create a three dimensional connection to an IDataPointSet.

Specified by:

create3DConnection in interface IFitData

Parameters:

dataPointSet - The dataPointSet to which to connect to.

xIndex - The index of the coordinate to which the x variable is connected.

yIndex - The index of the coordinate to which the y variable is connected.

zIndex - The index of the coordinate to which the z variable is connected.

valIndex - The index of the coordinate used as "height".

Throws:

IllegalArgumentException - If something is wrong.

createConnection

public void createConnection(IDataPointSet dataPointSet,
                             int[] indeces,
                             int valIndex)
                      throws IllegalArgumentException

Generic connections.

Specified by:

createConnection in interface IFitData

Parameters:

dataPointSet - The dataPointSet to which to connect to.

indeces - The indeces of the coordinates to which the variables are connected.

valIndex - The index of the coordinate used as "height".

Throws:

IllegalArgumentException - If something is wrong.

createConnection

public void createConnection(ITuple tuple,
                             IEvaluator[] evals)

Description copied from interface: IFitData

Create a connection to an ITuple.

Specified by:

createConnection in interface IFitData

Parameters:

tuple - The ITuple.

evals - The list of the IEvaluator used to calculate the variable's value.

createConnection

public void createConnection(ITuple tuple,
                             String[] colNames)

Description copied from interface: IFitData

Create a connection to an ITuple.

Specified by:

createConnection in interface IFitData

Parameters:

tuple - The ITuple.

colNames - The names of the columns to which to connect.

range

public IRangeSet range(int index)
                throws IllegalArgumentException

Description copied from interface: IFitData

Get Range of the corresponding connection by index. The index represent the order in which connections are coming out of the IFitData.

Specified by:

range in interface IFitData

Returns:

The Range

Throws:

IllegalArgumentException - If the Range does not exist.

dataIterator

public hep.aida.dev.IDevFitDataIterator dataIterator()

Description copied from interface: hep.aida.dev.IDevFitData

Get the iterator on the data.

Specified by:

dataIterator in interface hep.aida.dev.IDevFitData

Returns:

The iterator.

dimension

public int dimension()

Description copied from interface: IFitData

The dimension of this IFitData, i.e. the number of connections.

Specified by:

dimension in interface IFitData

Returns:

The dimension of the IFitData.

dataDescription

public String dataDescription()

Specified by:

dataDescription in interface IFitData

reset

public void reset()

Description copied from interface: IFitData

Remove all Ranges and connections; after this is like newly create.

Specified by:

reset in interface IFitData

fitType

public int fitType()

Description copied from interface: hep.aida.dev.IDevFitData

Get the type of fit this data is suitable for.

Specified by:

fitType in interface hep.aida.dev.IDevFitData

Returns:

The type fit. Either IDevFitter.BINNED_FIT or IDevFitter.UNBINNED_FIT.