Struct DatasetReadOptions 

pub struct DatasetReadOptions {
    pub p4_names: Option<Vec<String>>,
    pub aux_names: Option<Vec<String>>,
    pub tree: Option<String>,
    pub aliases: IndexMap<String, P4Selection>,
}

Options for reading a Dataset from a file.

See Also

Dataset::from_parquet, Dataset::from_root

Fields

p4_names: Option<Vec<String>>

Particle names to read from the data file.

aux_names: Option<Vec<String>>

Auxiliary scalar names to read from the data file.

tree: Option<String>

Name of the tree to read when loading ROOT files. When absent and the file contains a single tree, it will be selected automatically.

aliases: IndexMap<String, P4Selection>

Optional aliases mapping logical names to selections of four-momenta.

Implementations

impl DatasetReadOptions

pub fn new() -> Self

Create a new Default set of DatasetReadOptions.

pub fn p4_names<I, S>(self, names: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<str>,

If provided, the specified particles will be read from the data file (assuming columns with required suffixes are present, i.e. <particle>_px, <particle>_py, <particle>_pz, and <particle>_e). Otherwise, all valid columns with these suffixes will be read.

pub fn aux_names<I, S>(self, names: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<str>,

If provided, the specified columns will be read as auxiliary scalars. Otherwise, all valid columns which do not satisfy the conditions required to be read as four-momenta will be used.

pub fn tree<S>(self, name: S) -> Self

where S: AsRef<str>,

Select the tree to read when opening ROOT files.

pub fn alias<N, S>(self, name: N, selection: S) -> Self

where N: Into<String>, S: IntoP4Selection,

Register an alias for one or more existing four-momenta.

pub fn aliases<I, N, S>(self, aliases: I) -> Self

where I: IntoIterator<Item = (N, S)>, N: Into<String>, S: IntoP4Selection,

Register multiple aliases for four-momenta selections.

Trait Implementations

impl Clone for DatasetReadOptions

fn clone(&self) -> DatasetReadOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for DatasetReadOptions

fn default() -> DatasetReadOptions

Returns the “default value” for a type.