|
FreeHEP API Version 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
User level interface to a 1D Cloud.
Method Summary | |
void |
convert(double[] binEdges)
Convert internally the ICloud1D to an IHistogram1D with given bin edges. |
void |
convert(int nBins,
double lowerEdge,
double upperEdge)
Convert internally the ICloud1D to an IHistogram1D with given number of bins, upper edge and lower edge. |
void |
fill(double x)
Fill the ICloud1D with a value and a corresponding weight. |
void |
fill(double x,
double weight)
Fill the ICloud1D with a value and a corresponding weight. |
void |
fillHistogram(IHistogram1D hist)
Project the ICloud1D on an IHistogram1D. |
IHistogram1D |
histogram()
Get the internal IHistogram1D in which the ICloud1D converted to. |
double |
lowerEdge()
Get the lower edge of the ICloud1D. |
double |
mean()
Get the mean of the ICloud1D. |
double |
rms()
Get the RMS of the ICloud1D. |
double |
upperEdge()
Get the upper edge of the ICloud1D. |
double |
value(int index)
Get the 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, scale, sumOfWeights |
Methods inherited from interface hep.aida.IBaseHistogram |
annotation, dimension, entries, reset, setTitle, title |
Method Detail |
public void fill(double x) throws IllegalArgumentException
x
- The value.
IllegalArgumentException
- If the ICloud1D is full, if the weight's value is
is not between 0 and 1.public void fill(double x, double weight) throws IllegalArgumentException
x
- The value.weight
- The corresponding weight. By default it is 1.
IllegalArgumentException
- If the ICloud1D is full, if the weight's value is
is not between 0 and 1.public double lowerEdge()
public double upperEdge()
public double value(int index) throws AlreadyConvertedException
index
- The entry's index.
AlreadyConvertedException
- If the ICloud1D has already been converted.public double weight(int index) throws AlreadyConvertedException
index
- The entry's index.
AlreadyConvertedException
- If the ICloud has already been converted.public double mean()
public double rms()
public void convert(int nBins, double lowerEdge, double upperEdge) throws AlreadyConvertedException
nBins
- The number of bins.lowerEdge
- The lower edge.upperEdge
- The upper edge.
AlreadyConvertedException
- If the ICloud1D has already been converted.public void convert(double[] binEdges) throws AlreadyConvertedException
binEdges
- The bins edges.
AlreadyConvertedException
- If the ICloud1D has already been converted.public IHistogram1D histogram() throws RuntimeException
RuntimeException
- If the ICloud1D did not convert either automatically
or because of a convert() method invocation.public void fillHistogram(IHistogram1D hist) throws RuntimeException
hist
- The IHistogram1D to be filled.
RuntimeException
- If the ICloud1D is already converted.
|
FreeHEP API Version 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |