presets as external JSON files

[falkben]

would be handy to have presets exist outside the code, for a number of reasons.

1. user could define their own preset, save it to disk, and have ardent "recognize" it as an option
2. presets "in" the code are somewhat obscured to the user (e.g., how to make a preset if you have to edit the code?)
3. presets which exist outside the code are somewhat more explicit to the user as to what the options are if they do decide to create their own.

As a first step you could just move them out of the code and make them JSON files which can be loaded in from a given directory, however that doesn't solve all issues above (as in, hard to find by the user). Documentation is probably needed for that.

ardent/ardent/presets/registration_parameters.py

Lines 4 to 8 in 62e45ba

	preset_parameters.update({'identity' : dict(eT=0, eL=0, eV=0, sigmaR=0, naffine=0, niter=1)})
	preset_parameters.update({'clarity, mouse' : dict(eT=1e-7, eL=1e-10, eV=2e0, sigmaR=2e1)})
	preset_parameters.update({'nissl, mouse' : dict(eT=2e-9, eL=1e-13, eV=5e-4, sigmaR=1e0)})
	preset_parameters.update({'mri, human' : dict(eT=1e-9, eL=5e-13, eV=5e-4, sigmaR=1e0)})
	# preset_parameters.update({'clarity' : dict(sigmaR=1e1, eV=5e-1, eL=2e-8, eT=2e-5)}) # TODO: remove deprecated 'clarity' preset.

[jovo]

oh yeah, after years of trying this, presets in code has always failed. clear documentation and a json file, i suspect, will be much easier for them.

…

On Fri, Aug 23, 2019 at 11:37 PM Ben Falk ***@***.***> wrote: would be handy to have presets exist outside the code, for a number of reasons. 1. user could define their own preset, save it to disk, and have ardent "recognize" it as an option 2. presets "in" the code are somewhat obscured to the user (e.g., how to make a preset if you have to edit the code?) 3. presets which exist outside the code are somewhat more explicit to the user as to what the options are if they do decide to create their own. As a first step you could just move them out of the code and make them JSON files which can be loaded in from a given directory, however that doesn't solve all issues above (as in, hard to find by the user). Documentation is probably needed for that. https://github.com/neurodata/ardent/blob/62e45babf143aa12ace0b0d33eb7e93baf6b6a28/ardent/presets/registration_parameters.py#L4-L8 — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#3?email_source=notifications&email_token=AAAKG4XDQ7JW6OZFPQ5HRKTQGCUF5A5CNFSM4IPFA7Y2YY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4HHFB4YA>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAAKG4QXMSRKORP7Q7AH3TDQGCUF5ANCNFSM4IPFA7YQ> .

-- the glass is all full: half water, half air. (i will be on paternity leave for most of september and october) neurodata.io