tee-ar-ex / tee-ar-ex/trx-python

Allow other types into `append`

Open
#39 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
Python
Stars
26
Forks
20
Avg merge
1d 14h
Merged PRs (30d)
9

Description

Right now, append only takes a TRX as input:

https://github.com/tee-ar-ex/trx-python/blob/d2e5d9f300ef16f3ded5e8b7e29bfc8e1841d30b/trx/trx_file_memmap.py#L1239

For practical purposes, it would be useful to be allowed to append SFT and other types (ArraySequence, LazyTractogram) into an existing TRX.

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 at trx/trx_file_memmap.py around the append implementation linked in the issue, and inspect how it validates TRX inputs. Trace the existing handling of SFT, ArraySequence, and LazyTractogram to determine the supported conversions and storage requirements. Done means these types can be appended to an existing TRX without breaking current TRX appends, with tests covering each accepted input type.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.