Skip to content

Clarifying Documentation #1

@briandleahy

Description

@briandleahy

I asked Meera to take a look at the documentation. Here are a few of the things she got stuck on:

  1. A flow-chart of what inherits what and what a state requires would be helpful. I think this is a good idea especially since @colinclement also said something like this.

  2. How do I know what is "wrong" in my optimization -- i.e. when do I change model parameters like illumination or the point-spread function? Examples would be nice.

  3. It would be helpful to show the Fourier transform of the residuals for the well-fit image in the walkthrough.

  4. What is the set_shape function in the components class?

  5. When do I use polish vs. burn vs. finish-state? -- clarify optimization methods and what works.

I'm assigning this issue to myself but I'll also tag @mattbierbaum in case he wants to do some of these.

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions