Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename the confusing object name TrxFile ? #72

Open
skoudoro opened this issue Nov 30, 2023 · 3 comments
Open

Rename the confusing object name TrxFile ? #72

skoudoro opened this issue Nov 30, 2023 · 3 comments

Comments

@skoudoro
Copy link

Hi trx team

TrxFile is a disturbing object since you expect or believe to have a filename, filepath, etc...

I propose to rename this object TrxContainer, TrxHolder, etc....

I am open to any other renaming but I strongly believe that TrxFile is very confusing.

concatenate function is a nice exemple. When you see TrxFile as an input of this function, I believed that I need to put a filename, however, in reality, you need to load it before calling the function.

Please, let me know what you think @frheault and @arokem

@arokem
Copy link
Collaborator

arokem commented Nov 30, 2023

Hello! I wonder if this is not a sign that more functionality needs to be delegated to the StatefulTractogram object instead?

@skoudoro
Copy link
Author

That's a good question. Can you develop your thought ?

@frheault
Copy link
Collaborator

I initially used TrxFile because Nibabel has TrkFile and TckFile when you load a tractogram. So I kept that logic, I have no strong opinion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants