object Bin extends Factory
Split a quantity into equally spaced bins between a low and high threshold and fill exactly one bin per datum.
When composed with org.dianahep.histogrammar.Count, this produces a standard histogram:
Bin.ing(100, 0, 10, fill_x, Count.ing())
and when nested, it produces a two-dimensional histogram:
Bin.ing(100, 0, 10, fill_x, Bin.ing(100, 0, 10, fill_y, Count.ing()))
Combining with org.dianahep.histogrammar.Deviate produces a physicist's "profile plot:"
Bin.ing(100, 0, 10, fill_x, Deviate.ing(fill_y))
and so on.
Factory produces mutable org.dianahep.histogrammar.Binning and immutable org.dianahep.histogrammar.Binned objects.
- Alphabetic
- By Inheritance
- Bin
- 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 }, U <: Container[U] with Aggregation { type Datum >: DATUM }, O <: Container[O] with Aggregation { type Datum >: DATUM }, N <: Container[N] with Aggregation { type Datum >: DATUM }](num: Int, low: Double, high: Double, quantity: UserFcn[DATUM, Double], value: => V = Count(), underflow: U = Count(), overflow: O = Count(), nanflow: N = Count()): Binning[DATUM, V, U, O, N]
Create an empty, mutable org.dianahep.histogrammar.Binning.
Create an empty, mutable org.dianahep.histogrammar.Binning.
- low
Minimum-value edge of the first bin.
- high
Maximum-value edge of the last bin.
- quantity
Numerical function to split into bins.
- value
Template used to create zero values (by calling this
value'szeromethod).- underflow
Container for data below the first bin.
- overflow
Container for data above the last bin.
- nanflow
Container for data that resulted in
NaN.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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, U <: Container[U] with NoAggregation, O <: Container[O] with NoAggregation, N <: Container[N] with NoAggregation](low: Double, high: Double, entries: Double, values: Seq[V], underflow: U, overflow: O, nanflow: N): Binned[V, U, O, N]
Create an immutable org.dianahep.histogrammar.Binned from arguments (instead of JSON).
Create an immutable org.dianahep.histogrammar.Binned from arguments (instead of JSON).
- low
Minimum-value edge of the first bin.
- high
Maximum-value edge of the last bin.
- entries
Weighted number of entries (sum of all observed weights).
- values
Containers for data sent to each bin.
- underflow
Container for data below the first bin.
- overflow
Container for data above the last bin.
- nanflow
Container for data that resulted in
NaN.
- 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 }, U <: Container[U] with Aggregation { type Datum >: DATUM }, O <: Container[O] with Aggregation { type Datum >: DATUM }, N <: Container[N] with Aggregation { type Datum >: DATUM }](num: Int, low: Double, high: Double, quantity: UserFcn[DATUM, Double], value: => V = Count(), underflow: U = Count(), overflow: O = Count(), nanflow: N = Count()): Binning[DATUM, V, U, O, N]
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)