Skip to content

mef3io-studio v0.1.0.dev6

Pre-release
Pre-release

Choose a tag to compare

@github-actions github-actions released this 31 Oct 19:41
ad7f873

This is a test version for students and researchers who work with MEF 3.0
recordings. It is not the finished app: some features are still missing, and
we would like to hear what is unclear or does not work. It adds a way to
look at the signals of your recordings, on top of
0.1.0.dev5;
0.1.0.dev2
has the full list of what the app can do.

Installers for Windows, macOS (14 or later) and Linux are attached below.
Check your download against the SHA256SUMS file.

These builds are not code-signed yet. Your computer will ask you to
confirm the first start:

  • Windows: "Windows protected your PC" → More info → Run anyway.
  • Mac: open the app once and close the warning, then go to System
    Settings → Privacy & Security
    and click Open Anyway next to the message
    about mef3io-studio. (On macOS 14: right-click the app → Open.) If
    macOS says the app "is damaged and can't be opened", the download was
    quarantined: move the app to Applications, run
    xattr -dr com.apple.quarantine /Applications/mef3io-studio.app in
    Terminal, then open it again.
  • Linux: make the AppImage executable (Properties → Allow executing),
    then double-click it.

What's new since 0.1.0.dev5

A signal viewer. Look at the traces of one recording, or of several at
once, without changing anything. In Explore, select recordings and
choose View signals (the button under the list, or the right-click
menu). On the Join or trim page, View these recordings opens the same
window.

  • Several recordings as one. They are shown on one shared time line.
    A thin band above the traces shows which recording holds data at each
    moment, with a letter and a colour for each; stretches with no data are
    hatched. Where one recording ends and the next begins there is a clear
    line, and a short message ("Now showing recording B") appears over the
    traces. The keys { and } jump to the previous and next such line.
  • Montages. As recorded, Referenced to a channel (you choose the
    channel every other channel is shown against), and Lead bipolar.
  • Filters for slow drift and fast activity, and a mains filter (50 or
    60 Hz, with its harmonics if you wish). Each cutoff can be typed, moved
    with a slider, or set from a short list of usual values, and the traces
    follow as you move it. Show response… draws what the filters keep:
    as a share of the signal, in decibels, and (for filters that shift
    waves in time) the time shift. A line of plain words under it says what
    the filters do.
  • Moving around. Keys for a page, half a page or one second forward
    and back, the start and the end, and the mouse wheel, dragging and
    zooming. Jump (Ctrl+K) takes a time of day, a day and time, a date, a
    move such as +10m, or a recording letter. Press ? in the viewer for
    the full list of keys. On a Mac, two keys differ: more or less space
    between rows is Alt+Up and Alt+Down (Ctrl+Up and Ctrl+Down are used by
    the system).
  • Clinical scales: sensitivity in µV/mm, timebase in mm/s, space
    between rows in mm, and a choice of colours.
  • Notes and events are shown on the traces, in a list you can search,
    and by type; [ and ] step from one to the next.
  • Export range. Mark a start and an end on the traces (keys S and
    E, or by dragging the edges), copy the times, keep a list of ranges and
    save it as CSV or JSON, or send the range straight to Join or trim.
  • Privacy follows Explore. Patient details and the text of notes stay
    hidden until you show them for that recording, in Explore or with the
    Show button in the viewer, and hiding them in Explore hides them in
    the viewer too.
  • Fast on big recordings. Only what is on the screen, and a few pages
    ahead, is read. File → Settings has a Signal viewer section: how
    many things are loaded and filtered at once, how many pages are loaded
    ahead, and how much memory the viewer may use. The three settings for
    loading and filtering and the memory setting are "Automatic" unless you
    change them; pages loaded ahead starts at 2 (0 to 8). Changes apply to
    viewer windows opened afterwards.

Edit mode (optional, off by default). The Edit mode button in the
viewer lets you add notes and events. It is off every time you open the
viewer, and a banner reminds you that your changes are a draft.

  • Add a note or event at the pointer (key A, the Add… button, or the
    right-click menu), or use the keys 1 to 9 for the quick types (Note,
    Seizure onset, Seizure end, Spike, Artifact, Sleep). Key 1 (Note) opens
    the form, because a plain note needs words; the other types are added at
    once, without text. A note can last
    until a later time and can belong to the whole recording or to one
    channel.
  • Undo and redo (Ctrl+Z, Ctrl+Shift+Z), and Discard the draft.
  • Import notes and events from a CSV or JSON file and export them
    to one (the file holds real dates and the text of notes, so the app
    reminds you to store it with care).
  • Save… first shows what will be added to each recording. Nothing is
    written before you agree. Notes are only added to the recording: what
    is already stored is never rewritten. For a password-protected recording
    the app asks for both passwords, the one it already holds and the other.
    If a note falls where two recordings both hold data, you choose which
    recording gets it.
  • Recordings packed in a single-file recording (.mefd.tar) cannot get new notes;
    unpack them first.

