MIT-LCP / MIT-LCP/wfdb-python

Make read (`rdrecord`, `rdsamp`) and write (`wrsamp`) functions isomorphic

Open
#500 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

As noted in #484 , rdsamp and wrsamp are not isomorphic. It is reasonable to expect that what gets read into memory should be sufficient and by default re-create the read file when passing that information to a write function.

We should provide a set of isomorphic read and write functions by doing at least one of these:

  1. Making rdsamp and wrsamp isomorphic. Currently they only handle a subset of the parameters in a record object though.
  2. Adding a write function which can use all of the information from rdrecord to re-create a read record.

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 comparing the parameters and record information handled by rdrecord, rdsamp, and wrsamp, with the context in issue #484. Done means the read and write APIs preserve enough record information to recreate the input file, either by making rdsamp and wrsamp isomorphic or by adding a write function for rdrecord output.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.