All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class hep.analysis.AutoPartition

java.lang.Object
   |
   +----java.util.Observable
           |
           +----hep.analysis.Partition
                   |
                   +----hep.analysis.Abstract1DPartition
                           |
                           +----hep.analysis.AutoPartition

public class AutoPartition
extends Abstract1DPartition

At first, an automatic partition acts like a simple partition, filling within any range. After a fixed number of entries, the partition fixes a range and bins within that range.

AutoPartition()

Creates an automatic partition, using automatic range and the default values:

auto binning cutoff = 2000
number of bins = 50

AutoPartition(double, double)

Creates an automatic partition, using a given range with the default values:

auto binning cutoff = 2000
number of bins = 50

When the binning cutoff is reached, the given range will be used unless setBinning(int, double, double) is called.

AutoPartition(int, int)

Created an automatic partition, with automatic range and the given values for the auto binning cutoff and number of bins.

AutoPartition(int, int, double, double)

Created an automatic partition, with the given range and the given values for the auto binning cutoff and number of bins.

clear(): Resets the partition to default settings.
fill(double): Invokes the fill(double, double) method with a weighting value of 1.
fill(double, double): Fills the associated histogram with a numerical value.
getArea(): Return the area of the distribution.
getBinAt(double): Returns the bin index corresponding to the given numerical value.
getBins(): Return an array containing the sizes of all the bins.
getEntries(): Return the number of entries.
getErrors(): Return an array containing the errors for all the bins.
getMax(): Return the maximum in the distribution.
getMean(): Return the mean of the distribution.
getMin(): Return the minimum in the distribution.
getNumberOfBins(): Return the number of bins.
getOverflow(): Return the overflow for the partition.
getRMS(): Return the RMS of the distribution.
getStatistics()
getUnderflow(): Return the underflow for the partition.
hasSimpleQuadraticErrorBars(): Returns false by default.
isRebinnable(): Returns false by default.
newComplexEntry()
newSimpleEntry()
setBinning(int, double, double): Override to allow binning to be set.
setSnapshot(boolean): Sets the snap shot mode of the partition.

AutoPartition

 public AutoPartition()

Creates an automatic partition, using automatic range and the default values:

auto binning cutoff = 2000
number of bins = 50

AutoPartition

 public AutoPartition(int autoCutoff,
                      int nBins)

Created an automatic partition, with automatic range and the given values for the auto binning cutoff and number of bins.

Parameters:: autoCutoff - after this many entries, the partition will fix a range and always bin within that range (value must be greater than zero); nBins - the partition will use this many bins (value must be greater than zero)
Throws: IllegalArgumentException: if autoCutoff <= 0 or if nBins <= 0

AutoPartition

 public AutoPartition(double min,
                      double max)

Creates an automatic partition, using a given range with the default values:

auto binning cutoff = 2000
number of bins = 50

When the binning cutoff is reached, the given range will be used unless setBinning(int, double, double) is called.

Parameters:: min - the initial minimum for the range (will change if setBinning(int, double, double) is called); max - the initial maximum for the range (will change if setBinning(int, double, double) is called)
See Also:: setBinning

AutoPartition

 public AutoPartition(int autoCutoff,
                      int nBins,
                      double min,
                      double max)

Created an automatic partition, with the given range and the given values for the auto binning cutoff and number of bins. When the binning cutoff is reached, the given range will be used unless setBinning(int, double, double) is called.

Parameters:: autoCutoff - after this many entries, the partition will fix a range and always bin within that range (value must be greater than zero); nBins - the partition will use this many bins (value must be greater than zero); min - the initial minimum for the range (will change if setBinning(int, double, double) is called); max - the initial maximum for the range (will change if setBinning(int, double, double) is called)
Throws: IllegalArgumentException: if autoCutoff <= 0 or if nBins <= 0
See Also:: setBinning

setSnapshot

 public void setSnapshot(boolean useSnapShot)

Sets the snap shot mode of the partition.

Overrides:: setSnapshot in class Abstract1DPartition

newSimpleEntry

 protected final void newSimpleEntry()

newComplexEntry

 protected final void newComplexEntry()

fill

 public final void fill(double x)

Invokes the fill(double, double) method with a weighting value of 1.

Overrides:: fill in class Abstract1DPartition

fill

 public final void fill(double x,
                        double v)

Fills the associated histogram with a numerical value.

Overrides:: fill in class Abstract1DPartition

setBinning

 public final void setBinning(int bins,
                              double min,
                              double max)

Override to allow binning to be set.

Overrides:: setBinning in class Abstract1DPartition

isRebinnable

 public final boolean isRebinnable()

Returns false by default.

Overrides:: isRebinnable in class Abstract1DPartition

getStatistics

 public final Statistics getStatistics()

clear

 public final void clear()

Resets the partition to default settings.

Overrides:: clear in class Abstract1DPartition

getBinAt

 public final int getBinAt(double x) throws NoSuchBinException

Returns the bin index corresponding to the given numerical value.

Overrides:: getBinAt in class Abstract1DPartition

getBins

 public final double[] getBins()

Return an array containing the sizes of all the bins.

Overrides:: getBins in class Abstract1DPartition

getErrors

 protected final double[] getErrors()

Return an array containing the errors for all the bins.

Overrides:: getErrors in class Abstract1DPartition

getOverflow

 public final double getOverflow()

Return the overflow for the partition.

Overrides:: getOverflow in class Abstract1DPartition

getUnderflow

 public final double getUnderflow()

Return the underflow for the partition.

Overrides:: getUnderflow in class Abstract1DPartition

getEntries

 public final int getEntries()

Return the number of entries.

Overrides:: getEntries in class Abstract1DPartition

getArea

 public final double getArea()

Return the area of the distribution.

Overrides:: getArea in class Abstract1DPartition

getMean

 public final double getMean()

Return the mean of the distribution.

Overrides:: getMean in class Abstract1DPartition

getRMS

 public final double getRMS()

Return the RMS of the distribution.

Overrides:: getRMS in class Abstract1DPartition

getMin

 public final double getMin()

Return the minimum in the distribution.

Overrides:: getMin in class Abstract1DPartition

getMax

 public final double getMax()

Return the maximum in the distribution.

Overrides:: getMax in class Abstract1DPartition

hasSimpleQuadraticErrorBars

 public final boolean hasSimpleQuadraticErrorBars()

Returns false by default.

Overrides:: hasSimpleQuadraticErrorBars in class Abstract1DPartition

getNumberOfBins

 public final int getNumberOfBins()

Return the number of bins.

Overrides:: getNumberOfBins in class Abstract1DPartition

All Packages  Class Hierarchy  This Package  Previous  Next  Index