Built on mef3io 2.1.1 (it was 1.5.1 in 0.1.0.dev5).

Good to know: times are shown in UTC until you choose the time zone
of the place where the recordings were made (View → Time zone…). The
viewer opens the recordings you selected; it never changes them unless you
use edit mode and save.

What to try

Please use copies of recordings you are allowed to work with, or test
recordings without patient data.

  1. In Explore, select a recording and choose View signals. Move through
    it with the keys and the mouse. Is it clear what is on the screen?
  2. Select two or three recordings from one patient and open them together.
    Can you tell where one ends and the next begins, and which is which?
  3. Try the three montages and move the filter cutoffs. Does Show
    response…
    match what you see in the traces?
  4. Turn on Edit mode on a copy of a recording, add a note or two, then
    Save…. Do you find the new notes in Explore afterwards?
  5. Tell us which words or steps were confusing. That is as useful to us
    as a bug.

The user guide
explains every step. Settings (File → Settings) and About (Help →
About mef3io-studio
) are in the mef3io-studio menu on a Mac.

Known limitations

  • Not code-signed (see above).
  • Edit mode only adds. You can change or take out a note in the draft,
    but changing or removing a note that is already stored in a recording
    is not possible yet: it will need a new copy of the recording, which comes
    in a later version. Such changes stay in the draft and cannot be saved.
  • The quick types for the keys 1 to 9 are fixed lists of words for now;
    there is no screen to change them yet.
  • Not in this version yet: cutting one recording into several pieces,
    sorting and renaming recordings, viewing and editing their details,
    adding or removing password protection on an existing recording, and
    saving a choice of channels to reuse.
  • Recordings that cannot share one time line are refused when you open
    them together, with the reason in plain words. Open them one by one
    instead.
  • Join or trim: two kept parts that run at the same time must not share
    a channel you keep (leave the shared channels out to join them); the
    recordings must be of the same patient and have the same sampling rate per
    channel. A recording opened only with its basic password cannot be used
    here: open it in Explore with the full-access password.
  • Notes of a recording protected with a full-access password are not
    shown in the viewer unless you opened the recording in Explore with that
    password.
  • One choice for all note text when anonymizing: the text of notes is
    either removed from every copy or kept in every copy. Choosing per note is
    not possible yet.
  • Copies are made one after another, not several at once.
  • One archive for the whole batch cannot be opened in the app directly.
    Extract it first with any archive tool (7-Zip, the one built into Windows
    or macOS, or tar); you then get the recordings back as usual.
  • There is no saved report of an anonymization yet, apart from the list
    of original and new dates (saved only if you ask).
  • Left-out channel names inside longer words: if kept note text holds the
    name of a channel you left out glued into a longer word (for example "a3a3"
    when channel a3 is left out), the app refuses the copy before starting.
    Removing the note text avoids it.
  • Continuing a batch with very short names: when you kept note text or
    descriptions and the patient's name or ID, or the name of a channel you
    left out, has a part only one or two letters long (for example the O in
    O'Brien, or a channel called E), Make them
    again
    may treat another copy of the same recording, with the same name
    and dates but with that text removed, as its own and make it again. Your
    batch's own copies are never affected, and this matters only if such a
    copy appeared at the destination while the batch was stopped
    (#39).

Reporting a problem

Open an issue on GitHub.
Issues are public, so:

  • Never attach a recording, a screenshot that shows patient details, or
    real names, dates or folder names. Describe what you did and what you saw
    instead.
  • Say which version you use (Help → About mef3io-studio; on a Mac, in
    the mef3io-studio menu) and on which computer (Windows, Mac or Linux).
  • If the app itself does not seem to work, Help → Check this
    installation
    tests it with a small made-up recording; tell us what it
    says.
  • The app's log (Help → Open the log folder) leaves out patient details,
    names, folder paths and dates. Still, read it before you attach it.

If you find that an anonymized copy still contains patient details or a real
date, please do not open a public issue. Report it privately instead:
report a privacy problem.