FreeHEP API
Version 3.2.1

## hep.aida Interface ICloud3D

All Superinterfaces:
IBaseHistogram, ICloud

public interface ICloud3D
extends ICloud

User level interface to a 3D Cloud.

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

 Method Summary ` void` ```convert(double[] binEdgesX, double[] binEdgesY, double[] binEdgesZ)```           Convert internally the ICloud3D to an IHistogram3D with given bin edges. ` void` ```convert(int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ)```           Convert internally the ICloud3D to an IHistogram3D with given number of bins, upper edge and lower edge. ` void` ```fill(double x, double y, double z)```           Fill the ICloud3D with a triplet of values and a corresponding weight. ` void` ```fill(double x, double y, double z, double weight)```           Fill the ICloud3D with a triplet of values and a corresponding weight. ` void` `fillHistogram(IHistogram3D hist)`           Project the ICloud3D on an IHistogram3D. ` IHistogram3D` `histogram()`           Get the internal IHistogram3D in which the ICloud3D converted to. ` double` `lowerEdgeX()`           Get the lower edge of the ICloud3D along the x axis. ` double` `lowerEdgeY()`           Get the lower edge of the ICloud3D along the y axis. ` double` `lowerEdgeZ()`           Get the lower edge of the ICloud3D along the z axis. ` double` `meanX()`           Get the mean of the ICloud3D along the x axis. ` double` `meanY()`           Get the mean of the ICloud3D along the y axis. ` double` `meanZ()`           Get the mean of the ICloud3D along the z axis. ` double` `rmsX()`           Get the RMS of the ICloud3D along the x axis. ` double` `rmsY()`           Get the RMS of the ICloud3D along the y axis. ` double` `rmsZ()`           Get the RMS of the ICloud3D along the z axis. ` double` `upperEdgeX()`           Get the upper edge of the ICloud3D along the x axis. ` double` `upperEdgeY()`           Get the upper edge of the ICloud3D along the y axis. ` double` `upperEdgeZ()`           Get the upper edge of the ICloud3D along the z axis. ` double` `valueX(int index)`           Get the x value corresponding to a given entry. ` double` `valueY(int index)`           Get the y value corresponding to a given entry. ` double` `valueZ(int index)`           Get the z value corresponding to a given entry. ` double` `weight(int index)`           Get the weight corresponding to a given entry.

 Methods inherited from interface hep.aida.ICloud `convertToHistogram, isConverted, maxEntries, scale, sumOfWeights`

 Methods inherited from interface hep.aida.IBaseHistogram `annotation, dimension, entries, reset, setTitle, title`

 Method Detail

### fill

```public void fill(double x,
double y,
double z)
throws IllegalArgumentException```
Fill the ICloud3D with a triplet of values and a corresponding weight.

Parameters:
`x` - The x value.
`y` - The y value.
`z` - The z value.
Throws:
`IllegalArgumentException` - If the ICloud3D is full, if the weight's value is is not between 0 and 1.

### fill

```public void fill(double x,
double y,
double z,
double weight)
throws IllegalArgumentException```
Fill the ICloud3D with a triplet of values and a corresponding weight.

Parameters:
`x` - The x value.
`y` - The y value.
`z` - The z value.
`weight` - The corresponding weight. By default it is 1.
Throws:
`IllegalArgumentException` - If the ICloud3D is full, if the weight's value is is not between 0 and 1.

### lowerEdgeX

`public double lowerEdgeX()`
Get the lower edge of the ICloud3D along the x axis.

Returns:
The lower edge along the x axis.

### lowerEdgeY

`public double lowerEdgeY()`
Get the lower edge of the ICloud3D along the y axis.

Returns:
The lower edge along the y axis.

### lowerEdgeZ

`public double lowerEdgeZ()`
Get the lower edge of the ICloud3D along the z axis.

Returns:
The lower edge along the z axis.

### upperEdgeX

`public double upperEdgeX()`
Get the upper edge of the ICloud3D along the x axis.

Returns:
The upper edge along the x axis.

### upperEdgeY

