Added descriptions to StructureFromMotion node #1932
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jaggzh
force-pushed
the
node-doc-additions
branch
from
01b35e5
to
a891552
Compare
jaggzh
changed the title
|
Is this one complex to review? :}} |
simogasp
requested changes
Jun 21, 2023
Comment on lines
+99
to
+117
| description='The algorithm used to extract distinctive features from images.\n' | ||
| 'sift: Popular method for detecting/describing features.\n' | ||
| ' Robust to changes in scale and orientation\n' | ||
| ' sift_float: Uses floats (not ints).\n' | ||
| ' sift_upright: Variation that does not compute scale and orientation.\n' | ||
| ' dspsift: Dense version of SIFT that samples features at regular intervals.\n' | ||
| ' (More efficient, but may be less accurate.)\n' | ||
| 'akaze: A faster and more memory-efficient alternative to SIFT.\n' | ||
| ' Less sensitive to affine distortion, making it useful for changing camera perspectives.\n' | ||
| ' (Good to use in combination with SIFT)\n' | ||
| ' akaze_liop: With Local Intensity Order Pattern features.\n' | ||
| ' akaze_mldb: With Multi-Learning Decision Binary features.\n' | ||
| 'cctag3: Features for detecting Cube-Circle-Triangle markers in images.\n' | ||
| ' Robust to changes in illumination and scale, and can be used to estimate camera pose.\n' | ||
| 'cctag4: Variation of CCTAG with more information in markers.\n' | ||
| 'sift_ocv: Implementation of SIFT provided by OpenCV.\n' | ||
| 'akaze_ocv: Implementation of AKAZE provided by OpenCV.\n' | ||
| 'tag16h5: Features for detecting AprilTag markers in images.\n' | ||
| ' Robust and reliable for object detection and pose estimation.', |
There was a problem hiding this comment.
I'd rather integrate this into the FeatureExtraction node as here it is only used to select which type of feature that has been already extracted to use for the SfM part
| ' (Good to use in combination with SIFT)\n' | ||
| ' akaze_liop: With Local Intensity Order Pattern features.\n' | ||
| ' akaze_mldb: With Multi-Learning Decision Binary features.\n' | ||
| 'cctag3: Features for detecting Cube-Circle-Triangle markers in images.\n' |
There was a problem hiding this comment.
FYI CCTag = Concentric Circles Tag ;-)
| @@ -220,7 +254,10 @@ class StructureFromMotion(desc.AVCommandLineNode): | |||
| desc.FloatParam( | |||
| name='minAngleForLandmark', | |||
| label='Min Angle For Landmark', | |||
| description='Minimum angle for landmark.', | |||
| description='This parameter sets the minimum angle required between two views to create a landmark. A landmark is ' | |||
There was a problem hiding this comment.
Suggested change
| description='This parameter sets the minimum angle required between two views to create a landmark. A landmark is ' | |
| description='This parameter sets the minimum angle required between two rays in space to create a 3D landmark. A landmark is ' |
Comment on lines
+258
to
+260
| 'a point that is manually marked in multiple images to help improve the reconstruction accuracy. ' | ||
| 'A higher value for this parameter can reduce the number of landmarks created, but may also improve ' | ||
| 'the overall accuracy of the reconstruction.', |
There was a problem hiding this comment.
Suggested change
| 'a point that is manually marked in multiple images to help improve the reconstruction accuracy. ' | |
| 'A higher value for this parameter can reduce the number of landmarks created, but may also improve ' | |
| 'the overall accuracy of the reconstruction.', | |
| 'a 3D point obtained by triangulating corresponding features in two or more images. ' | |
| 'A higher value for this parameter can reduce the number of landmarks created, but may also improve ' | |
| 'the overall accuracy of the reconstruction.', |
Comment on lines
+315
to
+316
| 'Rig constraints are used to enforce certain geometric relationships between the cameras in a ' | ||
| 'multi-camera system.', |
There was a problem hiding this comment.
Suggested change
| 'Rig constraints are used to enforce certain geometric relationships between the cameras in a ' | |
| 'multi-camera system.', | |
| 'Rig constraints are used to enforce a rigid geometric relationships between cameras that are part of the same multi-camera system.', |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I figured the descriptions could be much more helpful to users. I began with just the tooltip versions. I do NOT know if they're accurate so please review.
Features list
Implementation remarks
Used chatgpt to help! But did a lot of work on it myself (and a lot of back-and-forth), and then hand editing afterwards too.