"""
.. _ex-io-ave-fiff:

======================================
Getting averaging info from .fif files
======================================

Parse averaging information defined in Elekta Vectorview/TRIUX DACQ (data acquisition).
Extract and average epochs accordingly. Modify some averaging parameters and get epochs.
"""
# Author: Jussi Nurminen (jnu@iki.fi)
#
# License: BSD-3-Clause
# Copyright the MNE-Python contributors.

# %%

import os

import mne
from mne.datasets import multimodal

fname_raw = os.path.join(multimodal.data_path(), "multimodal_raw.fif")


print(__doc__)

# %%
# Read raw file
raw = mne.io.read_raw_fif(fname_raw)

# %%
# Check DACQ defined averaging categories and other info
print(raw.acqparser)

# %%
# Extract epochs corresponding to a category
cond = raw.acqparser.get_condition(raw, "Auditory right")
epochs = mne.Epochs(raw, **cond)
epochs.average().plot_topo(background_color="w")

# %%
# Get epochs from all conditions, average
evokeds = []
for cat in raw.acqparser.categories:
    cond = raw.acqparser.get_condition(raw, cat)
    # copy (supported) rejection parameters from DACQ settings
    epochs = mne.Epochs(
        raw, reject=raw.acqparser.reject, flat=raw.acqparser.flat, **cond
    )
    evoked = epochs.average()
    evoked.comment = cat["comment"]
    evokeds.append(evoked)

# %%
# Make a new averaging category
newcat = dict()
newcat["comment"] = "Visual lower left, longer epochs"
newcat["event"] = 3  # reference event
newcat["start"] = -0.2  # epoch start rel. to ref. event (in seconds)
newcat["end"] = 0.7  # epoch end
newcat["reqevent"] = 0  # additional required event; 0 if none
newcat["reqwithin"] = 0.5  # ...required within .5 s (before or after)
newcat["reqwhen"] = 2  # ...required before (1) or after (2) ref. event
newcat["index"] = 9  # can be set freely

cond = raw.acqparser.get_condition(raw, newcat)
epochs = mne.Epochs(raw, reject=raw.acqparser.reject, flat=raw.acqparser.flat, **cond)
epochs.average().plot(time_unit="s")