MIT-LCP / MIT-LCP/wfdb-python

Write multi-character annotation mnemnonics

Open
#411 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
853
Forks
322
PR merge metrics
No merged PRs in 30d

Description

WFDB annotation mnemonics ("symbols", in wfdb-python parlance) are not limited to a single character. (All of the standard mnemonics are a single character, but a custom mnemonic defined using setannstr can be multiple characters; the only limitation is that it can't contain spaces or control characters.)

Thanks to pull request #404 it is now possible to define custom annotation mnemonics when calling wfdb.wrann. However, custom_triplet_bytes will choke if any of them are not a single character (something that can be passed to ord).

(interpret_defintion_annotations will read multi-character mnemonics correctly, though note that it has the same problem as rdheader used to have: it uses findall when it should be using match or fullmatch.)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating custom_triplet_bytes and tracing how wfdb.wrann passes custom annotation mnemonics into it. Check the existing handling in interpret_defintion_annotations for multi-character values, then verify that custom mnemonics without spaces or control characters can be written successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.