Difference between revisions of "PlanDSX Overview"

From Visual3D Wiki Documentation
Jump to: navigation, search
m (Widgets)
m (Widgets)
(3 intermediate revisions by the same user not shown)
Line 169: Line 169:
 
|-
 
|-
 
|
 
|
Objects represent any type of surface model (currently the following file formats are supported: .obj, .stl, .iv, and .vtk).
 
Objects are added to the list in the widget and to the 3D-View by clicking on the Add button at the bottom of the widget.
 
The objects can then be removed from both the list in the widget and the 3D-View by selecting them in the list and clicking the Remove button.
 
  
[[Image:PlanDSX_ObjectsWidget.png]]  
+
Objects are any polygonal surface models that you want to add to the scene. They can represent bones that you want to generate X-ray images of, or they can be static objects such as treadmills, railings, image intensifiers, and tripods. When you import a motion from a CMZ file, objects are automatically added to the scene to represent the segments in the Visual3D model that was applied to the motion. To add an object to the scene, press the '''Add''' button. PlanDSX will add a new object to the table with a blank file path. You can then change then double-click on the path and specify a file containing the polygonal surface geometry. To delete an object, select it in the table and press the '''Remove''' button.
 +
 
 +
[[Image:PlanDSX_ObjectsWidget.png|right]]  
  
 
The table contains the following properties of each object:
 
The table contains the following properties of each object:
Line 182: Line 181:
 
</li>
 
</li>
 
<li>
 
<li>
'''Path''': The file path of the OBJ file containing the surface geometry of the object.
+
'''Path''': The file path of the file containing the surface geometry of the object. To change the object geometry, double-click on the path and browse for a new file.
 
</li>
 
</li>
 
<li>
 
<li>
Line 201: Line 200:
 
|-
 
|-
 
|
 
|
:Program-wide parameters that can be edited by the user.
 
  
 
[[Image:PlanDSX_Settings.png|right|250px]]
 
[[Image:PlanDSX_Settings.png|right|250px]]
Line 210: Line 208:
 
</li>
 
</li>
 
<li>
 
<li>
'''Color Theme''': the user can choose between a light or a dark color theme.
+
'''Color Theme''': You can choose between a light or a dark color theme.
 
</li>
 
</li>
 
</ul>
 
</ul>
Line 220: Line 218:
 
|-
 
|-
 
|
 
|
:The 3D-view shows the setup of the lab.  
+
The 3D view shows the setup of the virtual lab. You can change the orientation of the view by clicking and dragging with the left mouse button. X-ray views, mocap cameras, and other objects can be added to and removed from the scene using their respective widgets.
:The user can change the orientation of the view by clicking and dragging.
 
:The floor and the axis of the lab can be added and can be removed using the view drop down menu.  
 
:The addition, removal and manipulation of x-ray views, cameras, and objects]] is controlled by their respective widgets.
 
  
 
[[Image:PlanDSX_3DView.png|500px]]  
 
[[Image:PlanDSX_3DView.png|500px]]  
  
: To select an object, mocap camera, or X-ray view, Ctrl-left-click on it. A trackball will be displayed over it, centered on the object's origin. You can click on and drag the trackball handles to translate or rotate the object with respect to a single axis. For free-form rotation, click inside the trackball but away from a handle, then drag the yellow sphere around. For free-form translation, Shift-left-click inside the trackball and drag the yellow sphere. When you are done moving the object, click outside the trackball or press Esc.
+
To select an object, mocap camera, or X-ray view, Ctrl-left-click on it. A trackball will be displayed over it, centered on the object's origin. You can click on and drag the trackball handles to translate or rotate the object with respect to a single axis. For free-form rotation, click inside the trackball but away from a handle, then drag the yellow sphere around. For free-form translation, Shift-left-click inside the trackball and drag the yellow sphere. When you are done moving the object, click outside the trackball or press Esc.
  
:The virtual floor can be raised and lowered using the Up and Down keys.
+
A square representing the floor can be added to the scene using the menu command ''View -> Display Floor''. The floor can be raised and lowered using the Up and Down keys. The global axes of the scene can be displayed using the command ''View -> Display Axes.''
  
 
|}
 
|}
  
 
{| class="mw-collapsible mw-collapsed wikitable" width="80%"
 
{| class="mw-collapsible mw-collapsed wikitable" width="80%"
! style="text-align:left;" | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Playback
+
! style="text-align:left;" | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Motion Playback
 
|-
 
|-
 
|
 
|
:After loading a CMZ file, the mocap model can be controlled using the playback widget situated under the 3D view:
+
After loading a motion from a CMZ file, the mocap model can be controlled using the playback widget located under the 3D view.
  
 
[[Image:PlanDSX_Framecontrol.png|800px]]  
 
[[Image:PlanDSX_Framecontrol.png|800px]]  
  
:The slider can be moved to the left and right to move backward and forward through the frames, respectively.
+
You can drag the slider to play back some of the frames, or use the buttons on the right to control the animation:
:The number next to the slider represents the current time.
+
:|< : Move to first frame
 
+
:<| : Move to previous frame
:The 5 push buttons on the far right are used to control the slider:
+
:>  : Play
::|< : Move to first frame
+
:|| : Pause
::<| : Move to previous frame
+
:|> : Move to next frame
::>  : Play / || : Pause
+
:>| : Move to last frame
::|> : Move to next frame
 
::>| : Move to last frame
 
  
:When 'Repeat' is selected, the playback will be continuous, i.e. after the last frame, the playback continues with the first frame.
+
When ''Repeat'' is selected, the playback will be continuous, i.e., after the last frame, the play back continues with the first frame. The ''Playback Speed'' controls the speed of the play back relative to real-time.
:The ' Playback Frequency' controls how many frames are shown per second.
 
 
|}
 
|}

Revision as of 13:45, 28 June 2020

Language:  English  • français • italiano • português • español 

PlanDSX is a design tool that helps you determine the appropriate configuration of the X-ray equipment to capture high-quality images of the joint[s] of interest. It is essentially a CAD tool that creates a virtual lab containing the subject, X-ray equipment, motion capture cameras, and other equipment such as treadmills and force plates. The subject skeleton can be animated with motion capture data, and the bones generate simulated X-rays as they pass in front of the virtual X-ray image planes. PlanDSX is currently the only application in the DSX suite that does not work with the subject file managed by xManager. It does, however, use XML files to load and save configurations of the elements in the virtual X-ray lab.

PlanDSX FullScreen.png

Tutorials

How To: Using PlanDSX

Menus

     File Menu
PlanDSX FileMenu.png
  • Load CT Data... (Ctrl + L): loads CT data into the 3D scene, using the DICOM, TIFF, or RAW file format. Once the block of voxel data has been loaded, it can be used to generate DRRs in the Xray views.
  • Load Configuration... (Ctrl + O): clears the 3D scene, then loads a previously saved Xray lab configuration into the scene.
  • Save Configuration (Ctrl + S): saves the current set of Xray views, mocap cameras, and objects in the 3D scene to a configuration file (XML).
  • Clear Configuration (Ctrl + N): removes all Xray views, mocap cameras, and objects from the 3D scene.
  • Load Motion from CMZ (Ctrl + M): opens a CMZ file and allows you to select a motion from it to load into the 3D scene. This motion must already have a kinematic model applied to it, with bone geometry specified for each body segment that you want to animate in PlanDSX.
  • Exit: exits PlanDSX, asking if you want to save any unsaved changes, if there are any.
     View Menu
PlanDSXview.png
  • Display Floor (Ctrl + F): controls the presence or the absence of the floor in the 3D display on the right side of the screen.
  • Display Axes (Ctrl + A): controls the presence or the absence of the axes in the 3D display on the right side of the screen. These axes represent the origin and orientation of the global (lab) coordinate system.
  • Xray Views (Ctrl + Shift + V): toggles the dockable Views widget.
  • Mocap Cameras (Ctrl + Shift + C): toggles the dockable Cameras widget.
  • Objects (Ctrl + Shift + O): toggles the dockable Objects widget.
     Options Menu
PlanDSXoptions.png
  • Settings...: opens the Settings dialog.
     Help Menu
PlanDSXhelp.png
  • Help (F1): opens the PlanDSX wiki page in the default browser.
  • About...: displays a dialog with information about PlanDSX, including the installed version number. It also contains the Deactivate button, for deactivating your DSX suite license.

Widgets

     X-ray Views

A view is a model of an X-ray source / image plane combination. The source is represented in the 3D view by a small sphere and the image plane is represented by a square at the other end of the X-ray direction line. The distance between the source and image plane can be changed but the size of the image plane cannot. Any of the objects listed in the Objects widget can be specified to generate DRRs visible on the image plane. To add a view to the scene, press the Add button. PlanDSX will add a view with default parameter values at the origin of the scene. You can then change its properties using the table and move it in the 3D view. To delete a view, select it in the table and press the Remove button.

PlanDSX ViewsWidget.png

