Meshroom nodes: replace documentation attribute with class docstrings and improve all node docs#2084
Open
Meshroom nodes: replace documentation attribute with class docstrings and improve all node docs#2084
documentation attribute with class docstrings and improve all node docs#2084Conversation
…hroom nodes Co-authored-by: fabiencastan <153585+fabiencastan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix Meshroom nodes to use class docstring for documentation
Convert Meshroom node Mar 17, 2026
documentation member variables to class docstrings
Co-authored-by: fabiencastan <153585+fabiencastan@users.noreply.github.com>
…57, MeshMasking Co-authored-by: fabiencastan <153585+fabiencastan@users.noreply.github.com>
Copilot
AI
changed the title
Convert Meshroom node
Meshroom nodes: replace Mar 17, 2026
documentation member variables to class docstringsdocumentation attribute with class docstrings and improve all node docs
Contributor
There was a problem hiding this comment.
Incorrect comment
Contributor
There was a problem hiding this comment.
Incorrect documentation (No morpho)
Contributor
There was a problem hiding this comment.
"suitable for panorama stitching" is theorically correct but misleading
| This node analyses feature matches across image pairs and estimates the rotation | ||
| between each pair of cameras. It assumes that all cameras rotate around a common | ||
| nodal point (no translation), which is the typical capture model for panoramic photography. | ||
| The result is an SfMData containing the estimated rotation for each view, which serves |
Contributor
There was a problem hiding this comment.
It does not requires a panoramaRefining
| """ | ||
| Refine panorama camera rotations using bundle adjustment. | ||
| Starting from the initial rotation estimates produced by PanoramaEstimation, this node |
Contributor
There was a problem hiding this comment.
No, PanoramaEstimation is not related to this node
Comment on lines
+11
to
+15
| This node scans the provided image files and directories, reads available metadata | ||
| (e.g., EXIF focal length, sensor dimensions, serial number), and produces a minimal | ||
| SfMData file listing all discovered views with their associated intrinsic parameters. | ||
| The resulting SfMData is suitable as an input for the CameraInit node or other nodes | ||
| that accept an SfMData file without requiring reconstructed poses. |
Member
There was a problem hiding this comment.
Suggested change
| This node scans the provided image files and directories, reads available metadata | |
| (e.g., EXIF focal length, sensor dimensions, serial number), and produces a minimal | |
| SfMData file listing all discovered views with their associated intrinsic parameters. | |
| The resulting SfMData is suitable as an input for the CameraInit node or other nodes | |
| that accept an SfMData file without requiring reconstructed poses. | |
| This node scans the specified files and directories to identify image files by their extension, | |
| then generates a minimal SfMData file listing. The output contains no metadata, intrinsics, | |
| or poses — making it ideal for pipelines such as the ImageProcessing node, where | |
| no knowledge of camera intrinsics or extrinsics is required.``` |
Comment on lines
+32
to
+36
| Given multiple directories of binary masks (where corresponding masks share the same filename), | ||
| this node can combine them using logical operations (AND, OR, XOR) and apply morphological | ||
| operations such as dilation and erosion. This is useful for refining or combining masks | ||
| produced by different segmentation methods before using them in depth map estimation | ||
| or texturing. |
Member
There was a problem hiding this comment.
Suggested change
| Given multiple directories of binary masks (where corresponding masks share the same filename), | |
| this node can combine them using logical operations (AND, OR, XOR) and apply morphological | |
| operations such as dilation and erosion. This is useful for refining or combining masks | |
| produced by different segmentation methods before using them in depth map estimation | |
| or texturing. | |
| Given multiple directories of binary masks (where corresponding masks share the same filename), | |
| this node can combine them using logical operations (AND, OR, XOR). This is useful for combining | |
| masks produced by different segmentations. |
This file contains hidden or 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
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.
Recent Meshroom versions read node documentation from the class docstring (
__doc__) rather than adocumentationmember variable. This PR migrates all nodes and takes the opportunity to substantially improve coverage and quality.Description
Two changes are bundled:
documentationattribute → class docstring across all 106 node files inmeshroom/aliceVision/. Empty/whitespace-only documentation is dropped entirely.Before / After example (
ConvertMesh.py):Features list
documentationclass attribute from all 106 node files; replace with PEP-257 class docstring placed as the first statement in the class body.ExportColoredPointCloud,ExportMatches,ImageMasking,LightingEstimation,SfMDistances,SfmBootstrapping,SfmExpanding.form→from(SfMTransfer),of from→of(ConvertSfMFormat), de-indent internal-note style text (SfMPoseFlattening,SfMRigApplying,SfmLandmarksRemapping,MaskEroding).Implementation remarks
The attribute-to-docstring migration was performed with a small Python script that:
documentation = """..."""/'''...'''patterns inside class bodies.All 106 files pass
python -m py_compilewith zero errors.✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.