metric-fix (#1)

- Added a fix to the metric: corrected indexes mismatch, and added zeromean normalization (2633f6b0f66a8fa4edb6e5a9c77ca55b004ebc71)
- update metric (4a7e4e02fe8c2cbceb48e1c646c4d02996523634)
- update constants (5cd2bb760d54caa704cd189d2a204a6ff9eb31a7)
- Cleaned-up, and added diameter-based cv cost (d7cb5e40aa3a01ee8d5358eca2258e6799b99d41)
- Merge branch 'metric-fix' into pr/1 (4a295c28cfbba070667a9d7edc736fb30c96bd1b)
- tweak docs (57535bbad2d6fc63d5fba90159e1fb47170d42c0)
- tweak docs more (c3c7e12032769b9469ca9e4f9ada6830d219be7f)


Co-authored-by: Jack Langerman <jacklangerman@users.noreply.huggingface.co>

hoho/vis.py

@@ -133,7 +133,8 @@ def create_image_grid(images, target_length=312, num_per_row=2):
     return grid_img
 
 
-import matplotlib
+import matplotlib.pyplot as plt
+
 def visualize_depth(depth, min_depth=None, max_depth=None, cmap='rainbow'):
     depth = np.array(depth)
     
@@ -148,7 +149,7 @@ def visualize_depth(depth, min_depth=None, max_depth=None, cmap='rainbow'):
     depth = np.clip(depth, 0, 1)
     
     # Use the matplotlib colormap to convert the depth to an RGB image
-    cmap = matplotlib.cm.get_cmap(cmap)
+    cmap = plt.get_cmap(cmap)
     depth_image = (cmap(depth) * 255).astype(np.uint8)
     
     # Convert the depth image to a PIL image

hoho/wed.py

@@ -2,43 +2,94 @@ from scipy.spatial.distance import cdist
 from scipy.optimize import linear_sum_assignment
 import numpy as np 
 
-def compute_WED(pd_vertices, pd_edges, gt_vertices, gt_edges, cv=1.0, ce=1.0, normalized=True, squared=False):
+
+def preregister_mean_std(verts_to_transform, target_verts, single_scale=True):
+    mu_target = target_verts.mean(axis=0)
+    mu_in = verts_to_transform.mean(axis=0)
+    std_target = np.std(target_verts, axis=0)
+    std_in = np.std(verts_to_transform, axis=0)
+    
+    if np.any(std_in == 0):
+        std_in[std_in == 0] = 1
+    if np.any(std_target == 0):
+        std_target[std_target == 0] = 1
+    if np.any(np.isnan(std_in)):
+        std_in[np.isnan(std_in)] = 1
+    if np.any(np.isnan(std_target)):
+        std_target[np.isnan(std_target)] = 1
+        
+    if single_scale:
+        std_target = np.linalg.norm(std_target)
+        std_in = np.linalg.norm(std_in)
+    
+    transformed_verts = (verts_to_transform - mu_in) / std_in
+    transformed_verts = transformed_verts * std_target + mu_target
+    
+    return transformed_verts
+
+
+def compute_WED(pd_vertices, pd_edges, gt_vertices, gt_edges, cv=-1, ce=1.0, normalized=True, preregister=True, single_scale=True):
+    '''The function computes the Wireframe Edge Distance (WED) between two graphs.
+    pd_vertices: list of predicted vertices
+    pd_edges: list of predicted edges
+    gt_vertices: list of ground truth vertices
+    gt_edges: list of ground truth edges
+    cv: vertex cost (the cost in centimeters of missing a vertex, default is -1, which means 1/4 of the diameter of the ground truth mesh)
+    ce: edge cost (multiplier of the edge length for edge deletion and insertion, default is 1.0)
+    normalized: if True, the WED is normalized by the total length of the ground truth edges
+    preregister: if True, the predicted vertices have their mean and scale matched to the ground truth vertices
+    '''
+    
+    # Vertex coordinates are in centimeters. When cv and ce are set to 100.0 and 1.0 respectively, 
+    # missing a vertex is equivanlent predicting it 1 meter away from the ground truth vertex.
+    # This is equivalent to setting cv=1 and ce=1 when the vertex coordinates are in meters.
+    # When a negative cv value is set (the default behavior), cv is reset to 1/4 of the diameter of the ground truth wireframe.
+    
     pd_vertices = np.array(pd_vertices)
     gt_vertices = np.array(gt_vertices)
+    
+    diameter = cdist(gt_vertices, gt_vertices).max()
+    
+    if cv < 0:
+        cv = diameter / 4.0 
+        # Cost of addining or deleting a vertex is set to 1/4 of the diameter of the ground truth mesh
+    
+    # Step 0: Prenormalize / preregister
+    if preregister:
+        pd_vertices = preregister_mean_std(pd_vertices, gt_vertices, single_scale=single_scale)
+        
+
     pd_edges = np.array(pd_edges)
-    gt_edges = np.array(gt_edges)
+    gt_edges = np.array(gt_edges)        
     
     # Step 1: Bipartite Matching
-    if squared:
-        distances = cdist(pd_vertices, gt_vertices, metric='sqeuclidean')
-    else:
-        distances = cdist(pd_vertices, gt_vertices, metric='euclidean')
-
+    distances = cdist(pd_vertices, gt_vertices, metric='euclidean')
     row_ind, col_ind = linear_sum_assignment(distances)
+        
     
     # Step 2: Vertex Translation
-    
-    if squared:
-        translation_costs = cv * np.sqrt(np.sum(distances[row_ind, col_ind]))
-    else:
-        translation_costs = cv * np.sum(distances[row_ind, col_ind])
+    translation_costs = np.sum(distances[row_ind, col_ind])
     
     # Additional: Vertex Deletion
     unmatched_pd_indices = set(range(len(pd_vertices))) - set(row_ind)
-    deletion_costs = cv * len(unmatched_pd_indices)  # Assuming a fixed cost for vertex deletion
+    deletion_costs = cv * len(unmatched_pd_indices)  
     
     # Step 3: Vertex Insertion
     unmatched_gt_indices = set(range(len(gt_vertices))) - set(col_ind)
-    insertion_costs = cv * len(unmatched_gt_indices)  # Assuming a fixed cost for vertex insertion
+    insertion_costs = cv * len(unmatched_gt_indices)  
     
     # Step 4: Edge Deletion and Insertion
-    updated_pd_edges = [(row_ind[np.where(col_ind == edge[0])[0][0]], row_ind[np.where(col_ind == edge[1])[0][0]]) for edge in pd_edges if edge[0] in col_ind and edge[1] in col_ind]
-    pd_edges_set = set(map(tuple, updated_pd_edges))
-    gt_edges_set = set(map(tuple, gt_edges))
+    updated_pd_edges = [(col_ind[np.where(row_ind == edge[0])[0][0]], col_ind[np.where(row_ind == edge[1])[0][0]]) for edge in pd_edges if edge[0] in row_ind and edge[1] in row_ind]
+    pd_edges_set = set(map(tuple, [set(edge) for edge in updated_pd_edges]))
+    gt_edges_set = set(map(tuple, [set(edge) for edge in gt_edges]))
+
     
     # Delete edges not in ground truth
     edges_to_delete = pd_edges_set - gt_edges_set
-    deletion_edge_costs = ce * sum(np.linalg.norm(pd_vertices[edge[0]] - pd_vertices[edge[1]]) for edge in edges_to_delete)
+    
+    vert_tf = [np.where(col_ind == v)[0][0] if v in col_ind else 0 for v in range(len(gt_vertices))]
+    deletion_edge_costs = ce * sum(np.linalg.norm(pd_vertices[vert_tf[edge[0]]] - pd_vertices[vert_tf[edge[1]]]) for edge in edges_to_delete)
+
     
     # Insert missing edges from ground truth
     edges_to_insert = gt_edges_set - pd_edges_set
@@ -46,9 +97,11 @@ def compute_WED(pd_vertices, pd_edges, gt_vertices, gt_edges, cv=1.0, ce=1.0, no
     
     # Step 5: Calculation of WED
     WED = translation_costs + deletion_costs + insertion_costs + deletion_edge_costs + insertion_edge_costs
+
     
     if normalized:
         total_length_of_gt_edges = np.linalg.norm((gt_vertices[gt_edges[:, 0]] - gt_vertices[gt_edges[:, 1]]), axis=1).sum()
         WED = WED / total_length_of_gt_edges
-       
+        
+    # print ("Total length", total_length_of_gt_edges)
     return WED

requirements.txt

@@ -1,8 +1,10 @@
+datasets
+ipywidgets
+matplotlib
 numpy
 pillow
-webdataset
-trimesh
-scipy
-datasets
+plotly
 pycolmap
-plotly
+scipy
+trimesh
+webdataset

setup.py

@@ -6,7 +6,7 @@ with open('requirements.txt') as f:
     required = f.read().splitlines()
 
 setup(name='hoho',
-	version='0.0.2',
+	version='0.0.3',
 	description='Tools and utilites for the HoHo Dataset and S23DR Competition',
 	url='usm3d.github.io',
 	author='Jack Langerman, Dmytro Mishkin, S23DR Orgainizing Team',