`public double upperEdgeY()`
Get the upper edge of the ICloud3D along the y axis.

Returns:
The upper edge along the y axis.

### upperEdgeZ

`public double upperEdgeZ()`
Get the upper edge of the ICloud3D along the z axis.

Returns:
The upper edge along the z axis.

### valueX

```public double valueX(int index)
Get the x value corresponding to a given entry.

Parameters:
`index` - The entry's index.
Returns:
The x value of the index-th entry.
Throws:
`AlreadyConvertedException` - If the ICloud3D has already been converted.

### valueY

```public double valueY(int index)
Get the y value corresponding to a given entry.

Parameters:
`index` - The entry's index.
Returns:
The y value of the index-th entry.
Throws:
`AlreadyConvertedException` - If the ICloud3D has already been converted.

### valueZ

```public double valueZ(int index)
Get the z value corresponding to a given entry.

Parameters:
`index` - The entry's index.
Returns:
The z value of the index-th entry.
Throws:
`AlreadyConvertedException` - If the ICloud3D has already been converted.

### weight

```public double weight(int index)
Get the weight corresponding to a given entry.

Parameters:
`index` - The entry's index.
Returns:
The weight of the index-th entry.
Throws:
`AlreadyConvertedException` - If the ICloud has already been converted.

### meanX

`public double meanX()`
Get the mean of the ICloud3D along the x axis.

Returns:
The mean along the x axis.

### meanY

`public double meanY()`
Get the mean of the ICloud3D along the y axis.

Returns:
The mean along the y axis.

### meanZ

`public double meanZ()`
Get the mean of the ICloud3D along the z axis.

Returns:
The mean along the z axis.

### rmsX

`public double rmsX()`
Get the RMS of the ICloud3D along the x axis.

Returns:
The RMS along the x axis.

### rmsY

`public double rmsY()`
Get the RMS of the ICloud3D along the y axis.

Returns:
The RMS along the y axis.

### rmsZ

`public double rmsZ()`
Get the RMS of the ICloud3D along the z axis.

Returns:
The RMS along the z axis.

### convert

```public void convert(int nBinsX,
double lowerEdgeX,
double upperEdgeX,
int nBinsY,
double lowerEdgeY,
double upperEdgeY,
int nBinsZ,
double lowerEdgeZ,
double upperEdgeZ)
Convert internally the ICloud3D to an IHistogram3D with given number of bins, upper edge and lower edge.

Parameters:
`nBinsX` - The number of bins of the x axis.
`lowerEdgeX` - The lower edge of bins of the x axis.
`upperEdgeX` - The upper edge of bins of the x axis.
`nBinsY` - The number of bins of the y axis.
`lowerEdgeY` - The lower edge of bins of the y axis.
`upperEdgeY` - The upper edge of bins of the y axis.
`nBinsZ` - The number of bins of the z axis.
`lowerEdgeZ` - The lower edge of bins of the z axis.
`upperEdgeZ` - The upper edge of bins of the z axis.
Throws:
`AlreadyConvertedException` - If the ICloud3D has already been converted.

### convert

```public void convert(double[] binEdgesX,
double[] binEdgesY,
double[] binEdgesZ)
Convert internally the ICloud3D to an IHistogram3D with given bin edges.

Parameters:
`binEdgesX` - The bins edges of the x axis.
`binEdgesY` - The bins edges of the y axis.
`binEdgesZ` - The bins edges of the z axis.
Throws:
`AlreadyConvertedException` - If the ICloud3D has already been converted.

### histogram

```public IHistogram3D histogram()
throws RuntimeException```
Get the internal IHistogram3D in which the ICloud3D converted to.

Returns:
The histogram.
Throws:
`RuntimeException` - If the ICloud3D did not convert either automatically or because of a convert() method invocation.

### fillHistogram

```public void fillHistogram(IHistogram3D hist)
throws RuntimeException```
Project the ICloud3D on an IHistogram3D.

Parameters:
`hist` - The IHistogram3D to be filled.
Throws:
`RuntimeException` - If the ICloud3D is already converted.

FreeHEP API
Version 3.2.1