object Fraction extends Factory
Accumulate two aggregators, one containing only entries that pass a given selection (numerator) and another that contains all entries (denominator).
The aggregator may be a simple org.dianahep.histogrammar.Count to measure the efficiency of a cut, a org.dianahep.histogrammar.Bin to plot a turn-on curve, or anything else to be tested with and without a cut.
As a side effect of NaN values returning false for any comparison, a NaN return value from the selection is treated as a failed cut (the denominator is filled but the numerator is not).
Factory produces mutable org.dianahep.histogrammar.Fractioning and immutable org.dianahep.histogrammar.Fractioned objects.
- Alphabetic
- By Inheritance
- Fraction
- Factory
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply[DATUM, V <: Container[V] with Aggregation { type Datum >: DATUM }](quantity: UserFcn[DATUM, Double], value: => V = Count()): Fractioning[DATUM, V]
Create an empty, mutable org.dianahep.histogrammar.Fractioning.
Create an empty, mutable org.dianahep.histogrammar.Fractioning.
- value
Template used to create zero values (by calling this
value'szeromethod).
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def build[N <: Container[N], D <: Container[D]](numerator: N, denominator: D): Fractioned[N, D]
Alternate constructor for org.dianahep.histogrammar.Fractioned that builds from a pre-aggregated numerator and denominator.
Alternate constructor for org.dianahep.histogrammar.Fractioned that builds from a pre-aggregated numerator and denominator.
This could be used for any bin-by-bin ratio (or even a difference or other reduction), such as a data/Monte Caro ratio. The purpose of binding the histograms together like this is to verify that they have compatible bins and to provide access to existing methods for creating ratio plots from Fractioned objects.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- val detailedHelp: String
Help text that can be queried interactively: more detail than
help. - def ed[V <: Container[V] with NoAggregation](entries: Double, numerator: V, denominator: V): Fractioned[V, V]
Create an immutable org.dianahep.histogrammar.Fractioned from arguments (instead of JSON).
Create an immutable org.dianahep.histogrammar.Fractioned from arguments (instead of JSON).
- entries
Weighted number of entries (sum of all observed weights without the cut applied).
- numerator
Container for data that passed the given selection.
- denominator
Container for all data, regardless of whether it passed the given selection.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def fromJsonFragment(json: Json, nameFromParent: Option[String]): Container[_] with NoAggregation
Reconstructs a container of known type from JSON.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val help: String
Help text that can be queried interactively: a one-liner that can be included in a menu.
- def ing[DATUM, V <: Container[V] with Aggregation { type Datum >: DATUM }](quantity: UserFcn[DATUM, Double], value: => V = Count()): Fractioning[DATUM, V]
Synonym for
apply. - final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val name: String
Name of the concrete
Factoryas a string; used to label the container type in JSON. - final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)