[codeFactor] add SEMANTIC enum for attribute description

meshroom/core/desc.py

@@ -10,6 +10,12 @@
 import distutils.util
 import shlex
 
+class Semantic(Enum):
+    NONE = ""
+    IMAGE = "image"
+    MULTILINE = "multiline"
+    COLOR_HUE = "color/hue"
+
 class Attribute(BaseObject):
     """
     """
@@ -72,7 +78,7 @@ def matchDescription(self, value, strict=True):
 
 class ListAttribute(Attribute):
     """ A list of Attributes """
-    def __init__(self, elementDesc, name, label, description, group='allParams', advanced=False, semantic='', enabled=True, joinChar=' '):
+    def __init__(self, elementDesc, name, label, description, group='allParams', advanced=False, semantic=Semantic.NONE, enabled=True, joinChar=' '):
         """
         :param elementDesc: the Attribute description of elements to store in that list
         """
@@ -112,7 +118,7 @@ def matchDescription(self, value, strict=True):
 
 class GroupAttribute(Attribute):
     """ A macro Attribute composed of several Attributes """
-    def __init__(self, groupDesc, name, label, description, group='allParams', advanced=False, semantic='', enabled=True, joinChar=' ', brackets=None):
+    def __init__(self, groupDesc, name, label, description, group='allParams', advanced=False, semantic=Semantic.NONE, enabled=True, joinChar=' ', brackets=None):
         """
         :param groupDesc: the description of the Attributes composing this group
         """
@@ -213,7 +219,7 @@ def __init__(self, name, label, description, value, uid, group, advanced, semant
 class File(Attribute):
     """
     """
-    def __init__(self, name, label, description, value, uid, group='allParams', advanced=False, semantic='', enabled=True):
+    def __init__(self, name, label, description, value, uid, group='allParams', advanced=False, semantic=Semantic.NONE, enabled=True):
         super(File, self).__init__(name=name, label=label, description=description, value=value, uid=uid, group=group, advanced=advanced, semantic=semantic, enabled=enabled)
 
     def validateValue(self, value):
@@ -232,7 +238,7 @@ def checkValueTypes(self):
 class BoolParam(Param):
     """
     """
-    def __init__(self, name, label, description, value, uid, group='allParams', advanced=False, semantic='', enabled=True):
+    def __init__(self, name, label, description, value, uid, group='allParams', advanced=False, semantic=Semantic.NONE, enabled=True):
         super(BoolParam, self).__init__(name=name, label=label, description=description, value=value, uid=uid, group=group, advanced=advanced, semantic=semantic, enabled=enabled)
 
     def validateValue(self, value):
@@ -253,7 +259,7 @@ def checkValueTypes(self):
 class IntParam(Param):
     """
     """
-    def __init__(self, name, label, description, value, range, uid, group='allParams', advanced=False, semantic='', enabled=True):
+    def __init__(self, name, label, description, value, range, uid, group='allParams', advanced=False, semantic=Semantic.NONE, enabled=True):
         self._range = range
         super(IntParam, self).__init__(name=name, label=label, description=description, value=value, uid=uid, group=group, advanced=advanced, semantic=semantic, enabled=enabled)
 
@@ -275,7 +281,7 @@ def checkValueTypes(self):
 class FloatParam(Param):
     """
     """
-    def __init__(self, name, label, description, value, range, uid, group='allParams', advanced=False, semantic='', enabled=True):
+    def __init__(self, name, label, description, value, range, uid, group='allParams', advanced=False, semantic=Semantic.NONE, enabled=True):
         self._range = range
         super(FloatParam, self).__init__(name=name, label=label, description=description, value=value, uid=uid, group=group, advanced=advanced, semantic=semantic, enabled=enabled)
 
@@ -296,7 +302,7 @@ def checkValueTypes(self):
 class ChoiceParam(Param):
     """
     """
-    def __init__(self, name, label, description, value, values, exclusive, uid, group='allParams', joinChar=' ', advanced=False, semantic='', enabled=True):
+    def __init__(self, name, label, description, value, values, exclusive, uid, group='allParams', joinChar=' ', advanced=False, semantic=Semantic.NONE, enabled=True):
         assert values
         self._values = values
         self._exclusive = exclusive
@@ -334,7 +340,7 @@ def checkValueTypes(self):
 class StringParam(Param):
     """
     """
-    def __init__(self, name, label, description, value, uid, group='allParams', advanced=False, semantic='', enabled=True, uidIgnoreValue=None):
+    def __init__(self, name, label, description, value, uid, group='allParams', advanced=False, semantic=Semantic.NONE, enabled=True, uidIgnoreValue=None):
         super(StringParam, self).__init__(name=name, label=label, description=description, value=value, uid=uid, group=group, advanced=advanced, semantic=semantic, enabled=enabled,
             uidIgnoreValue=uidIgnoreValue)
 
@@ -352,7 +358,7 @@ def checkValueTypes(self):
 class ColorParam(Param):
     """
     """
-    def __init__(self, name, label, description, value, uid, group='allParams', advanced=False, semantic='', enabled=True):
+    def __init__(self, name, label, description, value, uid, group='allParams', advanced=False, semantic=Semantic.NONE, enabled=True):
         super(ColorParam, self).__init__(name=name, label=label, description=description, value=value, uid=uid, group=group, advanced=advanced, semantic=semantic, enabled=enabled)
 
     def validateValue(self, value):
@@ -512,7 +518,7 @@ class Node(object):
                         "This is useful for development, we can invalidate the output of the node when we modify the code.\n"
                         "It is displayed in bold font in the invalidation/comment messages tooltip.",
             value="",
-            semantic="multiline",
+            semantic=Semantic.MULTILINE,
             uid=[0],
             advanced=True,
             uidIgnoreValue="",  # If the invalidation string is empty, it does not participate to the node's UID
@@ -523,7 +529,7 @@ class Node(object):
             description="User comments describing this specific node instance.\n"
                         "It is displayed in regular font in the invalidation/comment messages tooltip.",
             value="",
-            semantic="multiline",
+            semantic=Semantic.MULTILINE,
             uid=[],
         ),
         StringParam(

meshroom/core/node.py

@@ -1132,7 +1132,7 @@ def hasImageOutputAttribute(self):
         Return True if at least one attribute has the 'image' semantic (and can thus be loaded in the 2D Viewer), False otherwise.
         """
         for attr in self._attributes:
-            if attr.enabled and attr.isOutput and attr.desc.semantic == "image":
+            if attr.enabled and attr.isOutput and attr.desc.semantic == desc.Semantic.IMAGE:
                 return True
         return False
 
@@ -1221,7 +1221,7 @@ def __init__(self, nodeType, position=None, parent=None, **kwargs):
 
         # List attributes per uid
         for attr in self._attributes:
-            if attr.isOutput and attr.desc.semantic == "image":
+            if attr.isOutput and attr.desc.semantic == desc.Semantic.IMAGE:
                 attr.enabledChanged.connect(self.outputAttrEnabledChanged)
             for uidIndex in attr.attributeDesc.uid:
                 self.attributesPerUid[uidIndex].add(attr)

meshroom/nodes/aliceVision/CheckerboardDetection.py

@@ -59,7 +59,7 @@ class CheckerboardDetection(desc.AVCommandLineNode):
             enabled= lambda node: node.exportDebugImages.value,
             label='Checker Lines',
             description='Debug Images.',
-            semantic='image',
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + '<VIEW_ID>.png',
             group='',  # do not export on the command line
             uid=[],

meshroom/nodes/aliceVision/DepthMap.py

@@ -616,7 +616,7 @@ class DepthMap(desc.AVCommandLineNode):
             name="depth",
             label="Depth Maps",
             description="Generated depth maps.",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "<VIEW_ID>_depthMap.exr",
             uid=[],
             group="", # do not export on the command line
@@ -625,7 +625,7 @@ class DepthMap(desc.AVCommandLineNode):
             name="sim",
             label="Sim Maps",
             description="Generated sim maps.",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "<VIEW_ID>_simMap.exr",
             uid=[],
             group="", # do not export on the command line
@@ -643,7 +643,7 @@ class DepthMap(desc.AVCommandLineNode):
             name="depthSgm",
             label="Depth Maps SGM",
             description="Debug: Depth maps SGM",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "<VIEW_ID>_depthMap_sgm.exr",
             uid=[],
             group="", # do not export on the command line
@@ -653,7 +653,7 @@ class DepthMap(desc.AVCommandLineNode):
             name="depthSgmUpscaled",
             label="Depth Maps SGM Upscaled",
             description="Debug: Depth maps SGM upscaled.",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "<VIEW_ID>_depthMap_sgmUpscaled.exr",
             uid=[],
             group="", # do not export on the command line
@@ -663,7 +663,7 @@ class DepthMap(desc.AVCommandLineNode):
             name="depthRefined",
             label="Depth Maps Refined",
             description="Debug: Depth maps after refinement",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "<VIEW_ID>_depthMap_refinedFused.exr",
             uid=[],
             group="", # do not export on the command line

meshroom/nodes/aliceVision/DepthMapFilter.py

@@ -135,7 +135,7 @@ class DepthMapFilter(desc.AVCommandLineNode):
             name="depth",
             label="Depth Maps",
             description="Filtered depth maps.",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "<VIEW_ID>_depthMap.exr",
             uid=[],
             group="",  # do not export on the command line
@@ -144,7 +144,7 @@ class DepthMapFilter(desc.AVCommandLineNode):
             name="sim",
             label="Sim Maps",
             description="Filtered sim maps.",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "<VIEW_ID>_simMap.exr",
             uid=[],
             group="",  # do not export on the command line

meshroom/nodes/aliceVision/ExportDistortion.py

@@ -32,7 +32,7 @@ class ExportDistortion(desc.AVCommandLineNode):
             name='distoStMap',
             label='Distortion ST Map',
             description='Calibrated distortion ST map.',
-            semantic='image',
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + '<INTRINSIC_ID>_distort.exr',
             group='',  # do not export on the command line
             uid=[],
@@ -41,7 +41,7 @@ class ExportDistortion(desc.AVCommandLineNode):
             name='undistoStMap',
             label='Undistortion ST Map',
             description='Calibrated undistortion ST map.',
-            semantic='image',
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + '<INTRINSIC_ID>_undistort.exr',
             group='',  # do not export on the command line
             uid=[],

meshroom/nodes/aliceVision/ImageMasking.py

@@ -44,7 +44,7 @@ class ImageMasking(desc.AVCommandLineNode):
                     label="Hue",
                     description="Hue value to isolate in [0,1] range.\n"
                                 "0 = red, 0.33 = green, 0.66 = blue, 1 = red.",
-                    semantic="color/hue",
+                    semantic=desc.Semantic.COLOR_HUE,
                     value=0.33,
                     range=(0.0, 1.0, 0.01),
                     uid=[0]

meshroom/nodes/aliceVision/ImageProcessing.py

@@ -656,7 +656,7 @@ class ImageProcessing(desc.AVCommandLineNode):
             name="outputImages",
             label="Images",
             description="Output images.",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value= outputImagesValueFunct,
             group="",  # do not export on the command line
             uid=[],

meshroom/nodes/aliceVision/ImageSegmentation.py

@@ -76,7 +76,7 @@ class ImageSegmentation(desc.AVCommandLineNode):
             name="masks",
             label="Masks",
             description="Generated segmentation masks.",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "<VIEW_ID>.exr",
             group="",
             uid=[],

meshroom/nodes/aliceVision/PanoramaMerging.py

@@ -78,7 +78,7 @@ class PanoramaMerging(desc.AVCommandLineNode):
             name="outputPanorama",
             label="Panorama",
             description="Output merged panorama image.",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "panorama.{outputFileTypeValue}",
             uid=[],
         ),

meshroom/nodes/aliceVision/PanoramaPostProcessing.py

@@ -99,15 +99,15 @@ class PanoramaPostProcessing(desc.CommandLineNode):
             name="outputPanorama",
             label="Output Panorama",
             description="Generated panorama in EXR format.",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "panorama.exr",
             uid=[],
         ),
         desc.File(
             name="outputPanoramaPreview",
             label="Output Panorama Preview",
             description="Preview of the generated panorama in JPG format.",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "panoramaPreview.jpg",
             uid=[],
         ),

meshroom/nodes/aliceVision/PanoramaSeams.py

@@ -63,7 +63,7 @@ class PanoramaSeams(desc.AVCommandLineNode):
             name="output",
             label="Labels",
             description="",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "labels.exr",
             uid=[],
         ),

meshroom/nodes/aliceVision/PhotometricStereo.py

@@ -121,7 +121,7 @@ class PhotometricStereo(desc.CommandLineNode):
             name="normals",
             label="Normal Maps Camera",
             description="Generated normal maps in the camera coordinate system.",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "<POSE_ID>_normals.exr",
             uid=[],
             group="", # do not export on the command line
@@ -130,7 +130,7 @@ class PhotometricStereo(desc.CommandLineNode):
             name="normalsWorld",
             label="Normal Maps World",
             description="Generated normal maps in the world coordinate system.",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "<POSE_ID>_normals_w.exr",
             uid=[],
             group="", # do not export on the command line
@@ -139,7 +139,7 @@ class PhotometricStereo(desc.CommandLineNode):
             name="albedo",
             label="Albedo Maps",
             description="Generated albedo maps.",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "<POSE_ID>_albedo.exr",
             uid=[],
             group="", # do not export on the command line

meshroom/nodes/aliceVision/PrepareDenseScene.py

@@ -103,7 +103,7 @@ class PrepareDenseScene(desc.AVCommandLineNode):
             name="undistorted",
             label="Undistorted Images",
             description="List of undistorted images.",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "<VIEW_ID>.{outputFileTypeValue}",
             uid=[],
             group="",

meshroom/nodes/blender/ScenePreview.py

@@ -133,7 +133,7 @@ class ScenePreview(desc.CommandLineNode):
             name="frames",
             label="Frames",
             description="Frames rendered in Blender.",
-            semantic="image",
+            semantic=desc.Semantic.IMAGE,
             value=desc.Node.internalFolder + "<FILENAME>_preview.jpg",
             uid=[],
             group="",