|
FreeHEP API Version current |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object hep.aida.ref.event.AIDAObservable hep.aida.ref.ManagedObject hep.aida.ref.histogram.AbstractBaseHistogram hep.aida.ref.histogram.Cloud hep.aida.ref.histogram.Cloud1D
Field Summary | |
protected double |
sumOfWeights
|
Fields inherited from class hep.aida.ref.histogram.Cloud |
arraySize, CLOUD_ARRAY_ENTRIES, maxEntries, validEntries |
Fields inherited from class hep.aida.ref.ManagedObject |
fillable |
Fields inherited from class hep.aida.ref.event.AIDAObservable |
connectionDidChange, isConnected, isValid |
Constructor Summary | |
|
Cloud1D()
Create a new Cloud1D |
protected |
Cloud1D(String name,
String title,
int nMax,
String options)
Create a new Cloud1D |
Method Summary | |
int |
conversionBins()
|
double |
conversionLowerEdge()
|
double |
conversionUpperEdge()
|
void |
convert(double[] binEdges)
Convert the ICloud to an IHistogram by specifying the bin edges. |
void |
convert(int nBins,
double lowerEdge,
double upperEdge)
Convert the ICloud to an IHistogram. |
void |
convertToHistogram()
Convert the ICloud to an IHistogram using the default number of bins. |
int |
entries()
Get the Cloud's entries. |
void |
fill(double value)
Fill the Cloud with a new value with unit weight |
void |
fill(double value,
double weight)
Fill the Cloud with a new value with given weight |
void |
fillHistogram(hep.aida.IHistogram1D hist1d)
|
protected hep.aida.IHistogram |
hist()
|
hep.aida.IHistogram1D |
histogram()
Get the Histogram representing the Cloud |
boolean |
isConverted()
Has the Cloud been converted to a Histogram? |
double |
lowerEdge()
Get the Cloud's lower edge. |
double |
lowerEdgeWithMargin()
|
double |
mean()
Get the Cloud's mean. |
void |
reset()
Reset the histogram; as if just created. |
double |
rms()
Get the Cloud's rms. |
void |
scale(double scaleFactor)
Scale the weights by a given factor. |
void |
setConversionParameters(int bins,
double lowerEdge,
double upperEdge)
Set the parameters for the ICloud conversion to an IHistogram. |
void |
setHistogram(hep.aida.IHistogram1D hist)
Set the Histogram representation of the Cloud. |
void |
setLowerEdge(double lowerEdge)
Set the Cloud's lower edge |
void |
setUpperEdge(double upperEdge)
Set the Cloud's upper edge |
double |
sumOfWeights()
Get the sum of weights of of all the entries |
double |
upperEdge()
Get the Cloud's upper edge. |
double |
upperEdgeWithMargin()
|
double |
value(int index)
Get a given value from the Cloud. |
double |
weight(int index)
Get a given weight from the Cloud. |
Methods inherited from class hep.aida.ref.histogram.Cloud |
autoConvert, createEvent, getOptions, initCloud, margin, maxEntries, nanEntries |
Methods inherited from class hep.aida.ref.histogram.AbstractBaseHistogram |
annotation, dimension, setAnnotation, setTitle, title |
Methods inherited from class hep.aida.ref.ManagedObject |
isFillable, name, setFillable, setName, type |
Methods inherited from class hep.aida.ref.event.AIDAObservable |
addListener, fireStateChanged, fireStateChanged, fireStateChanged, isConnected, removeAllListeners, removeListener, setConnected, setIsValidAfterNotify, setValid, setValidForAll |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface hep.aida.ICloud |
maxEntries |
Methods inherited from interface hep.aida.IBaseHistogram |
annotation, dimension, nanEntries, setTitle, title |
Methods inherited from interface hep.aida.ref.event.IsObservable |
addListener, removeAllListeners, removeListener, setValid |
Methods inherited from interface hep.aida.ref.event.Connectable |
isConnected, setConnected |
Field Detail |
protected double sumOfWeights
Constructor Detail |
public Cloud1D()
protected Cloud1D(String name, String title, int nMax, String options)
name
- The Cloud's name.title
- The Cloud's title.nMax
- The maximum number of entries stored in the Cloud. If nMax is greater than zero the Cloud
will be converted to an Histogram when the number of entries is more than nMax.options
- Some options.Method Detail |
public void fill(double value)
fill
in interface hep.aida.ICloud1D
value
- The value to add to the Cloud.
true
if the fill was successful.public void fill(double value, double weight)
fill
in interface hep.aida.ICloud1D
value
- The value to add to the Cloud.weight
- The value's weight.
true
if the fill was successful.public double lowerEdge()
lowerEdge
in interface hep.aida.ICloud1D
public double upperEdge()
upperEdge
in interface hep.aida.ICloud1D
public void setUpperEdge(double upperEdge)
upperEdge
- The Cloud's upper edge.public void setLowerEdge(double lowerEdge)
lowerEdge
- The Cloud's lower edge.public double value(int index)
value
in interface hep.aida.ICloud1D
index
- The value's index.
RuntimeException
- if the Cloud has been convertedpublic double weight(int index)
weight
in interface hep.aida.ICloud1D
index
- The weight's index.
RuntimeException
- if the Cloud has been convertedpublic double mean()
mean
in interface hep.aida.ICloud1D
public double rms()
rms
in interface hep.aida.ICloud1D
public int entries()
entries
in interface hep.aida.IBaseHistogram
entries
in class AbstractBaseHistogram
public void convert(int nBins, double lowerEdge, double upperEdge)
convert
in interface hep.aida.ICloud1D
public void convert(double[] binEdges)
convert
in interface hep.aida.ICloud1D
public boolean isConverted()
isConverted
in interface hep.aida.ICloud
isConverted
in class Cloud
true<\code> if the Cloud has been converted to a Histogram.
public hep.aida.IHistogram1D histogram() throws RuntimeException
histogram
in interface hep.aida.ICloud1D
RuntimeException
- if the histogram is not auto-convertible and "convert"
has not been called.public void setHistogram(hep.aida.IHistogram1D hist)
hist
- The Histogram representing the Cloud.public void fillHistogram(hep.aida.IHistogram1D hist1d)
fillHistogram
in interface hep.aida.ICloud1D
public void reset()
Cloud
reset
in interface hep.aida.IBaseHistogram
reset
in class Cloud
public void convertToHistogram()
Cloud
convertToHistogram
in interface hep.aida.ICloud
convertToHistogram
in class Cloud
public void scale(double scaleFactor) throws IllegalArgumentException
Cloud
scale
in interface hep.aida.ICloud
scale
in class Cloud
scaleFactor
- The scale factor.
IllegalArgumentException
public double sumOfWeights()
sumOfWeights
in interface hep.aida.ICloud
sumOfWeights
in class Cloud
public double lowerEdgeWithMargin()
public double upperEdgeWithMargin()
protected hep.aida.IHistogram hist()
hist
in class Cloud
public void setConversionParameters(int bins, double lowerEdge, double upperEdge)
setConversionParameters
in interface hep.aida.ICloud1D
bins
- The number of bins of the conversion IHistogram.lowerEdge
- The lower edge of the conversion IHistogram.upperEdge
- The upper edge of the conversion IHistogram.public int conversionBins()
public double conversionLowerEdge()
public double conversionUpperEdge()
|
FreeHEP API Version current |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |