Packages

object Select extends Factory

Filter or weight data according to a given selection.

This primitive is a basic building block, intended to be used in conjunction with anything that needs a user-defined cut. In particular, a standard histogram often has a custom selection, and this can be built by nesting Select -> Bin -> Count.

Select also resembles org.dianahep.histogrammar.Fraction, but without the denominator.

The efficiency of a cut in a Select aggregator named x is simply x.cut.entries / x.entries (because all aggregators have an entries member).

Factory produces mutable org.dianahep.histogrammar.Selecting and immutable org.dianahep.histogrammar.Selected (sic) objects.

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

Type Members

  1. trait Methods extends AnyRef

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply[DATUM, V <: Container[V] with Aggregation { type Datum >: DATUM }](quantity: UserFcn[DATUM, Double], cut: V = Count()): Selecting[DATUM, V]

    Create an empty, mutable org.dianahep.histogrammar.Selecting.

    Create an empty, mutable org.dianahep.histogrammar.Selecting.

    quantity

    Boolean or non-negative function that cuts or weights entries.

    cut

    Aggregator to accumulate for values that pass the selection (quantity).

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. val detailedHelp: String

    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
    Select → Factory
  8. def ed[V <: Container[V] with NoAggregation](entries: Double, cut: V): Selected[V]

    Create an immutable org.dianahep.histogrammar.Selected from arguments (instead of JSON).

    Create an immutable org.dianahep.histogrammar.Selected from arguments (instead of JSON).

    entries

    Weighted number of entries (sum of all observed weights without the cut applied).

    cut

    Aggregator that accumulated values that passed the cut.

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def fromJsonFragment(json: Json, nameFromParent: Option[String]): Container[_] with NoAggregation

    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
    Select → Factory
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. val help: String

    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
    Select → Factory
  15. def ing[DATUM, V <: Container[V] with Aggregation { type Datum >: DATUM }](quantity: UserFcn[DATUM, Double], cut: V = Count()): Selecting[DATUM, V]

    Synonym for apply.

  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val name: String

    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
    Select → Factory
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. def unapply[DATUM, V <: Container[V] with Aggregation { type Datum >: DATUM }](x: Selecting[DATUM, V]): Some[V]

    Use org.dianahep.histogrammar.Selecting in Scala pattern-matching.

  24. def unapply[V <: Container[V] with NoAggregation](x: Selected[V]): Some[V]

    Use org.dianahep.histogrammar.Selected in Scala pattern-matching.

  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Factory

Inherited from AnyRef

Inherited from Any

Ungrouped