-
Notifications
You must be signed in to change notification settings - Fork 171
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
Updated jigsaw documentation #5018
Conversation
@@ -1,10 +1,11 @@ | |||
<?xml version="1.0"?> | |||
<application name="jigsaw" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://isis.astrogeology.usgs.gov/Schemas/Application/application.xsd"> | |||
<brief> | |||
Improves camera pointing and a whole lot more! | |||
Improves image alignment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think a little more might be nice in this section. Maybe "through updates to kernel information"?
<b>jigsaw</b> outputs a new <def>control net</def> that includes the initial state of the | ||
points in the network and their final state after the adjustment. The initial states of | ||
the points are tagged as <def>a priori</def> in the <def>control net</def>, and their final | ||
states are tagged as <def>adjusted</def>. The measured <def>sample</def>/<def>line</def> positions | ||
associated with the <def>control point</def>s in the net are not changed. <def>SPICE</def> | ||
associated with the <def>control point</def>s in the net are not changed. camera information |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should 'camera' be capitalized?
<p> | ||
The <b>jigsaw</b> application attempts to minimize the reprojective error within the control network. | ||
For each control measure and its control point in the control network, the reprojective error is | ||
the difference between the control measures image coordinate and the image coordinate that the control |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested: "the difference between the control measures image coordinates (typically determined through image registration)" Then link to image registration documentation
Here's the docs as a word document too if that's easier for folks to work with. |
As with all iterative methods convergence criteria is important. The default for | ||
the <b>jigsaw</b> application is to converge based on the sigma0 value. This is a | ||
complex value that includes many technical details outside the scope of this | ||
documentation. In a brief, it is a measurement of the remaining error in a typical |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does a typical observation entail? Is this just referring to a nonoutlier?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sigma0 is a very complex thing and even I don't fully understand it. The simplest explanation I can thing of it's a weighted average of the residuals that accounts for the degrees of freedom of the adjustment. So, it takes into account how many "extra" measures you have.
Updated docs as a word file |
* Updated jigsaw documentation * Addressed review feedback * More clean up
Description
Added a whole bunch of documentation to jigsaw that explains different solve settings and when you would use them.
Related Issue
Fixes #4718
Motivation and Context
The jigsaw application is extremely complex and very powerful. The current documentation does a good job of describing what the application does, but not how it actually works or how to configure it. This will give users a better starting point (once they have a control network) to parameterize the jigsaw application.
How Has This Been Tested?
Docs generated locally and look good. I've attached a zip file containing the new documentation
jig_docs.zip
Screenshots (if appropriate):
Types of changes
Checklist:
Licensing
This project is mostly composed of free and unencumbered software released into the public domain, and we are unlikely to accept contributions that are not also released into the public domain. Somewhere near the top of each file should have these words: