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

Reserved key for streamline seed point?

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

Nobody has claimed this yet.

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

Description

With MRtrix3 there's been a few requests over the years to have, for streamlines propagated bidirectionally from the seed point, knowledge of which vertex in the output streamline corresponds to the seed location. See e.g. tckmap -output_seeds option (which was at the time the easiest hack to satisfy demands).

In the context of this format, it's a DPS of either a uintX index or a 3.floatXX, depending on whether the seed point itself or an index in the output streamline is provided (theoretically it's possible that in some implementation the precise seed location won't actually be included in the output streamline; in MRtrix3 we guarantee that it's included, but I'm thinking of the most general case).

Primarily the question is whether or not such information should have some form of reserved keyword so that all implementations know where to write it in order to be trivially accessible / interpretable at read time.

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 reviewing the issue's discussion of bidirectional streamlines and the linked MRtrix3 tckmap documentation, especially the output_seeds option. Define whether the format should reserve a keyword and whether its value represents a seed vertex index or a precise seed coordinate; done means the representation and interoperability expectations are agreed.

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
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.