Function test_export_edf_annotations

mne/export/tests/test_export.py:308–358

Test annotations in the exported EDF file. All annotations should be preserved and onset corrected.

(tmp_path, tmin)

@edfio_mark()
@pytest.mark.parametrize("tmin", (0, 0.005, 0.03, 1))
def test_export_edf_annotations(tmp_path, tmin):
    """Test annotations in the exported EDF file.

    All annotations should be preserved and onset corrected.
    """
    raw = _create_raw_for_edf_tests()
    annotations = Annotations(
        onset=[0.01, 0.05, 0.90, 1.05],
        duration=[0, 1, 0, 0],
        description=["test1", "test2", "test3", "test4"],
        ch_names=[["0"], ["0", "1"], [], ["1"]],
    )
    raw.set_annotations(annotations)
    raw.crop(tmin)
    assert raw.first_time == tmin

    if raw.n_times % raw.info["sfreq"] == 0:
        expectation = nullcontext()
    else:
        expectation = pytest.warns(
            RuntimeWarning, match="EDF format requires equal-length data blocks"
        )

    # export
    temp_fname = tmp_path / "test.edf"
    with expectation:
        raw.export(temp_fname)

    # read in the file
    raw_read = read_raw_edf(temp_fname, preload=True)
    assert raw_read.first_time == 0  # exportation resets first_time
    bad_annot = raw_read.annotations.description == "BAD_ACQ_SKIP"
    if bad_annot.any():
        raw_read.annotations.delete(bad_annot)
    valid_annot = (
        raw.annotations.onset >= tmin
    )  # only annotations in the cropped range gets exported

    # compare annotations before and after export
    assert_array_almost_equal(
        raw.annotations.onset[valid_annot] - raw.first_time, raw_read.annotations.onset
    )
    assert_array_equal(
        raw.annotations.duration[valid_annot], raw_read.annotations.duration
    )
    assert_array_equal(
        raw.annotations.description[valid_annot], raw_read.annotations.description
    )
    assert_array_equal(
        raw.annotations.ch_names[valid_annot], raw_read.annotations.ch_names
    )


@edfio_mark()