Merge pull request #2063 from alicevision/dev/improveNodesDescriptions

[nodes] Harmonize and improve nodes descriptions
alicevision · Jun 16, 2023 · 61c96a8 · 61c96a8
2 parents 6ac9948 + c498f48
commit 61c96a8
Show file tree

Hide file tree

Showing 63 changed files with 4,411 additions and 4,162 deletions.
diff --git a/meshroom/nodes/aliceVision/ApplyCalibration.py b/meshroom/nodes/aliceVision/ApplyCalibration.py
@@ -13,27 +13,36 @@ class ApplyCalibration(desc.AVCommandLineNode):
 
     inputs = [
         desc.File(
-            name='input',
-            label='Input SfMData',
-            description='SfMData file.',
-            value='',
+            name="input",
+            label="SfMData",
+            description="Input SfMData file.",
+            value="",
             uid=[0],
         ),
         desc.File(
-            name='calibration',
-            label='Calibration',
-            description='Calibration SfMData file.',
-            value='',
+            name="calibration",
+            label="Calibration",
+            description="Calibration SfMData file.",
+            value="",
             uid=[0],
         ),
+        desc.ChoiceParam(
+            name="verboseLevel",
+            label="Verbose Level",
+            description="Verbosity level (fatal, error, warning, info, debug, trace).",
+            value="info",
+            values=["fatal", "error", "warning", "info", "debug", "trace"],
+            exclusive=True,
+            uid=[],
+        ),
     ]
 
     outputs = [
         desc.File(
-            name='output',
-            label='SfMData File',
-            description='Path to the output SfMData file.',
-            value=desc.Node.internalFolder + 'sfmData.sfm',
+            name="output",
+            label="SMData",
+            description="Path to the output SfMData file.",
+            value=desc.Node.internalFolder + "sfmData.sfm",
             uid=[],
         ),
     ]
diff --git a/meshroom/nodes/aliceVision/CameraCalibration.py b/meshroom/nodes/aliceVision/CameraCalibration.py
@@ -7,123 +7,139 @@ class CameraCalibration(desc.AVCommandLineNode):
     commandLine = 'aliceVision_cameraCalibration {allParams}'
 
     category = 'Utils'
