Object

org.dianahep.histogrammar

Bin

Related Doc: package histogrammar

Permalink

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.

Linear Supertypes
Factory, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Bin
  2. Factory
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait Methods extends AnyRef

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. 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]

    Permalink

    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's zero method).

    underflow

    Container for data below the first bin.

    overflow

    Container for data above the last bin.

    nanflow

    Container for data that resulted in NaN.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val detailedHelp: String

    Permalink

    Help text that can be queried interactively: more detail than help.

    Help text that can be queried interactively: more detail than help. (FIXME: currently only contains the apply signature.)

    Definition Classes
    BinFactory
  8. 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]

    Permalink

    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.

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

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def fromJsonFragment(json: Json, nameFromParent: Option[String]): Container[_] with NoAggregation

    Permalink

    Reconstructs a container of known type from JSON.

    Reconstructs a container of known type from JSON. General users should call the Factory object's fromJson, which uses header data to identify the container type. (This is called by fromJson.)

    Definition Classes
    BinFactory
  13. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  15. val help: String

    Permalink

    Help text that can be queried interactively: a one-liner that can be included in a menu.

    Help text that can be queried interactively: a one-liner that can be included in a menu.

    Definition Classes
    BinFactory
  16. 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]

    Permalink

    Synonym for apply.

  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. val name: String

    Permalink

    Name of the concrete Factory as a string; used to label the container type in JSON.

    Name of the concrete Factory as a string; used to label the container type in JSON.

    Definition Classes
    BinFactory
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Factory

Inherited from AnyRef

Inherited from Any

Ungrouped