Skip to content
This repository has been archived by the owner on May 18, 2021. It is now read-only.

REF: ShimSpecs—replace child classes with parameter files (.json) #75

Open
rtopfer opened this issue May 18, 2020 · 1 comment · May be fixed by #92
Open

REF: ShimSpecs—replace child classes with parameter files (.json) #75

rtopfer opened this issue May 18, 2020 · 1 comment · May be fixed by #92
Assignees
@rtopfer
Labels
design class model design (inheritance, membership)

Comments

@rtopfer
Copy link
Contributor

rtopfer commented May 18, 2020

The family of classes (e.g.) consists exclusively of properties (shim system specifications).

Rather than defining Matlab child classes for each new shim system, these attributes should just be listed in .json files—then used to initialize the properties of a single ShimSpecs class (which can also validate them, e.g. check number of channels is a positive integer, etc.).
@rtopfer rtopfer self-assigned this May 18, 2020
@rtopfer rtopfer added the design class model design (inheritance, membership) label May 18, 2020
@rtopfer rtopfer mentioned this issue May 19, 2020
Open
@jcohenadad
Copy link
Member

👍 for putting these parameters inside a json file. I also think we should package the json + mat file (which has the current-to-hertz per channel) and host it on OSF. Then, a link to OSF (along with the name of the package, e.g. shimGreg) could be fetched by the CLI (or GUI) for download if requested by the user.

@rtopfer rtopfer linked a pull request May 26, 2020 that will close this issue
Draft
@rtopfer rtopfer mentioned this issue Jun 19, 2020
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@rtopfer rtopfer

Labels
design class model design (inheritance, membership)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Rt/issue75 shim specs json shimming-toolbox/shimming-toolbox-matlab
2 participants
@jcohenadad @rtopfer