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

Jigsaw documentation #5358

Open
oleg-alexandrov opened this issue Dec 4, 2023 · 10 comments · May be fixed by #5720
Open

Jigsaw documentation #5358

oleg-alexandrov opened this issue Dec 4, 2023 · 10 comments · May be fixed by #5720
Assignees

Comments

@oleg-alexandrov
Copy link
Contributor

The documentation of the jigsaw tool at https://isis.astrogeology.usgs.gov/Application/presentation/Tabbed/jigsaw/jigsaw.html does not explain how the tool should be used.

It should have an example invocation, it should say what is the format of the list of cubes, how to prepare an input cnet, what are adjustable parameters, and how they should be passed to the tool.

@lwellerastro
Copy link
Contributor

lwellerastro commented Dec 12, 2023

Hi @oleg-alexandrov, ISIS interactive software could certainly use better documentation (referring to your #5373 PR), but as you probably know, it's complicated to hit all the particulars since it can be extremely data set dependent.

This is not comprehensive and likely has bits and pieces out of date, but the Wiki has some PDF's covering basic aspects of all the q-related programs as well as jigsaw: https://github.com/DOI-USGS/ISIS3/wiki/ISIS_Demo . Maybe these could be pointed to as an intermediary until improved documentation can be supported.

I think jigsaw in particular can use help especially on how what settings should be used for type of camera and suggested starting uncertainties (sigmas). This would require a bit of effort though.

@oleg-alexandrov
Copy link
Contributor Author

oleg-alexandrov commented Dec 13, 2023

Thanks. I took a look. In the meantime I added a little paragraph to jigsaw.xml describing how to create the initial control network (as part of #5373).

Copy link

Thank you for your contribution!

Unfortunately, this issue hasn't received much attention lately, so it is labeled as 'stale.'

If no additional action is taken, this issue will be automatically closed in 180 days.

If you want to participate in our support prioritization meetings or be notified when support sprints are happening, you can sign up the support sprint notification emails here.

Read more about our support processs here

@github-actions github-actions bot added the inactive Issue that has been inactive for at least 6 months label Jun 11, 2024
@Kelvinrr
Copy link
Collaborator

bump it, this is important

@oleg-alexandrov
Copy link
Contributor Author

ASP's has its own little jigsaw tutorial. It has been there for a while, but I verified that it works and touched it up recently. See https://stereopipeline.readthedocs.io/en/latest/bundle_adjustment.html#tutorial-processing-mars-orbital-camera-images.

Would be nice to have at least the most basic commands in. Better have something quick soon, than something detailed after a long time.

BTW, there appear some examples in other tabs of the jigsaw doc, but those are very easy to miss as they appear grayed out.

Ideally a very simple example would be in the main doc, in its own section, right after the intro, which outlines also how to create .lis files and creation of feature matches with autoseed, etc. Then, that example could have links to the other tabs for more advanced usage.

@github-actions github-actions bot removed the inactive Issue that has been inactive for at least 6 months label Jun 14, 2024
@AustinSanders
Copy link
Contributor

There's a new document on the docs repo that covers the basics of jigsaw / bundle adjustment. It includes everything from data download, .lis file creation, footprintinit, findimageoverlaps, autoseed, and bundle adjustment.

@oleg-alexandrov
Copy link
Contributor Author

The problem is that users are directed to the barebone older document rather than this better newer document.

Maybe the older document should be wiped and replaced with a link to the new document. The old pages also look quaint and awkward in the browser.

Copy link

github-actions bot commented Jan 5, 2025

Thank you for your contribution!

Unfortunately, this issue hasn't received much attention lately, so it is labeled as 'stale.'

If no additional action is taken, this issue will be automatically closed in 180 days.

If you want to participate in our support prioritization meetings or be notified when support sprints are happening, you can sign up the support sprint notification emails here.

Read more about our support processs here

@github-actions github-actions bot added the inactive Issue that has been inactive for at least 6 months label Jan 5, 2025
@oleg-alexandrov
Copy link
Contributor Author

Example 1 has the command as "jigsaw jigsaw", so the name is repeated twice. Same for example 5.

Example 1 does not explain what is cubes.lis, input.net, output.net, and has no links to where these are explained.

These seem to be very low-hanging fruit. If the doc is not expanded, there should be at least links to where other things are documented.

@github-actions github-actions bot removed the inactive Issue that has been inactive for at least 6 months label Jan 6, 2025
@Kelvinrr
Copy link
Collaborator

Kelvinrr commented Jan 6, 2025

Going to bump this for the documentation sprint happening in a bit, if we dont get it done during a support day.

@amystamile-usgs amystamile-usgs linked a pull request Jan 31, 2025 that will close this issue
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

Successfully merging a pull request may close this issue.

5 participants