Struct rustitude_core::dataset::Dataset

pub struct Dataset {
    pub events: Arc<RwLock<Vec<Event>>>,
}

An array of Events with some helpful methods for accessing and parsing the data they contain.

A Dataset can be loaded from either Parquet and ROOT files using the corresponding Dataset::from_* methods. Events are stored in an Arc<RwLock<Vec<Event>>>, since we rarely need to write data to a dataset (splitting/selecting/rejecting events) but often need to read events from a dataset.

Fields

events: Arc<RwLock<Vec<Event>>>

Storage for events.

Implementations

impl Dataset

pub fn weights(&self) -> Vec<f64>

Retrieves the weights from the events in the dataset

pub fn split_m( &self, range: (f64, f64), bins: usize, daughter_indices: Option<Vec<usize>>, ) -> (Vec<Self>, Self, Self)

Splits the dataset by the mass of the combination of specified daughter particles in the event. If no daughters are given, the first and second particle are assumed to form the desired combination.

pub fn from_parquet(path: &str) -> Result<Self, RustitudeError>

Generates a new Dataset from a Parquet file.

Errors

This method will fail if any individual event is missing all of the required fields, if they have the wrong type, or if the file doesn’t exist/can’t be read for any reason.

pub fn from_parquet_eps_in_beam(path: &str) -> Result<Self, RustitudeError>

Generates a new Dataset from a Parquet file, assuming the EPS vector can be constructed from the x and y-components of the beam.

Errors

This method will fail if any individual event is missing all of the required fields, if they have the wrong type, or if the file doesn’t exist/can’t be read for any reason.

pub fn from_parquet_with_eps( path: &str, eps: Vec<f64>, ) -> Result<Self, RustitudeError>

Generates a new Dataset from a Parquet file with a given EPS polarization vector.

Errors

This method will fail if any individual event is missing all of the required fields, if they have the wrong type, or if the file doesn’t exist/can’t be read for any reason.

pub fn from_parquet_unpolarized(path: &str) -> Result<Self, RustitudeError>

Generates a new Dataset from a Parquet file with EPS = [0, 0, 0].

Errors

This method will fail if any individual event is missing all of the required fields, if they have the wrong type, or if the file doesn’t exist/can’t be read for any reason.

pub fn from_root(path: &str) -> Result<Self, RustitudeError>

Generates a new Dataset from a ROOT file.

Errors

This method will fail if any individual event is missing all of the required fields, if they have the wrong type, or if the file doesn’t exist/can’t be read for any reason.

pub fn from_root_eps_in_beam(path: &str) -> Result<Self, RustitudeError>

Generates a new Dataset from a ROOT file, assuming the EPS vector can be constructed from the x and y-components of the beam.

Errors

This method will fail if any individual event is missing all of the required fields, if they have the wrong type, or if the file doesn’t exist/can’t be read for any reason.

pub fn from_root_with_eps( path: &str, eps: Vec<f64>, ) -> Result<Self, RustitudeError>

Generates a new Dataset from a Parquet file with a given EPS polarization vector.

Errors

This method will fail if any individual event is missing all of the required fields, if they have the wrong type, or if the file doesn’t exist/can’t be read for any reason.

pub fn from_root_unpolarized(path: &str) -> Result<Self, RustitudeError>

Generates a new Dataset from a Parquet file with EPS = [0, 0, 0].

Errors

This method will fail if any individual event is missing all of the required fields, if they have the wrong type, or if the file doesn’t exist/can’t be read for any reason.

pub fn new(events: Vec<Event>) -> Self

Generate a new Dataset from a Vec<Event>.

pub fn is_empty(&self) -> bool

Checks if the dataset is empty.

pub fn len(&self) -> usize

Returns the number of events in the dataset.

pub fn select(&mut self, query: impl Fn(&Event) -> bool + Sync + Send) -> Self

Selects events in the dataset using the given query and remove them from the Dataset, returning them in a new Dataset. The original Dataset will then contain the “rejected” events, events for which the query returned false.

See also: Dataset::reject

pub fn reject(&mut self, query: impl Fn(&Event) -> bool + Sync + Send) -> Self

Removes events from the dataset if the query returns true and returns them in a new Dataset. The original Dataset will contain events for which the query returned true.

See also: Dataset::select

pub fn split( self, variable: impl Fn(&Event) -> f64 + Sync + Send, range: (f64, f64), nbins: usize, ) -> (Vec<Self>, Self, Self)

Splits the dataset into bins of the specified variable derived from an Event. This method returns a Vec<Dataset> containing the binned datasets, an underflow Dataset (events which are below the lower range), and an overflow Dataset (events above the upper range) in that order.

Trait Implementations

impl Clone for Dataset

fn clone(&self) -> Dataset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dataset

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

Formats the value using the given formatter.

impl Default for Dataset

fn default() -> Dataset

Returns the “default value” for a type.