+    documentation = '''
+    '''
 
     inputs = [
         desc.File(
-            name='input',
-            label='Input',
-            description='''Input images in one of the following form:
- - folder containing images
- - image sequence like "/path/to/seq.@.jpg"
- - video file''',
-            value='',
+            name="input",
+            label="Input",
+            description="Input images in one of the following form:\n"
+                        " - folder containing images.\n"
+                        " - image sequence like \"/path/to/seq.@.jpg\".\n"
+                        " - video file.",
+            value="",
             uid=[0],
-            ),
+        ),
         desc.ChoiceParam(
-            name='pattern',
-            label='Pattern',
-            description='''Type of pattern (CHESSBOARD, CIRCLES, ASYMMETRIC_CIRCLES, ASYMMETRIC_CCTAG).''',
-            value='CHESSBOARD',
-            values=['CHESSBOARD', 'CIRCLES', 'ASYMMETRIC_CIRCLES', 'ASYMMETRIC_CCTAG'],
+            name="pattern",
+            label="Pattern",
+            description="Type of pattern (CHESSBOARD, CIRCLES, ASYMMETRIC_CIRCLES, ASYMMETRIC_CCTAG).",
+            value="CHESSBOARD",
+            values=["CHESSBOARD", "CIRCLES", "ASYMMETRIC_CIRCLES", "ASYMMETRIC_CCTAG"],
             exclusive=True,
             uid=[0],
-            ),
-        desc.GroupAttribute(name="size", label="Size", description="Number of inner corners per one of board dimension like W H.", groupDesc=[
-            desc.IntParam(
-                name='width',
-                label='Width',
-                description='',
-                value=7,
-                range=(0, 10000, 1),
-                uid=[0],
+        ),
+        desc.GroupAttribute(
+            name="size",
+            label="Size",
+            description="Number of inner corners per one of board dimension like W H.",
+            groupDesc=[
+                desc.IntParam(
+                    name="width",
+                    label="Width",
+                    description="",
+                    value=7,
+                    range=(0, 10000, 1),
+                    uid=[0],
                 ),
-            desc.IntParam(
-                name='height',
-                label='Height',
-                description='',
-                value=5,
-                range=(0, 10000, 1),
-                uid=[0],
+                desc.IntParam(
+                    name="height",
+                    label="Height",
+                    description="",
+                    value=5,
+                    range=(0, 10000, 1),
+                    uid=[0],
                 ),
-            ]),
+            ]
+        ),
         desc.FloatParam(
-            name='squareSize',
-            label='Square Size',
-            description='''Size of the grid's square cells (mm).''',
+            name="squareSize",
+            label="Square Size",
+            description="Size of the grid's square cells (mm).",
             value=1.0,
             range=(0.0, 100.0, 1.0),
             uid=[0],
-            ),
+        ),
         desc.IntParam(
-            name='nbDistortionCoef',
-            label='Nb Distortion Coef',
-            description='''Number of distortion coefficient.''',
+            name="nbDistortionCoef",
+            label="Nb Distortion Coef",
+            description="Number of distortion coefficients.",
             value=3,
             range=(0, 5, 1),
             uid=[0],
-            ),
+        ),
         desc.IntParam(
-            name='maxFrames',
-            label='Max Frames',
-            description='''Maximal number of frames to extract from the video file.''',
+            name="maxFrames",
+            label="Max Frames",
+            description="Maximum number of frames to extract from the video file.",
             value=0,
             range=(0, 5, 1),
             uid=[0],
-            ),
+        ),
         desc.IntParam(
-            name='maxCalibFrames',
-            label='Max Calib Frames',
-            description='''Maximal number of frames to use to calibrate from the selected frames.''',
+            name="maxCalibFrames",
+            label="Max Calib Frames",
+            description="Maximum number of frames to use to calibrate from the selected frames.",
             value=100,
             range=(0, 1000, 1),
             uid=[0],
-            ),
+        ),
         desc.IntParam(
-            name='calibGridSize',
-            label='Calib Grid Size',
-            description='''Define the number of cells per edge.''',
+            name="calibGridSize",
+            label="Calib Grid Size",
+            description="Define the number of cells per edge.",
             value=10,
             range=(0, 50, 1),
             uid=[0],
-            ),
+        ),
         desc.IntParam(
-            name='minInputFrames',
-            label='Min Input Frames',
-            description='''Minimal number of frames to limit the refinement loop.''',
+            name="minInputFrames",
+            label="Min Input Frames",
+            description="Minimum number of frames to limit the refinement loop.",
             value=10,
             range=(0, 100, 1),
             uid=[0],
-            ),
+        ),
         desc.FloatParam(
-            name='maxTotalAvgErr',
-            label='Max Total Avg Err',
-            description='''Max Total Average Error.''',
+            name="maxTotalAvgErr",
+            label="Max Total Avg Err",
+            description="Maximum total average error.",
             value=0.10000000000000001,
             range=(0.0, 1.0, 0.01),
             uid=[0],
-            ),
+        ),
         desc.File(
-            name='debugRejectedImgFolder',
-            label='Debug Rejected Img Folder',
-            description='''Folder to export delete images during the refinement loop.''',
-            value='',
+            name="debugRejectedImgFolder",
+            label="Debug Rejected Img Folder",
+            description="Folder to export images that were deleted during the refinement loop.",
+            value="",
             uid=[0],
-            ),
+        ),
         desc.File(
-            name='debugSelectedImgFolder',
-            label='Debug Selected Img Folder',
-            description='''Folder to export debug images.''',
-            value='',
+            name="debugSelectedImgFolder",
+            label="Debug Selected Img Folder",
+            description="Folder to export debug images.",
+            value="",
             uid=[0],
-            ),
+        ),
+        desc.ChoiceParam(
+            name="verboseLevel",
+            label="Verbose Level",
+            description="Verbosity level (fatal, error, warning, info, debug, trace).",
+            value="info",
+            values=["fatal", "error", "warning", "info", "debug", "trace"],
+            exclusive=True,
+            uid=[],
+        ),
     ]
 
     outputs = [
         desc.File(
-            name='output',
-            label='Output',
-            description='''Output filename for intrinsic [and extrinsic] parameters.''',
-            value=desc.Node.internalFolder + '/cameraCalibration.cal',
+            name="output",
+            label="Output",
+            description="Output filename for intrinsic [and extrinsic] parameters.",
+            value=desc.Node.internalFolder + "/cameraCalibration.cal",
             uid=[],
-            ),
+        ),
     ]