Differences

This shows you the differences between two versions of the page.

--- visual3d:documentation:pipeline:signal_commands:compute_distance_map [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:signal_commands:compute_distance_map [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{{{{{{{{{{{{{{{====== compute distance map ======
+====== Compute Distance Map ======
-this command will color two regions of interest (roi) on opposing segments, and calculate the weighted-average contact point on each one. the rois are defined in obj files created with dsx.
+===== Compute Distance Map =====
-distance maps:
+This command will color two regions of interest (ROI) on opposing segments, and calculate the weighted-average contact point on each one. The ROIs are defined in OBJ files created with DSX.
-  * each vertex is colored according to its closest distance to the other surface (which can be to a vertex, edge, or triangle of the other surface). smooth shading is used so that a triangle's color is a linear combination of the colors of its three vertices.
+Distance maps:
-contact point:
+  * Each vertex is colored according to its closest distance to the other surface (which can be to a vertex, edge, or triangle of the other surface). Smooth shading is used so that a triangle's color is a linear combination of the colors of its three vertices.
-  * the overall minimum distance is calculated ([[#minimum_distance|_min]])
+Contact point:
-  * the contact point is the weighted minimum distance ([[#contact_path|_contact]])
+  * The overall minimum distance is calculated ([[#Minimum_Distance|_Min]])
+  * The contact point is the weighted minimum distance ([[#Contact_Path|_Contact]])
 \\
-===== background =====
+==== Background ====
-a polygonal surface mesh is defined by a set of faces, each of which is defined by a set of vertices connected by edges. before computing distances, the compute distance map command divides all faces of the rois into triangles, for easier processing and to guarantee that all faces are planar. in the image below, the left image highlights the vertices used to define a surface and the right image displays the triangles that define the surface:
+A polygonal surface mesh is defined by a set of faces, each of which is defined by a set of vertices connected by edges. Before computing distances, the Compute Distance Map command divides all faces of the ROIs into triangles, for easier processing and to guarantee that all faces are planar. In the image below, the left image highlights the vertices used to define a surface and the right image displays the triangles that define the surface:
-compute_distance_map_vertex_triangles.png
+{{:compute_distance_map_vertex_triangles.png}}
-a normal vector is defined for each triangle, vertex and edge:
+A normal vector is defined for each triangle, vertex and edge:
-normals|{{/images/thumb/7/78/compute_distance_map_normals.png
+{{:normals|{{/images/thumb/7/78/compute_distance_map_normals.png}}
-===== command output =====
+==== Command Output ====
 ****
 ****
-|for every result name specified, there will be 6 results:\\ \\ * resultname_segmentname[[#minimum_distance|_min]]\\ * resultname_segmentname[[#contact_path|_contact]]\\ * resultname_segmentname[[#min_vertex_distances|_vert]]  |  compute_distance_map_data_tree.png|
+|For every Result Name specified, there will be 6 results:\\ \\ * ResultName_SegmentName[[#Minimum_Distance|_Min]]\\ * ResultName_SegmentName[[#Contact_Path|_Contact]]\\ * ResultName_SegmentName[[#Min_Vertex_Distances|_Vert]]  |  {{:compute_distance_map_data_tree.png}}|
 ****
 ****
-the result for _min and _contact will have 4 components. the first three components are x y z location of the contact point in the segment coordinate system, and the fourth component is the minimum distance. you can use the [[visual3d:documentation:pipeline:signal_commands:transform_data_coordinate_system|transform_data_coordinate_system]] command to transform the resulting coordinate system of the contact point.
+The result for _Min and _Contact will have 4 components. The first three components are X Y Z location of the contact point in the segment coordinate system, and the fourth component is the minimum distance. You can use the [[Visual3D:Documentation:Pipeline:Signal_Commands:Transform_Data_Coordinate_System|Transform_Data_Coordinate_System]] command to transform the resulting coordinate system of the contact point.
+=== Minimum Distance ===
-==== minimum distance ====
+|The minimum distance between each triangle on one segment's ROI and the opposing segment's ROI.\\ \\ * A single distance value is calculated for each triangle, and is the smallest value of these candidates:\\   * (a) the distance from the opposing ROI to the closest of the triangle's vertices\\   * (b) the distance from the closest vertex on the opposing ROI that projects onto the face of the triangle (left image)\\   * (c) the distance from the closest vertex on the opposing ROI that projects onto an edge of the triangle (right image)  |  {{:compute_distance_map_min_distance_calc.png}}|
-|the minimum distance between each triangle on one segment's roi and the opposing segment's roi.\\ \\ * a single distance value is calculated for each triangle, and is the smallest value of these candidates:\\   * (a) the distance from the opposing roi to the closest of the triangle's vertices\\   * (b) the distance from the closest vertex on the opposing roi that projects onto the face of the triangle (left image)\\   * (c) the distance from the closest vertex on the opposing roi that projects onto an edge of the triangle (right image)  |  compute_distance_map_min_distance_calc.png|
+=== Contact Point ===
-==== contact point ====
+The weighted minimum distance between the two segments.
-the weighted minimum distance between the two segments.
+  * Once each triangle has been assigned a minimum distance, a preliminary contact point is found by calculating a weighted average of all the triangle centers. Each center is weighted by the triangle's area and the square of its distance. The area threshold percentage (CONTACT_POINT_AREA_THRESHOLD) specifies the percentage of the total area of triangles on the ROI to be included in the calculation. This weighted-average point is usually not on the surface of the ROI, so it is projected onto the surface using the normal of the closest ROI vertex.
-  * once each triangle has been assigned a minimum distance, a preliminary contact point is found by calculating a weighted average of all the triangle centers. each center is weighted by the triangle's area and the square of its distance. the area threshold percentage (contact_point_area_threshold) specifies the percentage of the total area of triangles on the roi to be included in the calculation. this weighted-average point is usually not on the surface of the roi, so it is projected onto the surface using the normal of the closest roi vertex.
+=== Min Vertex Distances ===
-==== min vertex distances ====
+This is the minimum distance value that is used to color each vertex in the OBJ.
-this is the minimum distance value that is used to color each vertex in the obj.
+**Note:** Do not click on this signal and open the data view, Visual3D will not be able to open the data view due to the number of columns.
-**note:** do not click on this signal and open the data view, visual3d will not be able to open the data view due to the number of columns.
+=== Sign of the Minimum Distance ===
-==== sign of the minimum distance ====
+Any of the distances calculated by this command can be positive (the opposing ROI surfaces do not intersect) or negative (the surfaces intersect). The sign of each distance is calculated using the appropriate normal vector (triangle, edge, or vertex). For example, to determine which side of a triangle a given vertex is on, the vector from the vertex to the triangle is compared to the normal of the triangle.
-any of the distances calculated by this command can be positive (the opposing roi surfaces do not intersect) or negative (the surfaces intersect). the sign of each distance is calculated using the appropriate normal vector (triangle, edge, or vertex). for example, to determine which side of a triangle a given vertex is on, the vector from the vertex to the triangle is compared to the normal of the triangle.
+==== Command Dialog ====
-===== command dialog =====
+|**Result Signal Information:**\\ \\ * Result Type: Derived\\ * Result Folder: Result can be stored in any folder\\ * Result Name: One result name for each region you are comparing\\ \\ **Color Map:**\\ \\ * Min Color & Value\\   * Determines the color for the minimum value\\   * All vertices with a minimum distance less than the value specified will have this color\\ * Inner Color\\   * Specifies the mid color and the gradient\\ * Max Color & Value\\   * Determines the color for the maximum value\\   * All vertices with a maximum distance greater than the value specified will have this color\\ \\ **Event Sequence:**\\ \\ * Without an event sequence the distance map will be created over all frames of data where the segments exist\\ * When an event sequence is specified the distance map will only be calculated for the specified frames (can be more time efficient to only analyze the time period of interest)\\ \\ **Regions:**\\ \\ * Segment Names: Specify the name of the segments to be compared\\ * Proximal Region & Sub Region:\\   * The regions correlate to the regions of interest created in the DSX suite\\ * Contact Point Area Threshold  |  {{:distancemapdialog.png}}|
-|**result signal information:**\\ \\ * result type: derived\\ * result folder: result can be stored in any folder\\ * result name: one result name for each region you are comparing\\ \\ **color map:**\\ \\ * min color & value\\   * determines the color for the minimum value\\   * all vertices with a minimum distance less than the value specified will have this color\\ * inner color\\   * specifies the mid color and the gradient\\ * max color & value\\   * determines the color for the maximum value\\   * all vertices with a maximum distance greater than the value specified will have this color\\ \\ **event sequence:**\\ \\ * without an event sequence the distance map will be created over all frames of data where the segments exist\\ * when an event sequence is specified the distance map will only be calculated for the specified frames (can be more time efficient to only analyze the time period of interest)\\ \\ **regions:**\\ \\ * segment names: specify the name of the segments to be compared\\ * proximal region & sub region:\\   * the regions correlate to the regions of interest created in the dsx suite\\ * contact point area threshold  |  distancemapdialog.png|
+==== Drawing the Contact Path ====
-===== drawing the contact path =====
+|You can draw the contact point and its path on the surface:  |  {{:contactPath.png}}|
-|you can draw the contact point and its path on the surface:  |  contactpath.png|
+=== Steps ===
-==== steps ====
+|For every Result Name specified, there will be 6 results:\\ \\ * ResultName_SegmentName[[#Contact_Path|_Contact]]\\ * ResultName_SegmentName[[#Minimum_Distance|_Min]]\\ * ResultName_SegmentName[[#Min_Vertex_Distances|_Vert]]\\ \\ Right click on the _Min or _Contact to specify the draw properties  |  {{:compute_distance_map_data_tree_right_click.png}}|
-|for every result name specified, there will be 6 results:\\ \\ * resultname_segmentname[[#contact_path|_contact]]\\ * resultname_segmentname[[#minimum_distance|_min]]\\ * resultname_segmentname[[#min_vertex_distances|_vert]]\\ \\ right click on the _min or _contact to specify the draw properties  |  compute_distance_map_data_tree_right_click.png|
+|* Target Size:\\   * Size of contact path (small, medium, large or hide)\\   * Note: Size of contact path can be modified further by going to\\     * Settings -> Modify Scale of the 3D graphics Objects\\     * Modify the target size\\ * Target Color:\\   * Specify the color of the contact point\\ * Trails:\\   * Specify the color for the contact path and the number of frames before/after the current frame to draw the path\\   * Trail thickness specifies the thickness of the path  |  {{:contactPath_draw_properties.png}}|
-|* target size:\\   * size of contact path (small, medium, large or hide)\\   * note: size of contact path can be modified further by going to\\     * settings -> modify scale of the 3d graphics objects\\     * modify the target size\\ * target color:\\   * specify the color of the contact point\\ * trails:\\   * specify the color for the contact path and the number of frames before/after the current frame to draw the path\\   * trail thickness specifies the thickness of the path  |  contactpath_draw_properties.png|
+**NOTE:** If the contact point is still too large, go to **Settings -> Modify Scale of 3D Graphics** and decrease the Target Size.
-**note:** if the contact point is still too large, go to **settings -> modify scale of 3d graphics** and decrease the target size.
+=== Camera Settings ===
-==== camera settings ====
+The skeleton toggle button on the toolbar turns segment drawings on/off:
-the skeleton toggle button on the toolbar turns segment drawings on/off:
+  * All on
+  * Kinematic on
+  * Kinetic on
+  * All off
-  * all on
+You can set one segment to be always drawn by right click on the segment name under Kinetic_Kinematic in the data tree, and selecting "Draw Segment Properties". Check "Draw Segment (Override Visual3D Global Draw)", this means the segment will always be drawn.
-  * kinematic on
-  * kinetic on
-  * all off
-you can set one segment to be always drawn by right click on the segment name under kinetic_kinematic in the data tree, and selecting "draw segment properties". check "draw segment (override visual3d global draw)", this means the segment will always be drawn.
+You can manually adjust the camera perspective:
-you can manually adjust the camera perspective:
+  * Right Mouse: Zoom in/out
+  * Left Mouse: Rotation
+  * Right + Left Mouse: Translate
-  * right mouse: zoom in/out
+You can set the camera perspective to lock onto a segment by going to View -> Set Camera Perspective.
-  * left mouse: rotation
-  * right + left mouse: translate
-you can set the camera perspective to lock onto a segment by going to view -> set camera perspective.
-}}}}}}}}}}}}}}}}