Select

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

Type Members

trait Methods extends AnyRef

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], 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).
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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
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.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
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
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Synonym for apply.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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.
def unapply[V <: Container[V] with NoAggregation](x: Selected[V]): Some[V]

Use org.dianahep.histogrammar.Selected in Scala pattern-matching.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package histogrammar

object Select extends Factory

Type Members

trait Methods extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def apply[DATUM, V <: Container[V] with Aggregation { type Datum >: DATUM }](quantity: UserFcn[DATUM, Double], cut: V = Count()): Selecting[DATUM, V]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val detailedHelp: String

def ed[V <: Container[V] with NoAggregation](entries: Double, cut: V): Selected[V]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def fromJsonFragment(json: Json, nameFromParent: Option[String]): Container[_] with NoAggregation

final def getClass(): Class[_]

def hashCode(): Int

val help: String

def ing[DATUM, V <: Container[V] with Aggregation { type Datum >: DATUM }](quantity: UserFcn[DATUM, Double], cut: V = Count()): Selecting[DATUM, V]

final def isInstanceOf[T0]: Boolean

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def unapply[DATUM, V <: Container[V] with Aggregation { type Datum >: DATUM }](x: Selecting[DATUM, V]): Some[V]

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

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Factory

Inherited from AnyRef

Inherited from Any

Ungrouped