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

Add comments to SynthSeg/dcan/image_generation.py describing its purpose (from code review 2022-06-22) #7

Open
GregConan opened this issue Jun 22, 2022 · 0 comments

Comments

@GregConan
Copy link
Member

  • Describe the specific purpose that this was developed for, an example use case, and the other ways it can be used
    • Include function-level and module-level description, because even if users shouldn't usually need to look at the code, they may in an error
  • Mention
    • that this script generates the distorted/blurred/etc. synthetic T1s and T2s
    • that what the script generates depends on the input parameters and priors
    • what GMM stands for (Guassian Markov Models?)
      • As Steve says, we shouldn't use an acronym unless we know what it means!
  • Add comment to line 71 & 73 specifying that the 0000 and 0001 mean T1 and T2
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

1 participant