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

API simplification #54

Open
mckib2 opened this issue Apr 23, 2020 · 0 comments
Open

API simplification #54

mckib2 opened this issue Apr 23, 2020 · 0 comments
Labels
enhancement New feature or request
Milestone

Comments

@mckib2
Copy link
Owner

mckib2 commented Apr 23, 2020

It would probably be best to group GRAPPA-like functions under one banner and SENSE-like things under another one instead of having a menagerie of functions scattered about the pygrappa namespace

Proposed:

res = pygrappa.grappa(kspace, calib=None, method='grappa', coil_axis=-1, options=None)

method specifies which flavor of GRAPPA to use for reconstruction:

  • grappa: vanilla GRAPPA with mdgrappa backend
  • tgrappa: TGRAPPA
  • etc.

options is a dictionary containing options specific to the chosen method, e.g.,:

  • lamda
  • time_axis
  • 'fov'
  • etc.

Similarly, SENSE-like methods go under the umbrella:

res = pygrappa.sense(kspace, sens, coil_axis=-1, options=None)
@mckib2 mckib2 added this to the 1.0.0 milestone Apr 23, 2020
@mckib2 mckib2 added the enhancement New feature or request label Apr 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant