Skip to content

[Code Feature]: SOFAST: Step-by-step guide #276

@rcbrost

Description

@rcbrost

Contact Details

[email protected]

Feature

Tutorial to provide a primary for helping new users learn to run SOFAST.
Probably create new end-to-end examples to provide an executable, archival, running document of how to run the code. Non-code information (such as explanation of what physical setup to use, how to interpret generated output, etc) could be provided by printed-out, or pop-up explanations during run.
An alternative would be a Jupyter notebook format, ala Tristan's contribution.

Feature

Should cover all SOFAST operating variations:

  • Fringe.
  • Fixed - printed pattern.
  • Fixed - projected pattern.
  • Above, with known rectangular mirror outline.
  • Above, with unknown mirror outline (including the high-precision calibration mirror).
  • Calibration for each of the above.
  • Infrastructure calibration, such as camera calibration.
  • The end-to-end example.
  • The temperature end-to-end example.

What OS do you intend to use this on?

No response

Dependencies

None, other than the items required by SOFAST.

Contribution Guidelines

  • I agree to follow this project's contribution guidelines

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions