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

Internal I/O object/schema #23

Open
smoia opened this issue Nov 14, 2019 · 1 comment
Open

Internal I/O object/schema #23

smoia opened this issue Nov 14, 2019 · 1 comment
Labels
Discussion Discussion of a concept or implementation. Need to stay always open.

Comments

@smoia
Copy link
Member

smoia commented Nov 14, 2019

So far, the code was set to adapt to whatever input was provided and process it to an output on a case to case base.
This is not a good approach, not only due to the flexibility we need to offer, but also from a coding perspective.

It's much better to create an object ("Output object"), that contains not only the data but a schema that can be used to:
a. output information about the file that can be used by the user to properly set the input.
b. get the name of the file and the info for the json file.

In this way, the main code would operate on this object, while another family of scripts (interfaces?) would work on populating the object schema based on the type of input and the information embedded in it.

You can think about the new object as composed of a numpy matrix (data), some lists (values that are defined channel by channel) and some variables that contain general information.

This said, what should be the adopted schema (i.e., what information do we need to carry around)?
We know that BIDS has certain requirements, so those have to be in the schema.
However, we can expand the schema thinking about what we'd like to have there for general purposes.

@smoia smoia added the Discussion Discussion of a concept or implementation. Need to stay always open. label Nov 14, 2019
@smoia smoia added this to the phys2bids 1.0.0 milestone Nov 14, 2019
@RayStick
Copy link
Member

Issue #36 may be relevant for this discussion

@smoia smoia mentioned this issue Nov 21, 2019
@smoia smoia removed this from the phys2bids first non-beta milestone Feb 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion Discussion of a concept or implementation. Need to stay always open.
Projects
None yet
Development

No branches or pull requests

2 participants