The table contains the following properties of each X-ray view:

  • Name: When a new view is created it is given a default name with the format View1, View2 ... ViewN. To change this name double-click on it and type in a new name.
  • Distance: The distance between the X-ray source and the image plane defaults to 1500 mm (1.5 meters). To change it double-click on the number and type in a new one.
  • Visibility: This checkbox toggles the visibility of the X-ray view in the 3D view.
  • 2D: When this box is checked a window with the name of the X-ray view will show the view's simulated X-ray image. This is the same image that is shown on the image plane in the 3D view and is generated from whatever CT data is loaded and all of the objects whose DRR checkbox is checked.
  • Color: The color of the X-ray view geometry in the 3D view. To change the color, double-click on the color box and select a new color.
     Mocap Cameras

Mocap cameras are cameras of a motion-capture system. In the 3D view they are represented by a small box (the camera body) and a semi-transparent cone (the field of view). You can place any number of them in the scene and specify the length and radius of the field of view. To add a mocap camera to the scene, press the Add button. PlanDSX will add a camera with default parameters pointed at the origin. You can then change its properties using the table and move it in the 3D view. To delete a camera, select it in the table and press the Remove button.

PlanDSX CamerasWidget.png

The table contains the following properties of each mocap camera:

  • Name: When a new camera is created it is given a default name with the format Camera (1), Camera (2) ... Camera (N). To change this name double-click on it and type in a new name.
  • Length: The length of the cone representing the field of view. To change the length double-click on it and enter a new value.
  • Radius: The radius of the end of the cone representing the field of view. To change the radius double-click on it and enter a new value.
  • Visibility: This checkbox toggles the visibility of the mocap camera in the 3D view.
  • Color: The color of the camera body and field of view in the 3D view. To change the color, double-click on the color box and select a new color.
     Objects

Objects are any polygonal surface models that you want to add to the scene. They can represent bones that you want to generate X-ray images of, or they can be static objects such as treadmills, railings, image intensifiers, and tripods. When you import a motion from a CMZ file, objects are automatically added to the scene to represent the segments in the Visual3D model that was applied to the motion. To add an object to the scene, press the Add button. PlanDSX will add a new object to the table with a blank file path. You can then change then double-click on the path and specify a file containing the polygonal surface geometry. To delete an object, select it in the table and press the Remove button.

PlanDSX ObjectsWidget.png

The table contains the following properties of each object:

  • Name: When a new object is created it is given a default name with the format Object (1), Object (2) ... Object (N). However, objects that are created when importing a motion from a CMZ file are given the name of their corresponding segment in the Visual3D model. To change the name of an object double-click on it and type in a new name.
  • Path: The file path of the file containing the surface geometry of the object. To change the object geometry, double-click on the path and browse for a new file.
  • DRR: This checkbox toggles whether or not the object will create a DRR (simulated X-ray shadow) in the X-ray views.
  • Visibility: This checkbox toggles the visibility of the object in the 3D view.
  • Color: The color of the color in the 3D view. To change the color, double-click on the color box and select a new color. If the object's OBJ file references materials defined in an MTL file, the color specified here will have no effect.
     Settings
PlanDSX Settings.png
  • Units: Default: mm
  • Color Theme: You can choose between a light or a dark color theme.
     3D View

The 3D view shows the setup of the virtual lab. You can change the orientation of the view by clicking and dragging with the left mouse button. X-ray views, mocap cameras, and other objects can be added to and removed from the scene using their respective widgets.

PlanDSX 3DView.png

To select an object, mocap camera, or X-ray view, Ctrl-left-click on it. A trackball will be displayed over it, centered on the object's origin. You can click on and drag the trackball handles to translate or rotate the object with respect to a single axis. For free-form rotation, click inside the trackball but away from a handle, then drag the yellow sphere around. For free-form translation, Shift-left-click inside the trackball and drag the yellow sphere. When you are done moving the object, click outside the trackball or press Esc.

A square representing the floor can be added to the scene using the menu command View -> Display Floor. The floor can be raised and lowered using the Up and Down keys. The global axes of the scene can be displayed using the command View -> Display Axes.

     Motion Playback

After loading a motion from a CMZ file, the mocap model can be controlled using the playback widget located under the 3D view.

PlanDSX Framecontrol.png

You can drag the slider to play back some of the frames, or use the buttons on the right to control the animation:

|< : Move to first frame
<| : Move to previous frame
>  : Play
|| : Pause
|> : Move to next frame
>| : Move to last frame

When Repeat is selected, the playback will be continuous, i.e., after the last frame, the play back continues with the first frame. The Playback Speed controls the speed of the play back relative to real-time.

Retrieved from ""