Struct EegMetadata 

pub struct EegMetadata {

    pub task_name: Option<String>,
    pub task_description: Option<String>,
    pub sampling_frequency: f64,
    pub eeg_channel_count: Option<u32>,
    pub eog_channel_count: Option<u32>,
    pub ecg_channel_count: Option<u32>,
    pub emg_channel_count: Option<u32>,
    pub misc_channel_count: Option<u32>,
    pub trigger_channel_count: Option<u32>,
    pub eeg_placement_scheme: Option<String>,
    pub eeg_reference: Option<String>,
    pub eeg_ground: Option<String>,
    pub recording_duration: Option<f64>,
    pub recording_type: Option<String>,
    pub power_line_frequency: Option<f64>,
    pub software_filters: Option<Value>,
    pub hardware_filters: Option<Value>,
    pub manufacturer: Option<String>,
    pub manufacturers_model_name: Option<String>,
    pub cap_manufacturer: Option<String>,
    pub cap_manufacturers_model_name: Option<String>,
    pub institution_name: Option<String>,
    pub institutional_department_name: Option<String>,
    pub institution_address: Option<String>,
    pub subject_artifact_description: Option<String>,
}

EEG-specific metadata from the JSON sidecar.

See: https://bids-specification.readthedocs.io/en/stable/modality-specific-files/electroencephalography.html

Fields

task_name: Option<String>

Name of the task.

task_description: Option<String>

Description of the task.

sampling_frequency: f64

Sampling frequency of the EEG recording in Hz.

eeg_channel_count: Option<u32>

Number of EEG channels.

eog_channel_count: Option<u32>

Number of EOG channels.

ecg_channel_count: Option<u32>

Number of ECG channels.

emg_channel_count: Option<u32>

Number of EMG channels.

misc_channel_count: Option<u32>

Number of miscellaneous channels.

trigger_channel_count: Option<u32>

Number of trigger channels.

eeg_placement_scheme: Option<String>

EEG placement scheme (e.g., “10-20”, “10-10”, “10-5”).

eeg_reference: Option<String>

EEG reference electrode(s).

eeg_ground: Option<String>

EEG ground electrode.

recording_duration: Option<f64>

Duration of the recording in seconds.

recording_type: Option<String>

Type of recording: “continuous”, “epoched”, “discontinuous”.

power_line_frequency: Option<f64>

Power line frequency in Hz (50 or 60).

software_filters: Option<Value>

Software filters applied.

hardware_filters: Option<Value>

Hardware filters applied.

manufacturer: Option<String>

Manufacturer of the EEG system.

manufacturers_model_name: Option<String>

Manufacturer’s model name.

cap_manufacturer: Option<String>

Name of the cap (if applicable).

cap_manufacturers_model_name: Option<String>

Cap model.

institution_name: Option<String>

Institutional department name.

institutional_department_name: Option<String>

Institutional department name.

institution_address: Option<String>

Address of the institution.

subject_artifact_description: Option<String>

Subject artifact description.

Implementations

impl EegMetadata

pub fn from_metadata(md: &BidsMetadata) -> Option<Self>

Try to extract EEG metadata from a generic BidsMetadata.

pub fn total_channel_count(&self) -> u32

Get the total channel count.

Trait Implementations

impl Clone for EegMetadata

fn clone(&self) -> EegMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EegMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EegMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EegMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.