Skip to content

Clarify bundle adjust documentation of parameters used for each step of bundle adjust #467

@AndrewAnnex

Description

@AndrewAnnex

Is your feature request related to a problem? Please describe.
In https://stereopipeline.readthedocs.io/en/latest/tools/bundle_adjust.html and https://stereopipeline.readthedocs.io/en/latest/tools/parallel_bundle_adjust.html, I am often confused on which named bundle_adjust parameters are used for each processing step (0, 1, or 2) of parallel_bundle_adjust. Often that can be worked out by intuition though.

Describe the solution you'd like
I would like the documentation for bundle_adjust (or parallel_bundle_adjust, but since the parallel commands defer to the docs for bundle adjust that seems to be the more logical place) to include for each parameter an explicit description of which processing step that parameter is used for at the end of the sentence documenting the parameter.

For example for --num-iterations:

--num-iterations <integer (default: 1000)>
Set the maximum number of iterations. Used in processing step(s): 2.

Or something to this effect, if a parameter is used in multiple steps an enumeration like 0,1 would be fine. This doesn't need to be machine parsable, although that would be an interesting feature especially if the help/man page for the function in the terminal is also updated to include this information.

Some parameters partially describe their use in the processing steps, but it is inconsistent.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions