HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » other » dsx » x4d » X4D Overview
other:dsx:x4d:x4d_overview

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
other:dsx:x4d:x4d_overview [2024/07/17 15:44] – created sgrangerother:dsx:x4d:x4d_overview [2025/06/02 17:57] (current) – Updated "mocap" to "motion capture" where possible. wikisysop
Line 1: Line 1:
 ====== X4D Overview ====== ====== X4D Overview ======
  
-==== Contents ==== +The DSX Suite application X4D tracks 3D objects (bones, implants, etc.) in X-ray images by generating [[other:dsx:dsx_definitions#digitally_reconstructed_radiograph_drr|digitally reconstructed radiographs]] (DRRs) of the objects and matching them to the X-ray images. It requires that the 3D X-ray configuration parameters be defined in the subject file and that the X-ray images be corrected. Matching DRR images to X-ray images requires both sets of images to be processed first. 
- +  - X-ray images are smoothed with a convolution filter and then an edge detection algorithm is run. The final processed X-ray image used for tracking is the edge detection image times a weighting factor, plus the smoothed intensity image. 
- +  - DRR images are not smoothed but are input to the edge detection algorithm. The final processed DRR image is the edge detection image time a weighting factor, plus the original DRR image.
- +
-  * [[#Tutorials|1 Tutorials]] +
-  * [[#Bone_Tracking|2 Bone Tracking]] +
-    * [[#4D_Optimization|2.1 4D Optimization]] +
-    * [[#Matching_Xray_and_DRR_Images|2.2 Matching Xray and DRR Images]] +
-  * [[#Motion_Capture_Data|3 Motion Capture Data]] +
-    * [[#Working_with_Motion_Capture_Data|3.1 Working with Motion Capture Data]] +
-  * [[#Image_Metrics|4 Image Metrics]] +
-    * [[#Pixel_Difference|4.1 Pixel Difference]] +
-    * [[#Conditional_Entropy|4.2 Conditional Entropy]] +
-  * [[#Menus|5 Menus]] +
-    * [[#File_Menu|5.1 File Menu]] +
-    * [[#View_Menu|5.2 View Menu]] +
-    * [[#Queue_Menu|5.3 Queue Menu]] +
-    * [[#Pose_Maps_Menu|5.4 Pose Maps Menu]] +
-    * [[#Options_Menu|5.5 Options Menu]] +
-    * [[#Help_Menu|5.6 Help Menu]] +
-  * [[#Widgets|6 Widgets]] +
-    * [[#DSX_Configuration|6.1 DSX Configuration]] +
-    * [[#X-ray_and_DRR_Settings|6.2 X-ray and DRR Settings]] +
-    * [[#Pose_Maps|6.3 Pose Maps]] +
-    * [[#Object_Tracking|6.4 Object Tracking]] +
-    * [[#Image_Optimization|6.5 Image Optimization]] +
-    * [[#Graphs|6.6 Graphs]] +
-    * [[#Mocap_Model|6.7 Mocap Model]] +
-    * [[#3D_View|6.8 3D View]] +
-    * [[#X-ray_Windows|6.9 X-ray Windows]] +
-    * [[#Optimization_Job_Queue|6.10 Optimization Job Queue]] +
-    * [[#Output_Window|6.11 Output Window]] +
-    * [[#Settings|6.12 Settings]] +
-    * [[#Select_GPUs|6.13 Select GPUs]] +
- +
- +
- +
-X4D tracks 3D objects (bones, implants, etc.) in X-ray images by generating digitally reconstructed radiographs (DRRs) of the objects and matching them to the X-ray images. It requires that the 3D X-ray configuration parameters be defined in the subject file and that the X-ray images be corrected. +
- +
-To match DRR images to X-ray images, both sets of images are processed first. X-ray images are smoothed with a convolution filter, and then an edge detection algorithm is performed on them. The final processed X-ray image that is used for tracking is the edge detection image times a weighting factor, plus the smoothed intensity image. DRR images are not smoothed, but are input to the edge detection algorithm. The final processed DRR image is the edge detection image time a weighting factor, plus the original DRR image.+
  
 X4D has a [[Other:DSX:X4D:Optimization_Job_Queue|job batch option]], enabling multiple tracking optimizations to be run without user intervention. X4D has a [[Other:DSX:X4D:Optimization_Job_Queue|job batch option]], enabling multiple tracking optimizations to be run without user intervention.
  
-{{:X4D_Window.png}}+{{:X4D_Window.png?800}}
  
  
-==== Tutorials ====+===== Tutorials =====
  
-[[Other:DSX:X4D:Tutorials:Basic_Bone_Tracking|Getting Started Tracking Bones]]+User should start with this initial tutorial to begin using X4D: 
 +  - [[Other:DSX:X4D:Tutorials:Basic_Bone_Tracking|Getting Started Tracking Bones]]
  
-[[Other:DSX:X4D:Tutorials:Track_Multiple_Bones|How To: Track Multiple Bones]]+Once the initial tutorial is complete, three "How To" tutorials are available for specific processes within X4D: 
 +  - [[Other:DSX:X4D:Tutorials:Track_Multiple_Bones|How To: Track Multiple Bones]] 
 +  - [[Other:DSX:X4D:Tutorials:How_to_Optimize_X-ray_and_DRR_Settings|How To: Optimize X-ray/DRR Settings]] 
 +  - [[Other:DSX:X4D:Tutorials:Calculate_Bone_Poses_from_Motion_Capture_Data|How To: Calculate Bone Poses from Motion Capture Data]]
  
-[[Other:DSX:X4D:Tutorials:How_to_Optimize_X-ray_and_DRR_Settings|How To: Optimize Xray/DRR Settings]]+===== Bone Tracking =====
  
-[[Other:DSX:X4D:Tutorials:Calculate_Bone_Poses_from_Motion_Capture_Data|How To: Calculate Bone Poses from Mocap Data]]+Read the following pages to understand the bone tracking processes you are implementing in X4D: 
 +  - [[other:dsx:x4d:4d_optimization|4D Optimization]] 
 +  - [[other:dsx:x4d:matching_x-ray_and_drr_images|Matching X-ray and DRR Images]]
  
-==== Bone Tracking ====+===== Motion Capture Data =====
  
-== 4D Optimization ==+Learn how to [[other:dsx:x4d:working_with_motion_capture_data|work with motion capture data]] in X4D.
  
-== Matching Xray and DRR Images ==+===== Image Metrics =====
  
-==== Motion Capture Data ====+These image metrics are used by X4D's optimization algorithm to compare the X-ray and DRR images during object tracking: 
 +  - [[other:dsx:x4d:pixel_difference|Pixel Difference]] 
 +  - [[other:dsx:x4d:conditional_entropy|Conditional Entropy]]
  
-== Working with Motion Capture Data ==+===== Menus =====
  
-==== Image Metrics ====+The X4D application contains six menus: File, View, Queue, Pose Maps, Options, and Help.
  
-The measurement used by the optimization algorithm to compare the X-ray and DRR images during object tracking. +==== File Menu ====
- +
-== Pixel Difference == +
- +
-== Conditional Entropy == +
- +
-==== Menus ==== +
- +
-== File Menu ==+
  
 {{:X4D_FileMenu.png}} {{:X4D_FileMenu.png}}
  
   * **Open Subject... (Ctrl + O)** This command loads a subject file.   * **Open Subject... (Ctrl + O)** This command loads a subject file.
- 
   * **Save Subject (Ctrl + S)** This command saves the currently loaded subject to its existing subject file.   * **Save Subject (Ctrl + S)** This command saves the currently loaded subject to its existing subject file.
- 
   * **Save Subject As...** This command saves the currently loaded subject to a new subject file.   * **Save Subject As...** This command saves the currently loaded subject to a new subject file.
- 
   * **Load Pose Maps...** This command loads an existing pose map file for each selected object. You will be prompted to browse for each file, which must be saved as a .csv file.   * **Load Pose Maps...** This command loads an existing pose map file for each selected object. You will be prompted to browse for each file, which must be saved as a .csv file.
- 
   * **Save Pose Maps** This command saves the pose map of each selected object in the current trial to a .csv file. This file contains 6 values for each pose: the XYZ translation and the XYZ Euler angles representing the transform from the X-ray lab frame to the object's local coordinate system (i.e., as if you were traveling from the lab frame to the object frame). If a name for the pose map file is not already specified in the subject file, you will be prompted to browse for the file to create. A link to this file will then be added to the subject file.   * **Save Pose Maps** This command saves the pose map of each selected object in the current trial to a .csv file. This file contains 6 values for each pose: the XYZ translation and the XYZ Euler angles representing the transform from the X-ray lab frame to the object's local coordinate system (i.e., as if you were traveling from the lab frame to the object frame). If a name for the pose map file is not already specified in the subject file, you will be prompted to browse for the file to create. A link to this file will then be added to the subject file.
- 
   * **Save Pose Maps As...** This command saves the pose map for each selected object in the current trial to a new .csv file. You will be prompted to browse for a new file for each object. A link to this new file will then be added to the subject file.   * **Save Pose Maps As...** This command saves the pose map for each selected object in the current trial to a new .csv file. You will be prompted to browse for a new file for each object. A link to this new file will then be added to the subject file.
- 
   * **Save Object Transforms** This command saves the pose map of each selected object in the current trial to a .txt file. This file contains a 4x4 transform for each pose, expressing the transform from the X-ray lab frame to the object's local coordinate system (i.e., as if you were traveling from the lab frame to the object frame). If a name for the transforms file is not already specified in the subject file, you will be prompted to browse for the file to create. A link to this file will then be added to the subject file.   * **Save Object Transforms** This command saves the pose map of each selected object in the current trial to a .txt file. This file contains a 4x4 transform for each pose, expressing the transform from the X-ray lab frame to the object's local coordinate system (i.e., as if you were traveling from the lab frame to the object frame). If a name for the transforms file is not already specified in the subject file, you will be prompted to browse for the file to create. A link to this file will then be added to the subject file.
- 
   * **Save Landmarks** This command saves the locations in the X-ray lab frame of each selected object's landmarks in the current trial to a .txt file. This file contains a set of landmark coordinates for each pose in the pose map. If a name for the landmarks file is not already specified in the subject file, you will be prompted to browse for the file to create. A link to this file will then be added to the subject file.   * **Save Landmarks** This command saves the locations in the X-ray lab frame of each selected object's landmarks in the current trial to a .txt file. This file contains a set of landmark coordinates for each pose in the pose map. If a name for the landmarks file is not already specified in the subject file, you will be prompted to browse for the file to create. A link to this file will then be added to the subject file.
- 
   * **Export Poses to CMZ** This command exports the pose map of each selected object in the current trial to the session's CMZ file. If the CMZ already contains poses for these objects for this trial, those poses will be removed before the current ones are exported. This command does not affect the poses of unselected objects, nor of other trials in the CMZ file. If a CMZ file is not already specified in the subject file, you will be prompted to enter the name of a new one.   * **Export Poses to CMZ** This command exports the pose map of each selected object in the current trial to the session's CMZ file. If the CMZ already contains poses for these objects for this trial, those poses will be removed before the current ones are exported. This command does not affect the poses of unselected objects, nor of other trials in the CMZ file. If a CMZ file is not already specified in the subject file, you will be prompted to enter the name of a new one.
- 
   * **Exit (Alt + E)** This command exits the program. The program can also be closed using the X in the top right corner of the program window.   * **Exit (Alt + E)** This command exits the program. The program can also be closed using the X in the top right corner of the program window.
  
-\\ +==== View Menu ====
- +
- +
- +
-== View Menu ==+
  
 {{:X4D_ViewMenu.png}} {{:X4D_ViewMenu.png}}
  
   * **Body Reference Frames (Alt + R)** toggles the display of the local coordinate systems of the selected objects in the X-ray windows and the 3D view.   * **Body Reference Frames (Alt + R)** toggles the display of the local coordinate systems of the selected objects in the X-ray windows and the 3D view.
- 
   * **Body Landmarks (Alt + L)** toggles the display of the landmarks of the selected objects in the X-ray windows and the 3D view.   * **Body Landmarks (Alt + L)** toggles the display of the landmarks of the selected objects in the X-ray windows and the 3D view.
- 
   * **DSX Configuration (Ctrl + Shift + C)** toggles the appearance of the dockable //DSX Configuration// widget, which lets you select sessions, configurations, trials, and objects.   * **DSX Configuration (Ctrl + Shift + C)** toggles the appearance of the dockable //DSX Configuration// widget, which lets you select sessions, configurations, trials, and objects.
- +  * **3D View (Ctrl + Shift + V)** toggles the appearance of the dockable //3D View// window, which displays the X-ray configuration, selected objects, and motion capture markers.
-  * **3D View (Ctrl + Shift + V)** toggles the appearance of the dockable //3D View// window, which displays the X-ray configuration, selected objects, and mocap markers. +
   * **Output (Ctrl + Shift + O)** toggles the appearance of the dockable //Output// window, which shows informational and error messages.   * **Output (Ctrl + Shift + O)** toggles the appearance of the dockable //Output// window, which shows informational and error messages.
- 
   * **Xray/DRR Settings (Ctrl + Shift + X)** toggles the appearance of the dockable //Xray/DRR Settings// widget, which gives you access to the settings used to process the X-ray and DRR images.   * **Xray/DRR Settings (Ctrl + Shift + X)** toggles the appearance of the dockable //Xray/DRR Settings// widget, which gives you access to the settings used to process the X-ray and DRR images.
- 
   * **Pose Maps (Ctrl + Shift + A)** toggles the appearance of the dockable //Pose Maps// widget, which has commands for editing the pose maps.   * **Pose Maps (Ctrl + Shift + A)** toggles the appearance of the dockable //Pose Maps// widget, which has commands for editing the pose maps.
- 
   * **Object Tracking (Ctrl + Shift + T)** toggles the appearance of the dockable //Object Tracking// widget, which lets you track objects in the X-ray images.   * **Object Tracking (Ctrl + Shift + T)** toggles the appearance of the dockable //Object Tracking// widget, which lets you track objects in the X-ray images.
- 
   * **Image Optimization (Ctrl + Shift + I)** toggles the appearance of the dockable //Image Optimization// widget, which can be used to optimize the X-ray, DRR, and image metric settings to better track objects in the X-ray images.   * **Image Optimization (Ctrl + Shift + I)** toggles the appearance of the dockable //Image Optimization// widget, which can be used to optimize the X-ray, DRR, and image metric settings to better track objects in the X-ray images.
- 
   * **Graphs (Ctrl + Shift + G)** toggles the appearance of the dockable //Graphs// widget, which displays the pose maps of the selected objects.   * **Graphs (Ctrl + Shift + G)** toggles the appearance of the dockable //Graphs// widget, which displays the pose maps of the selected objects.
- +  * **Mocap Model (Ctrl + Shift + M)** toggles the appearance of the dockable //Mocap Model// widget, which lets you apply the motion capture model to the objects in the current trial.
-  * **Mocap Model (Ctrl + Shift + M)** toggles the appearance of the dockable //Mocap Model// widget, which lets you apply the mocap model to the objects in the current trial. +
   * **Optimization Job Queue (Ctrl + Shift + Q)** toggles the appearance of the dockable //Optimization Job Queue// widget, which displays the currently loaded tracking optimization job queue.   * **Optimization Job Queue (Ctrl + Shift + Q)** toggles the appearance of the dockable //Optimization Job Queue// widget, which displays the currently loaded tracking optimization job queue.
  
-\\ +==== Queue Menu ====
- +
- +
- +
-== Queue Menu ==+
  
 {{:X4D_QueueMenu.png}} {{:X4D_QueueMenu.png}}
  
   * **Add Jobs from File** loads a job queue file (*.xjq). The jobs in the file are appended to the end of the queue.   * **Add Jobs from File** loads a job queue file (*.xjq). The jobs in the file are appended to the end of the queue.
- 
   * **Save Jobs to File** saves the current job queue to a file (*.xjq).   * **Save Jobs to File** saves the current job queue to a file (*.xjq).
- 
   * **Clear** clears the current job queue (no undo!).   * **Clear** clears the current job queue (no undo!).
- 
   * **Run** runs all the jobs in the queue.   * **Run** runs all the jobs in the queue.
- 
   * **Abort** aborts a currently running job queue.   * **Abort** aborts a currently running job queue.
  
- +==== Pose Maps Menu ====
-== Pose Maps Menu ==+
  
 {{:X4D_PoseMapsMenu.png}} {{:X4D_PoseMapsMenu.png}}
Line 159: Line 89:
  
   * **Objects Affected** Specifies the objects that are affected by the actions in this menu. Available options are: a) All Selected For Display and b) All Selected For Optimization.   * **Objects Affected** Specifies the objects that are affected by the actions in this menu. Available options are: a) All Selected For Display and b) All Selected For Optimization.
- 
   * **Add Current Pose to Maps (Alt + A)** adds the current pose of each object specified in the //Objects Affected// combo box to its pose map.   * **Add Current Pose to Maps (Alt + A)** adds the current pose of each object specified in the //Objects Affected// combo box to its pose map.
- 
   * **Clear Current Poses from Maps (Alt + C)** removes the pose for the current time of each object specified in the //Objects Affected// combo box from its pose map.   * **Clear Current Poses from Maps (Alt + C)** removes the pose for the current time of each object specified in the //Objects Affected// combo box from its pose map.
- 
   * **Clear Pose Maps** removes all poses from the pose map for each object specified in the //Objects Affected// combo box.   * **Clear Pose Maps** removes all poses from the pose map for each object specified in the //Objects Affected// combo box.
- 
   * **Smooth Pose Maps (Alt + M)** smooths the poses in the tracking range for each object specified in the //Objects Affected// combo box, using the cutoff frequency specified in the graph widget.   * **Smooth Pose Maps (Alt + M)** smooths the poses in the tracking range for each object specified in the //Objects Affected// combo box, using the cutoff frequency specified in the graph widget.
- 
   * **Fill Pose Maps (Alt + I)** adds a pose for each reporting time in the tracking range that does not already have one to the pose map of each object specified in the //Objects Affected// combo box.   * **Fill Pose Maps (Alt + I)** adds a pose for each reporting time in the tracking range that does not already have one to the pose map of each object specified in the //Objects Affected// combo box.
- 
   * **Clean Pose Maps (Alt + N)** removes all poses that are not at one of the trial's reporting times from the pose map of each object specified in the //Objects Affected// combo box.   * **Clean Pose Maps (Alt + N)** removes all poses that are not at one of the trial's reporting times from the pose map of each object specified in the //Objects Affected// combo box.
  
-\\ +==== Options Menu ====
- +
- +
- +
-== Options Menu ==+
  
 {{:X4D_OptionsMenu.png}} {{:X4D_OptionsMenu.png}}
  
   * **Settings...** opens the Settings dialog window.   * **Settings...** opens the Settings dialog window.
- 
   * **Select GPUs... (Alt + G)** opens a dialog window that lets you assign GPUs to the X-ray views.   * **Select GPUs... (Alt + G)** opens a dialog window that lets you assign GPUs to the X-ray views.
  
- +==== Help Menu ====
-== Help Menu ==+
  
 {{:X4D_HelpMenu.png}} {{:X4D_HelpMenu.png}}
  
   * **Help (F1)** opens the X4D wiki page in the default browser.   * **Help (F1)** opens the X4D wiki page in the default browser.
- 
   * **System Information...** opens a dialog window with information about your computer, including available RAM and graphics card specifications.   * **System Information...** opens a dialog window with information about your computer, including available RAM and graphics card specifications.
- 
   * **About...** displays a dialog with information about X4D, including the installed version number. It also contains the //Deactivate// button, for deactivating your DSX suite license.   * **About...** displays a dialog with information about X4D, including the installed version number. It also contains the //Deactivate// button, for deactivating your DSX suite license.
  
 +===== Widgets =====
  
-==== Widgets ==== +The X4D application contains 12 different widgets: 
- +  - [[other:dsx:x4d:dsx_configuration|DSX Configuration]] 
-== DSX Configuration == +  - [[other:dsx:x4d:x-ray_and_drr_settings|X-ray and DRR Settings]] 
- +  - [[other:dsx:x4d:pose_maps|Pose Maps]] 
-== X-ray and DRR Settings == +  - [[other:dsx:x4d:object_tracking|Object Tracking]] 
- +  - [[other:dsx:x4d:image_optimization|Image Optimization]] 
-== Pose Maps == +  - [[other:dsx:x4d:graphs|Graphs]] 
- +  - [[other:dsx:x4d:motion_capture_model|Motion Capture Model]] 
-== Object Tracking == +  - [[other:dsx:x4d:x4d_3d_view|3D View]] 
- +  - [[other:dsx:x4d:optimization_job_queue|Optimization Job Queue]] 
-== Image Optimization == +  - [[other:dsx:x4d:output_window|Output Window]] 
- +  - [[other:dsx:x4d:settings|Settings]] 
-== Graphs == +  - [[other:dsx:x4d:select_gpus|Select GPUs]]
- +
-== Mocap Model == +
- +
-== 3D View == +
- +
-== X-ray Windows == +
- +
-== Optimization Job Queue == +
- +
-== Output Window == +
- +
-== Settings == +
- +
-== Select GPUs == +
- +
  
other/dsx/x4d/x4d_overview.1721231065.txt.gz · Last modified: 2024/07/17 15:44 by sgranger