Skip to main content

VariableCollection

Struct VariableCollection 

Source
pub struct VariableCollection {
    pub variables: HashMap<String, SimpleVariable>,
    pub level: String,
    pub entities: StringEntities,
}
Expand description

A collection of simple BIDS variables at a single level of the hierarchy.

Groups SimpleVariables by name, automatically merging variables with the same name and inferring the hierarchy level from the variable source (events→run, participants→dataset, etc.).

Supports variable lookup by name, wildcard pattern matching, entity-based filtering, and subset selection.

Corresponds to PyBIDS’ BIDSVariableCollection class.

Fields§

§variables: HashMap<String, SimpleVariable>§level: String§entities: StringEntities

Implementations§

Source§

impl VariableCollection

Source

pub fn new(vars: Vec<SimpleVariable>) -> Self

Source

pub fn get(&self, name: &str) -> Option<&SimpleVariable>

Source

pub fn names(&self) -> Vec<&str>

Source

pub fn match_variables(&self, pattern: &str, use_regex: bool) -> Vec<&str>

Match variable names against a pattern (regex or glob).

Source

pub fn to_rows(&self) -> Vec<StringEntities>

Convert all variables to tabular rows (long format).

Source

pub fn to_wide(&self) -> (Vec<String>, Vec<Vec<String>>)

Convert to wide format: each variable becomes a column. Returns (column_names, rows) where each row is a Vec<String>.

Source

pub fn from_rows(rows: &[StringEntities], source: &str) -> Self

Create collection from tabular rows.

Trait Implementations§

Source§

impl Clone for VariableCollection

Source§

fn clone(&self) -> VariableCollection

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VariableCollection

Source§

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

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

impl Default for VariableCollection

Source§

fn default() -> VariableCollection

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.