org.dianahep.histogrammar

CentrallyBinning

class CentrallyBinning[DATUM, V <: Container[V] with Aggregation { type Datum >: DATUM }, N <: Container[N] with Aggregation { type Datum >: DATUM }] extends Container[CentrallyBinning[DATUM, V, N]] with AggregationOnData with NumericalQuantity[DATUM] with Methods[V]

Accumulating a quantity by splitting it into bins defined by bin centers, filling only one datum per bin with no overflows or underflows.

Use the factory org.dianahep.histogrammar.CentrallyBin to construct an instance.

Linear Supertypes
Methods[V], NumericalQuantity[DATUM], AnyQuantity[DATUM, Double], AggregationOnData, Aggregation, Container[CentrallyBinning[DATUM, V, N]], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CentrallyBinning
  2. Methods
  3. NumericalQuantity
  4. AnyQuantity
  5. AggregationOnData
  6. Aggregation
  7. Container
  8. Serializable
  9. Serializable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type Datum = DATUM

    Type of data expected by fill.

    Type of data expected by fill.

    Definition Classes
    CentrallyBinning → Aggregation

  2. type EdType = CentrallyBinned[V.EdType, N.EdType]

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    CentrallyBinning → Container

  3. type Type = CentrallyBinning[DATUM, V, N]

    Intended for the general user to copy a complex container's type into the as method of a container whose type is not known at compile-time.

    Intended for the general user to copy a complex container's type into the as method of a container whose type is not known at compile-time.

    Typical use: filledHistogram.as[initialHistogram.Type]

    Definition Classes
    CentrallyBinning → Container

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def *(factor: Double): CentrallyBinning[DATUM, V, N]

    Reweight the contents in all nested aggregators by a scalar factor, as though they had been filled with a different weight.

    Reweight the contents in all nested aggregators by a scalar factor, as though they had been filled with a different weight.

    If the container is mutable (with org.dianahep.histogrammar.Aggregation), the new one will be, too.

    The original is unaffected.

    Definition Classes
    CentrallyBinning → Container

  5. def +(that: CentrallyBinning[DATUM, V, N]): CentrallyBinning[DATUM, V, N]

    Add two containers of the same type.

    Add two containers of the same type.

    If these containers are mutable (with org.dianahep.histogrammar.Aggregation), the new one will be, too.

    The originals are unaffected.

    Definition Classes
    CentrallyBinning → Container

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  8. def as[OTHER <: Container[OTHER]]: OTHER

    Cast the container to a given type.

    Cast the container to a given type. Especially useful for containers reconstructed from JSON or stored in org.dianahep.histogrammar.UntypedLabeling/org.dianahep.histogrammar.UntypedLabeled.

    Definition Classes
    Container

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. val bins: Seq[(Double, V)]

    Metric, sorted map of centers and values for each bin.

    Metric, sorted map of centers and values for each bin.

    Definition Classes
    CentrallyBinning → Methods

  11. def center(x: Double): Double

    Return the exact center of the bin that x belongs to.

    Return the exact center of the bin that x belongs to.

    Definition Classes
    Methods

  12. def centers: Seq[Double]

    Iterable over the centers of each bin.

    Iterable over the centers of each bin.

    Definition Classes
    Methods

  13. def centersSet: Set[Double]

    Set of centers of each bin.

    Set of centers of each bin.

    Definition Classes
    Methods

  14. def checkForCrossReferences(memo: Set[Aggregation] = mutable.Set[Aggregation]()): Unit

    Attributes
    protected
    Definition Classes
    Aggregation

  15. var checkedForCrossReferences: Boolean

    List of sub-aggregators, to make it possible to walk the tree.

    List of sub-aggregators, to make it possible to walk the tree.

    Attributes
    protected
    Definition Classes
    Aggregation

  16. def children: List[Container[_ >: V with N <: Container[_ >: V with N <: Serializable with Aggregation] with Aggregation { type Datum >: DATUM }] with Aggregation { type Datum >: DATUM }]

    List of sub-aggregators, to make it possible to walk the tree.

    List of sub-aggregators, to make it possible to walk the tree.

    Definition Classes
    CentrallyBinning → Container

  17. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  18. def copy: CentrallyBinning[DATUM, V, N]

    Copy this container, making a clone with no reference to the original.

    Copy this container, making a clone with no reference to the original.

    If these containers are mutable (with org.dianahep.histogrammar.Aggregation), the new one will be, too.

    Definition Classes
    Container

  19. var entries: Double

    Weighted number of entries (sum of all observed weights).

    Weighted number of entries (sum of all observed weights).

    Definition Classes
    CentrallyBinning → Methods → Container

  20. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  21. def equals(that: Any): Boolean

    Definition Classes
    CentrallyBinning → AnyRef → Any

  22. def factory: CentrallyBin.type

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    CentrallyBinning → Container

  23. def fill[SUB <: Datum](datum: SUB, weight: Double = 1.0): Unit

    Entry point for the general user to pass data into the container for aggregation.

    Entry point for the general user to pass data into the container for aggregation.

    Usually all containers in a collection of histograms take the same input data by passing it recursively through the tree. Quantities to plot are specified by the individual container's lambda functions.

    The container is changed in-place.

    Definition Classes
    CentrallyBinning → Aggregation

  24. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  25. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  26. def hashCode(): Int

    Definition Classes
    CentrallyBinning → AnyRef → Any

  27. def index(x: Double): Int

    Definition Classes
    Methods

  28. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  29. def nan(x: Double): Boolean

    Return true iff x is in the nanflow region (equal to NaN).

    Return true iff x is in the nanflow region (equal to NaN).

    Definition Classes
    Methods

  30. val nanflow: N

    Container for data that resulted in NaN.

  31. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  32. final def notify(): Unit

    Definition Classes
    AnyRef

  33. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  34. val quantity: UserFcn[DATUM, Double]

    Numerical function to track.

    Numerical function to track.

    Definition Classes
    CentrallyBinning → AnyQuantity

  35. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  36. def toImmutable: EdType

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

    Definition Classes
    Container

  37. def toJson: Json

    Convert this container to JSON (dropping its fill method, making it immutable).

    Convert this container to JSON (dropping its fill method, making it immutable).

    Note that the org.dianahep.histogrammar.json.Json object has a stringify method to serialize.

    Definition Classes
    Container

  38. def toJsonFile(fileName: String): Unit

    Definition Classes
    Container

  39. def toJsonFile(file: File): Unit

    Definition Classes
    Container

  40. def toJsonFragment(suppressName: Boolean): JsonObject

    Used internally to convert the container to JSON without its "type" header.

    Used internally to convert the container to JSON without its "type" header.

    Definition Classes
    CentrallyBinning → Container

  41. def toJsonString: String

    Definition Classes
    Container

  42. def toString(): String

    Definition Classes
    CentrallyBinning → AnyRef → Any

  43. val v: V

    Attributes
    protected

  44. def value(x: Double): V

    Return the aggregator at the center of the bin that x belongs to.

    Return the aggregator at the center of the bin that x belongs to.

    Definition Classes
    Methods

  45. def values: Seq[V]

    Iterable over the containers associated with each bin.

    Iterable over the containers associated with each bin.

    Definition Classes
    Methods

  46. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  47. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  48. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  49. def zero: CentrallyBinning[DATUM, V, N]

    Create an empty container with the same parameters as this one.

    Create an empty container with the same parameters as this one.

    If this container is mutable (with org.dianahep.histogrammar.Aggregation), the new one will be, too.

    The original is unaffected.

    Definition Classes
    CentrallyBinning → Container

Inherited from Methods[V]

Inherited from NumericalQuantity[DATUM]

Inherited from AnyQuantity[DATUM, Double]

Inherited from AggregationOnData

Inherited from Aggregation

Inherited from Container[CentrallyBinning[DATUM, V, N]]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped