Struct Dataset

pub struct Dataset<F: Field + 'static> {
    pub events: Arc<Vec<Event<F>>>,
}

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<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<Vec<Event<F>>>

Storage for events.

Implementations

impl<F: Field + 'static> Dataset<F>

pub fn reindex(&mut self)

Resets the indices of events in a dataset so they start at 0.

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

Retrieves the weights from the events in the dataset

pub fn weights_indexed(&self, indices: &[usize]) -> Vec<F>

Retrieves the weights from the events in the dataset which have the given indices.

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

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. This method returns Vec<usize>s corresponding to the indices of events in each bin, the underflow bin, and the overflow bin respectively. This is intended to be used in conjunction with Manager::evaluate_indexed.

pub fn from_parquet( path: &str, method: ReadMethod<F>, ) -> 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_root( path: &str, method: ReadMethod<F>, ) -> 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 new(events: Vec<Event<F>>) -> 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 get_bootstrap_indices(&self, seed: usize) -> Vec<usize>

Returns a set of indices which represent a bootstrapped Dataset. This method is to be used in conjunction with Manager::evaluate_indexed.

pub fn get_selected_indices( &self, query: impl Fn(&Event<F>) -> bool + Sync + Send, ) -> (Vec<usize>, Vec<usize>)

Selects indices of events in a dataset using the given query. Indices of events for which the query returns true will end up in the first member of the returned tuple, and indices of events which return false will end up in the second member.

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

Splits the dataset by the given query. This method returns Vec<usize>s corresponding to the indices of events in each bin, the underflow bin, and the overflow bin respectively. This is intended to be used in conjunction with Manager::evaluate_indexed.

Trait Implementations

impl<F: Field + 'static> Add for Dataset<F>

type Output = Dataset<F>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl<F: Clone + Field + 'static> Clone for Dataset<F>

fn clone(&self) -> Dataset<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Field + 'static> Debug for Dataset<F>

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

Formats the value using the given formatter.

impl<F: Default + Field + 'static> Default for Dataset<F>

fn default() -> Dataset<F>

Returns the “default value” for a type.