Event

Struct Event 

Source
pub struct Event { /* private fields */ }
Expand description

Metadata-aware view of an EventData with name-based helpers.

Implementations§

Source§

impl Event

Source

pub fn new(event: Arc<EventData>, metadata: Arc<DatasetMetadata>) -> Self

Create a new metadata-aware event from raw data and dataset metadata.

Source

pub fn data(&self) -> &EventData

Borrow the raw EventData.

Source

pub fn data_arc(&self) -> Arc<EventData>

Obtain a clone of the underlying EventData handle.

Source

pub fn p4s(&self) -> IndexMap<&str, Vec4>

Return the four-momenta stored in this event keyed by their registered names.

Source

pub fn aux(&self) -> IndexMap<&str, f64>

Return the auxiliary scalars stored in this event keyed by their registered names.

Source

pub fn weight(&self) -> f64

Return the event weight.

Source

pub fn metadata(&self) -> &DatasetMetadata

Retrieve the dataset metadata attached to this event.

Source

pub fn metadata_arc(&self) -> Arc<DatasetMetadata>

Clone the metadata handle associated with this event.

Source

pub fn p4(&self, name: &str) -> Option<Vec4>

Retrieve a four-momentum (or aliased sum) by name.

Source

pub fn get_p4_sum<N>(&self, names: N) -> Vec4
where N: IntoIterator, N::Item: AsRef<str>,

Return a four-momentum formed by summing four-momenta with the specified names.

Source

pub fn boost_to_rest_frame_of<N>(&self, names: N) -> EventData
where N: IntoIterator, N::Item: AsRef<str>,

Boost all four-momenta into the rest frame defined by the specified particle names.

Source

pub fn evaluate<V: Variable>(&self, variable: &V) -> f64

Evaluate a Variable over this event.

Methods from Deref<Target = EventData>§

Source

pub fn get_p4_sum<T: AsRef<[usize]>>(&self, indices: T) -> Vec4

Return a four-momentum from the sum of four-momenta at the given indices in the EventData.

Source

pub fn boost_to_rest_frame_of<T: AsRef<[usize]>>(&self, indices: T) -> Self

Boost all the four-momenta in the EventData to the rest frame of the given set of four-momenta by indices.

Source

pub fn evaluate<V: Variable>(&self, variable: &V) -> f64

Evaluate a Variable on an EventData.

Trait Implementations§

Source§

impl AsRef<EventData> for Event

Source§

fn as_ref(&self) -> &EventData

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for Event

Source§

fn clone(&self) -> Event

Returns a duplicate of the value. Read more
1.0.0§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Event

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Deref for Event

Source§

type Target = EventData

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.

Auto Trait Implementations§

§

impl Freeze for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnwindSafe for Event

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Any for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Source§

fn type_name(&self) -> &'static str

Source§

impl<T> AnySync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TransformExt for T

Source§

fn compose<T2>(self, t2: T2) -> Compose<Self, T2>

Compose a transform with another. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,