org.dianahep.histogrammar

Stacking

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

Accumulating a suite of containers, each collecting data above a given cut on a given quantity.

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

Linear Supertypes
NumericalQuantity[DATUM], AnyQuantity[DATUM, Double], AggregationOnData, Aggregation, Container[Stacking[DATUM, V, N]], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Stacking
  2. NumericalQuantity
  3. AnyQuantity
  4. AggregationOnData
  5. Aggregation
  6. Container
  7. Serializable
  8. Serializable
  9. AnyRef
  10. 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
    StackingAggregation
  2. type EdType = Stacked[V.EdType, N.EdType]

    The type of the immutable version of this container.

    The type of the immutable version of this container.

    Definition Classes
    StackingContainer
  3. type Type = Stacking[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
    StackingContainer

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): Stacking[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
    StackingContainer
  5. def +(that: Stacking[DATUM, V, N]): Stacking[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
    StackingContainer
  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)]

    Lower thresholds and their associated containers, starting with negative infinity.

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

    Attributes
    protected
    Definition Classes
    Aggregation
  12. 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
  13. 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
    StackingContainer
  14. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. def copy: Stacking[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
  16. var entries: Double

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

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

    Definition Classes
    StackingContainer
  17. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. def equals(that: Any): Boolean

    Definition Classes
    Stacking → AnyRef → Any
  19. def factory: Stack.type

    Reference to the container's factory for runtime reflection.

    Reference to the container's factory for runtime reflection.

    Definition Classes
    StackingContainer
  20. 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
    StackingAggregation
  21. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  23. def hashCode(): Int

    Definition Classes
    Stacking → AnyRef → Any
  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  25. val nanflow: N

    Container for data that resulted in NaN.

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

    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  29. val quantity: UserFcn[DATUM, Double]

    Numerical quantity whose value is compared with the given thresholds.

    Numerical quantity whose value is compared with the given thresholds.

    Definition Classes
    StackingAnyQuantity
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  31. def thresholds: Seq[Double]

  32. def toImmutable: EdType

    Convert any Container into a NoAggregation Container.

    Convert any Container into a NoAggregation Container.

    Definition Classes
    Container
  33. 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
  34. def toJsonFile(fileName: String): Unit

    Definition Classes
    Container
  35. def toJsonFile(file: File): Unit

    Definition Classes
    Container
  36. 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
    StackingContainer
  37. def toJsonString: String

    Definition Classes
    Container
  38. def toString(): String

    Definition Classes
    Stacking → AnyRef → Any
  39. val v: V

    Attributes
    protected
  40. def values: Seq[V]

  41. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. def zero: Stacking[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
    StackingContainer

Inherited from NumericalQuantity[DATUM]

Inherited from AnyQuantity[DATUM, Double]

Inherited from AggregationOnData

Inherited from Aggregation

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

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped