3pp-mirror/Meshroom
1
0
Fork 0
mirror of https://github.com/alicevision/Meshroom.git synced 2025-06-12 07:42:04 +02:00
Code Issues Projects Releases Packages Wiki Activity

[nodes] Clean-up: Harmonize nodes' descriptions

Browse source
This commit is contained in:
Candice Bentéjac 2023-10-17 15:43:34 +02:00
parent e463f0dce2
commit f2d6770651
25 changed files with 173 additions and 173 deletions
Download patch file Download diff file Expand all files Collapse all files

14
meshroom/nodes/aliceVision/CameraInit.py
View file

@ -38,8 +38,8 @@ Intrinsic = [
value=-1.0, uid=[0], range=None), value=-1.0, uid=[0], range=None),
desc.FloatParam(name="focalLength", label="Focal Length", description="Known/calibrated focal length (in mm).", value=1000.0, uid=[0], range=(0.0, 10000.0, 1.0)), desc.FloatParam(name="focalLength", label="Focal Length", description="Known/calibrated focal length (in mm).", value=1000.0, uid=[0], range=(0.0, 10000.0, 1.0)),
desc.FloatParam(name="pixelRatio", label="Pixel Ratio", description="Ratio between the pixel width and the pixel height.", value=1.0, uid=[0], range=(0.0, 10.0, 0.1)), desc.FloatParam(name="pixelRatio", label="Pixel Ratio", description="Ratio between the pixel width and the pixel height.", value=1.0, uid=[0], range=(0.0, 10.0, 0.1)),
desc.BoolParam(name='pixelRatioLocked', label='Pixel Ratio Locked', desc.BoolParam(name="pixelRatioLocked", label="Pixel Ratio Locked",
description='The pixel ratio value is locked for estimation.', description="The pixel ratio value is locked for estimation.",
value=True, uid=[0]), value=True, uid=[0]),
desc.ChoiceParam(name="type", label="Camera Type", desc.ChoiceParam(name="type", label="Camera Type",
description="Mathematical model used to represent a camera:\n" description="Mathematical model used to represent a camera:\n"
@ -241,7 +241,7 @@ The needed metadata are:
desc.ChoiceParam( desc.ChoiceParam(
name="allowedCameraModels", name="allowedCameraModels",
label="Allowed Camera Models", label="Allowed Camera Models",
description='List of the camera models that can be attributed.', description="List of the camera models that can be attributed.",
value=["pinhole", "radial1", "radial3", "brown", "fisheye4", "fisheye1", "3deanamorphic4", "3deradial4", "3declassicld"], value=["pinhole", "radial1", "radial3", "brown", "fisheye4", "fisheye1", "3deanamorphic4", "3deradial4", "3declassicld"],
values=["pinhole", "radial1", "radial3", "brown", "fisheye4", "fisheye1", "3deanamorphic4", "3deradial4", "3declassicld"], values=["pinhole", "radial1", "radial3", "brown", "fisheye4", "fisheye1", "3deanamorphic4", "3deradial4", "3declassicld"],
exclusive=False, exclusive=False,
@ -320,10 +320,10 @@ The needed metadata are:
outputs = [ outputs = [
desc.File( desc.File(
name='output', name="output",
label='SfMData', label="SfMData",
description='''Output SfMData.''', description="Output SfMData.",
value=desc.Node.internalFolder + 'cameraInit.sfm', value=desc.Node.internalFolder + "cameraInit.sfm",
uid=[], uid=[],
), ),
] ]

2
meshroom/nodes/aliceVision/CameraRigCalibration.py
View file

@ -14,7 +14,7 @@ class CameraRigCalibration(desc.AVCommandLineNode):
inputs = [ inputs = [
desc.File( desc.File(
name="sfmdata", name="sfmdata",
label='SfMData', label="SfMData",
description="Input SfMData file.", description="Input SfMData file.",
value="", value="",
uid=[0], uid=[0],

44
meshroom/nodes/aliceVision/CheckerboardDetection.py
View file

@ -17,30 +17,30 @@ The detection method also supports nested calibration grids.
inputs = [ inputs = [
desc.File( desc.File(
name='input', name="input",
label='Input', label="Input",
description='SfMData File. Viewpoints must correspond to lens calibration grids.', description="Input SfMData file. Viewpoints must correspond to lens calibration grids.",
value='', value="",
uid=[0], uid=[0],
), ),
desc.BoolParam( desc.BoolParam(
name='useNestedGrids', name="useNestedGrids",
label='Nested calibration grid', label="Nested Calibration Grid",
description='Images contain nested calibration grids. These grids must be centered on the image center.', description="Enable if images contain nested calibration grids. These grids must be centered on the image center.",
value=False, value=False,
uid=[0], uid=[0],
), ),
desc.BoolParam( desc.BoolParam(
name='doubleSize', name="doubleSize",
label='Double Size', label="Double Size",
description='Double the image size prior to processing', description="Double the image size prior to processing.",
value=False, value=False,
uid=[0], uid=[0],
), ),
desc.BoolParam( desc.BoolParam(
name='exportDebugImages', name="exportDebugImages",
label='Export Debug Images', label="Export Debug Images",
description='Export Debug Images', description="Export debug images.",
value=False, value=False,
uid=[0], uid=[0],
), ),
@ -48,20 +48,20 @@ The detection method also supports nested calibration grids.
outputs = [ outputs = [
desc.File( desc.File(
name='output', name="output",
label='Folder', label="Folder",
description='', description="Output folder.",
value=desc.Node.internalFolder, value=desc.Node.internalFolder,
uid=[], uid=[],
), ),
desc.File( desc.File(
name='checkerLines', name="checkerLines",
enabled=lambda node: node.exportDebugImages.value, enabled=lambda node: node.exportDebugImages.value,
label='Checker Lines', label="Checker Lines",
description='Debug Images.', description="Debug images.",
semantic='image', semantic="image",
value=desc.Node.internalFolder + '<VIEW_ID>.png', value=desc.Node.internalFolder + "<VIEW_ID>.png",
group='', # do not export on the command line group="", # do not export on the command line
uid=[], uid=[],
), ),
] ]

4
meshroom/nodes/aliceVision/ConvertMesh.py
View file

@ -19,10 +19,10 @@ class ConvertMesh(desc.AVCommandLineNode):
), ),
desc.ChoiceParam( desc.ChoiceParam(
name="outputMeshFileType", name="outputMeshFileType",
label="File Type", label="Output File Type",
description="Output mesh format (*.obj, *.gltf, *.fbx, *.stl).", description="Output mesh format (*.obj, *.gltf, *.fbx, *.stl).",
value="obj", value="obj",
values=("gltf", "obj", "fbx", "stl"), values=["gltf", "obj", "fbx", "stl"],
exclusive=True, exclusive=True,
uid=[0], uid=[0],
group="", group="",

2
meshroom/nodes/aliceVision/ConvertSfMFormat.py
View file

@ -17,7 +17,7 @@ It can also be used to remove specific parts of from an SfM scene (like filter a
desc.File( desc.File(
name="input", name="input",
label="Input", label="Input",
description="SfMData file.", description="Input SfMData file.",
value="", value="",
uid=[0], uid=[0],
), ),

38
meshroom/nodes/aliceVision/ExportDistortion.py
View file

@ -12,38 +12,38 @@ Export the distortion model and parameters of cameras in a SfM scene.
inputs = [ inputs = [
desc.File( desc.File(
name='input', name="input",
label='Input SfMData', label="Input SfMData",
description='SfMData file.', description="Input SfMData file.",
value='', value="",
uid=[0], uid=[0],
), ),
] ]
outputs = [ outputs = [
desc.File( desc.File(
name='output', name="output",
label='Folder', label="Folder",
description='Output folder.', description="Output folder.",
value=desc.Node.internalFolder, value=desc.Node.internalFolder,
uid=[], uid=[],
), ),
desc.File( desc.File(
name='distoStMap', name="distoStMap",
label='Distortion ST Map', label="Distortion ST Map",
description='Calibrated distortion ST map.', description="Calibrated distortion ST map.",
semantic='image', semantic="image",
value=desc.Node.internalFolder + '<INTRINSIC_ID>_distort.exr', value=desc.Node.internalFolder + "<INTRINSIC_ID>_distort.exr",
group='', # do not export on the command line group="", # do not export on the command line
uid=[], uid=[],
), ),
desc.File( desc.File(
name='undistoStMap', name="undistoStMap",
label='Undistortion ST Map', label="Undistortion ST Map",
description='Calibrated undistortion ST map.', description="Calibrated undistortion ST map.",
semantic='image', semantic="image",
value=desc.Node.internalFolder + '<INTRINSIC_ID>_undistort.exr', value=desc.Node.internalFolder + "<INTRINSIC_ID>_undistort.exr",
group='', # do not export on the command line group="", # do not export on the command line
uid=[], uid=[],
), ),
] ]

16
meshroom/nodes/aliceVision/ImageProcessing.py
View file

@ -413,7 +413,7 @@ Convert or apply filtering to the input images.
desc.BoolParam( desc.BoolParam(
name="nlmFilterEnabled", name="nlmFilterEnabled",
label="Enable", label="Enable",
description='Use Non-Local Mean Denoising from OpenCV to denoise images.', description="Use Non-Local Mean Denoising from OpenCV to denoise images.",
value=False, value=False,
uid=[0], uid=[0],
), ),
@ -587,17 +587,17 @@ Convert or apply filtering to the input images.
), ),
desc.File( desc.File(
name='lensCorrectionProfileInfo', name="lensCorrectionProfileInfo",
label='Lens Correction Profile Info', label="Lens Correction Profile Info",
description='''Lens Correction Profile filepath or database directory.''', description="Lens Correction Profile filepath or database directory.",
value='${ALICEVISION_LENS_PROFILE_INFO}', value="${ALICEVISION_LENS_PROFILE_INFO}",
uid=[], uid=[],
), ),
desc.BoolParam( desc.BoolParam(
name='lensCorrectionProfileSearchIgnoreCameraModel', name="lensCorrectionProfileSearchIgnoreCameraModel",
label='LCP Generic Search', label="LCP Generic Search",
description='The lens name and camera maker are used to match the LCP database, but the camera model is ignored.', description="The lens name and camera maker are used to match the LCP database, but the camera model is ignored.",
value=True, value=True,
uid=[0], uid=[0],
advanced=True, advanced=True,

16
meshroom/nodes/aliceVision/LdrToHdrMerge.py
View file

@ -101,26 +101,26 @@ Merge LDR images into HDR images.
enabled=lambda node: (node.nbBrackets.value != 1 and not node.offsetRefBracketIndexEnabled.value), enabled=lambda node: (node.nbBrackets.value != 1 and not node.offsetRefBracketIndexEnabled.value),
), ),
desc.FloatParam( desc.FloatParam(
name='minSignificantValue', name="minSignificantValue",
label='Minimum Significant Value', label="Minimum Significant Value",
description='Minimum channel input value to be considered in advanced pixelwise merging.', description="Minimum channel input value to be considered in advanced pixelwise merging.",
value=0.05, value=0.05,
range=(0.0, 1.0, 0.001), range=(0.0, 1.0, 0.001),
uid=[0], uid=[0],
enabled=lambda node: (node.nbBrackets.value != 1), enabled=lambda node: (node.nbBrackets.value != 1),
), ),
desc.FloatParam( desc.FloatParam(
name='maxSignificantValue', name="maxSignificantValue",
label='Maximum Significant Value', label="Maximum Significant Value",
description='Maximum channel input value to be considered in advanced pixelwise merging.', description="Maximum channel input value to be considered in advanced pixelwise merging.",
value=0.995, value=0.995,
range=(0.0, 1.0, 0.001), range=(0.0, 1.0, 0.001),
uid=[0], uid=[0],
enabled=lambda node: (node.nbBrackets.value != 1), enabled=lambda node: (node.nbBrackets.value != 1),
), ),
desc.BoolParam( desc.BoolParam(
name='computeLightMasks', name="computeLightMasks",
label='Compute Light Masks', label="Compute Light Masks",
description="Compute masks of low and high lights and missing info.", description="Compute masks of low and high lights and missing info.",
value=False, value=False,
uid=[0], uid=[0],

2
meshroom/nodes/aliceVision/LightingCalibration.py
View file

@ -14,7 +14,7 @@ Can also be used to calibrate a lighting dome (RTI type).
inputs = [ inputs = [
desc.File( desc.File(
name="inputPath", name="inputPath",
label="SfMData", label="Input SfMData",
description="Input SfMData file.", description="Input SfMData file.",
value="", value="",
uid=[0] uid=[0]

2
meshroom/nodes/aliceVision/LightingEstimation.py
View file

@ -13,7 +13,7 @@ class LightingEstimation(desc.AVCommandLineNode):
inputs = [ inputs = [
desc.File( desc.File(
name="input", name="input",
label="SfMData", label="Input SfMData",
description="Input SfMData file.", description="Input SfMData file.",
value="", value="",
uid=[0], uid=[0],

2
meshroom/nodes/aliceVision/MeshResampling.py
View file

@ -39,7 +39,7 @@ This node allows to recompute the mesh surface with a new topology and uniform d
), ),
desc.IntParam( desc.IntParam(
name="minVertices", name="minVertices",
label='Min Vertices', label="Min Vertices",
description="Minimum number of output vertices.", description="Minimum number of output vertices.",
value=0, value=0,
range=(0, 1000000, 1), range=(0, 1000000, 1),

2
meshroom/nodes/aliceVision/Meshing.py
View file

@ -326,7 +326,7 @@ A Graph Cut Max-Flow is applied to optimally cut the volume. This cut represents
), ),
desc.IntParam( desc.IntParam(
name="helperPointsGridSize", name="helperPointsGridSize",
label='Helper Points Grid Size', label="Helper Points Grid Size",
description="Grid size for the helper points.", description="Grid size for the helper points.",
value=10, value=10,
range=(0, 50, 1), range=(0, 50, 1),

54
meshroom/nodes/aliceVision/NodalSfM.py
View file

@ -14,10 +14,10 @@ A Structure-From-Motion node specifically designed to handle pure rotation camer
inputs = [ inputs = [
desc.File( desc.File(
name='input', name="input",
label='SfMData', label="SfMData",
description='SfMData file.', description="Input SfMData file.",
value='', value="",
uid=[0], uid=[0],
), ),
desc.ListAttribute( desc.ListAttribute(
@ -33,35 +33,35 @@ A Structure-From-Motion node specifically designed to handle pure rotation camer
description="Folder(s) containing the extracted features and descriptors." description="Folder(s) containing the extracted features and descriptors."
), ),
desc.File( desc.File(
name='tracksFilename', name="tracksFilename",
label='Tracks file', label="Tracks File",
description='Tracks file.', description="Input tracks file.",
value='', value="",
uid=[0], uid=[0],
), ),
desc.File( desc.File(
name='pairs', name="pairs",
label='Pairs file', label="Pairs File",
description='Information on pairs.', description="Information on pairs.",
value='', value="",
uid=[0], uid=[0],
), ),
desc.ChoiceParam( desc.ChoiceParam(
name='describerTypes', name="describerTypes",
label='Describer Types', label="Describer Types",
description='Describer types used to describe an image.', description="Describer types used to describe an image.",
value=['dspsift'], value=["dspsift"],
values=['sift', 'sift_float', 'sift_upright', 'dspsift', 'akaze', 'akaze_liop', 'akaze_mldb', 'cctag3', 'cctag4', 'sift_ocv', 'akaze_ocv', 'tag16h5'], values=["sift", "sift_float", "sift_upright", "dspsift", "akaze", "akaze_liop", "akaze_mldb", "cctag3", "cctag4", "sift_ocv", "akaze_ocv", "tag16h5"],
exclusive=False, exclusive=False,
uid=[0], uid=[0],
joinChar=',', joinChar=",",
), ),
desc.ChoiceParam( desc.ChoiceParam(
name='verboseLevel', name="verboseLevel",
label='Verbose Level', label="Verbose Level",
description='Verbosity level (fatal, error, warning, info, debug, trace).', description="Verbosity level (fatal, error, warning, info, debug, trace).",
value='info', value="info",
values=['fatal', 'error', 'warning', 'info', 'debug', 'trace'], values=["fatal", "error", "warning", "info", "debug", "trace"],
exclusive=True, exclusive=True,
uid=[], uid=[],
) )
@ -69,10 +69,10 @@ A Structure-From-Motion node specifically designed to handle pure rotation camer
outputs = [ outputs = [
desc.File( desc.File(
name='output', name="output",
label='SfMData', label="SfMData",
description='Path to the output sfmdata file', description="Path to the output SfMData file.",
value=desc.Node.internalFolder + 'sfm.abc', value=desc.Node.internalFolder + "sfm.abc",
uid=[], uid=[],
) )
] ]

2
meshroom/nodes/aliceVision/PanoramaMerging.py
View file

@ -22,7 +22,7 @@ Merge all inputs coming from the PanoramaCompositing node.
name="input", name="input",
label="Input SfMData", label="Input SfMData",
description="Input SfMData file.", description="Input SfMData file.",
value='', value="",
uid=[0], uid=[0],
), ),
desc.File( desc.File(

2
meshroom/nodes/aliceVision/PanoramaPostProcessing.py
View file

@ -135,6 +135,6 @@ Post process the panorama.
description="Downscaled versions of the generated panorama.", description="Downscaled versions of the generated panorama.",
value=lambda attr: desc.Node.internalFolder + os.path.splitext(attr.node.panoramaName.value)[0] + "_level_*.exr", value=lambda attr: desc.Node.internalFolder + os.path.splitext(attr.node.panoramaName.value)[0] + "_level_*.exr",
uid=[], uid=[],
group='', group="",
), ),
] ]

2
meshroom/nodes/aliceVision/Publish.py
View file

@ -22,7 +22,7 @@ This node allows to copy files into a specific folder.
elementDesc=desc.File( elementDesc=desc.File(
name="input", name="input",
label="Input", label="Input",
description="", description="File or folder to publish.",
value="", value="",
uid=[0], uid=[0],
), ),

40
meshroom/nodes/aliceVision/SfMSplitReconstructed.py
View file

@ -9,25 +9,25 @@ class SfMSplitReconstructed(desc.AVCommandLineNode):
category = 'Utils' category = 'Utils'
documentation = ''' documentation = '''
This nodes takes a sfmData file and split it in two This nodes takes a SfMData file as an input and splits it in two output SfMData files:
- One sfmData with the reconstructed views - One SfMData containing the reconstructed views
- One sfmData with the non reconstructed views - One SfMData containing the non-reconstructed views
''' '''
inputs = [ inputs = [
desc.File( desc.File(
name='input', name="input",
label='Input', label="Input SfMData",
description='''SfMData file .''', description="Input SfMData file.",
value='', value="",
uid=[0], uid=[0],
), ),
desc.ChoiceParam( desc.ChoiceParam(
name='verboseLevel', name="verboseLevel",
label='Verbose Level', label="Verbose Level",
description='''verbosity level (fatal, error, warning, info, debug, trace).''', description="Verbosity level (fatal, error, warning, info, debug, trace).",
value='info', value="info",
values=['fatal', 'error', 'warning', 'info', 'debug', 'trace'], values=["fatal", "error", "warning", "info", "debug", "trace"],
exclusive=True, exclusive=True,
uid=[], uid=[],
), ),
@ -35,17 +35,17 @@ class SfMSplitReconstructed(desc.AVCommandLineNode):
outputs = [ outputs = [
desc.File( desc.File(
name='reconstructedOutput', name="reconstructedOutput",
label='Reconstructed SfMData File', label="Reconstructed SfMData File",
description='SfMData file with reconstructed cameras', description="SfMData file containing the reconstructed cameras.",
value=desc.Node.internalFolder + 'sfmReconstructed.abc', value=desc.Node.internalFolder + "sfmReconstructed.abc",
uid=[], uid=[],
), ),
desc.File( desc.File(
name='notReconstructedOutput', name="notReconstructedOutput",
label='Not Reconstructed SfMData File', label="Not Reconstructed SfMData File",
description='SfMData file with non reconstructed cameras', description="SfMData file containing the non-reconstructed cameras.",
value=desc.Node.internalFolder + 'sfmNonReconstructed.abc', value=desc.Node.internalFolder + "sfmNonReconstructed.abc",
uid=[], uid=[],
) )
] ]

2
meshroom/nodes/aliceVision/SfMTriangulation.py
View file

@ -131,7 +131,7 @@ Contrary to the StructureFromMotion node, this node does not infer the camera po
), ),
desc.ChoiceParam( desc.ChoiceParam(
name="interFileExtension", name="interFileExtension",
label='Inter File Extension', label="Inter File Extension",
description="Extension of the intermediate file export.", description="Extension of the intermediate file export.",
value=".abc", value=".abc",
values=(".abc", ".ply"), values=(".abc", ".ply"),

4
meshroom/nodes/aliceVision/Split360Images.py
View file

@ -31,7 +31,7 @@ class Split360Images(desc.AVCommandLineNode):
name="input", name="input",
label="Input", label="Input",
description="Single image, image folder or SfMData file.", description="Single image, image folder or SfMData file.",
value='', value="",
uid=[0], uid=[0],
), ),
desc.ChoiceParam( desc.ChoiceParam(
@ -80,7 +80,7 @@ class Split360Images(desc.AVCommandLineNode):
groupDesc=[ groupDesc=[
desc.IntParam( desc.IntParam(
name="equirectangularNbSplits", name="equirectangularNbSplits",
label='Nb Splits', label="Nb Splits",
description="Equirectangular number of splits.", description="Equirectangular number of splits.",
value=2, value=2,
range=(1, 100, 1), range=(1, 100, 1),

4
meshroom/nodes/aliceVision/StructureFromMotion.py
View file

@ -65,7 +65,7 @@ It iterates like that, adding cameras and triangulating new 2D features into 3D
desc.File( desc.File(
name="input", name="input",
label="SfMData", label="SfMData",
description='SfMData file.', description="Input SfMData file.",
value="", value="",
uid=[0], uid=[0],
), ),
@ -323,7 +323,7 @@ It iterates like that, adding cameras and triangulating new 2D features into 3D
), ),
desc.IntParam( desc.IntParam(
name="minNbCamerasToRefinePrincipalPoint", name="minNbCamerasToRefinePrincipalPoint",
label='Min Nb Cameras To Refine Principal Point', label="Min Nb Cameras To Refine Principal Point",
description="Minimum number of cameras to refine the principal point of the cameras (one of the intrinsic parameters of the camera).\n" description="Minimum number of cameras to refine the principal point of the cameras (one of the intrinsic parameters of the camera).\n"
"If we do not have enough cameras, the principal point is considered to be in the center of the image.\n" "If we do not have enough cameras, the principal point is considered to be in the center of the image.\n"
"If minNbCamerasToRefinePrincipalPoint <= 0, the principal point is never refined." "If minNbCamerasToRefinePrincipalPoint <= 0, the principal point is never refined."