Package de.gsi.dataset.spi

Enum AbstractHistogram.HistogramOuterBounds

java.lang.Object

java.lang.Enum<AbstractHistogram.HistogramOuterBounds>

de.gsi.dataset.spi.AbstractHistogram.HistogramOuterBounds

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AbstractHistogram.HistogramOuterBounds>

Enclosing class:

AbstractHistogram

public static enum AbstractHistogram.HistogramOuterBounds
extends java.lang.Enum<AbstractHistogram.HistogramOuterBounds>

Defines how the lower and upper bound of equidistant Histograms should be treated

Enum Constant Summary

Enum Constants

Enum Constant	Description
BINS_ALIGNED_WITH_BOUNDARY	The min and max value defines the outer bounds of the bins
BINS_CENTERED_ON_BOUNDARY	The min and max value defines the center of the bins

Method Summary

Modifier and Type	Method	Description
static AbstractHistogram.HistogramOuterBounds	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static AbstractHistogram.HistogramOuterBounds[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BINS_CENTERED_ON_BOUNDARY

public static final AbstractHistogram.HistogramOuterBounds BINS_CENTERED_ON_BOUNDARY

The min and max value defines the center of the bins

     nBins = 3
     ^      ___
     |  ___|   |
     | |   |   |___
     |_|___|___|___|____
         '       '
        min     max
 

BINS_ALIGNED_WITH_BOUNDARY

public static final AbstractHistogram.HistogramOuterBounds BINS_ALIGNED_WITH_BOUNDARY

The min and max value defines the outer bounds of the bins

     nBins = 3
     ^       __
     |    __|  |
     |   |  |  |__
     |___|__|__|__|____
         '        '
        min      max
 

Method Detail

values

public static AbstractHistogram.HistogramOuterBounds[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AbstractHistogram.HistogramOuterBounds c : AbstractHistogram.HistogramOuterBounds.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AbstractHistogram.HistogramOuterBounds valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null