Skip to main content

ReadOptions

Struct ReadOptions 

Source
pub struct ReadOptions {
    pub channels: Option<Vec<String>>,
    pub exclude: Option<Vec<String>>,
    pub start_time: Option<f64>,
    pub end_time: Option<f64>,
    pub stim_channel: Option<Vec<String>>,
}
Expand description

Options for reading EEG data files.

Fields§

§channels: Option<Vec<String>>

If set, only read these channels (by name). Corresponds to MNE’s include.

§exclude: Option<Vec<String>>

If set, exclude these channels by name. Applied after channels. Corresponds to MNE’s exclude parameter.

§start_time: Option<f64>

If set, only read starting from this time in seconds.

§end_time: Option<f64>

If set, only read up to this time in seconds.

§stim_channel: Option<Vec<String>>

Override stim channel detection. If Some, these channel names are treated as stimulus channels. If None, auto-detection is used (channels named “Status”, “Trigger”, “STI”, case-insensitive).

Implementations§

Source§

impl ReadOptions

Source

pub fn new() -> Self

Source

pub fn with_channels(self, channels: Vec<String>) -> Self

Include only these channels (like MNE’s include / picks).

Source

pub fn with_exclude(self, exclude: Vec<String>) -> Self

Exclude these channels (like MNE’s exclude).

Source

pub fn with_time_range(self, start: f64, end: f64) -> Self

Source

pub fn with_stim_channel(self, names: Vec<String>) -> Self

Override stim channel names. Pass empty vec to disable auto-detection.

Trait Implementations§

Source§

impl Clone for ReadOptions

Source§

fn clone(&self) -> ReadOptions

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 ReadOptions

Source§

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

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

impl Default for ReadOptions

Source§

fn default() -> ReadOptions

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.