PlanDSX Overview

From Visual3D Wiki Documentation
Jump to: navigation, search
Language:  English  • français • italiano • português • español 

Contents

This program and its documentation are still under development...

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

Menus

     File Menu

PlanDSXfile.png

     PlanDSX LoadCTData.png
This control allows the user to load all of the CT data files that are in a file together.
The CT files will be compiled into a 3D representation of the slices in the 3D view.
The Ctrl + L shortcut can also be used to load the CT data.
When CT data is loaded the file path to the data will be displayed at the top of the PlanDSX screen.
     PlanDSX LoadConfiguration.png
This control allows the user to open a configuration
which includes any views, cameras or objects that have been added
and any CT data that has been loaded
that has been saved as a .xml file.
The Ctrl + O shortcut can also be used to load the configuration.
     PlanDSX SaveConfiguration.png
This control allows the user to save the configuration
which includes any views, cameras or objects that have been added
and any CT data that has been loaded - as an .xml file.
The Ctrl + S shortcut can also be used to save the configuration.
     PlanDSX ClearConfiguration.png
This control allows the user to return the PlanDSX to its blank state by removing the configuration file.
The Ctrl + N shortcut can also be used for this.
     PlanDSXLoadCMZ.png
This control allows the user to load a CMZ file with mocap data.
The Ctrl + M shortcut can also be used to load the CMZ file.
     PlanDSX Exit.png
This control allows the user to close the PlanDSX program.
The program will ask if the user wishes to save any changes that have been made to the configuration before closing the program.
The program can also be closed using the X in the top right corner of the screen.
     View Menu

PlanDSXview.png

     PlanDSX DisplayFloor2.png
This controls the presence or the absence of the floor in the 3D display on the right side of the screen.
If there is a blue box with a checkmark in it to the left of the dropdown menu then the floor is active in the 3D view.
The floor can also be toggled on or off with the Ctrl + F shortcut.
     PlanDSX DisplayAxes2.png
This 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.
If there is a blue box with a checkmark in it to the left of the dropdown menu then the axes are active in the 3D view.
The axes can also be toggled on or off with the Ctrl + A shortcut.
     PlanDSX Views.png
Toggles the dockable Views widget. Shortcut: Ctrl+Shift+V.
     PlanDSX Cameras.png
Toggles the dockable Cameras widget. Shortcut: Ctrl+Shift+C.
     PlanDSX Objects.png
Toggles the dockable Objects widget. Shortcut: Ctrl+Shift+O.
     PlanDSX Parameters.png
Toggles the dockable Parameters widget. Shortcut: Ctrl+Shift+P.
     Help Menu

PlanDSXhelp.jpg

     S3DHelpButton.png
The Help command opens the PlanDSX wiki page in the default browser. The F1 shortcut can also be used.
     S3DAboutButton.png
The About option displays a dialog with information about PlanDSX, including the installed version number. It also contains the Deactivate button, for deactivating your PlanDSX license.

Widgets

     Views
The view is a representation of an x-ray source - image plane combination.
X-ray views 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 views 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.

PlanDSX ViewsWidget.png

     Name
When a new x-ray view is added it will automatically be named View1, View2 ... ViewN.
The name can be changed from the automatically generated option to a custom option by double clicking on the name and typing the new name.
     Distance
The distance of the x-ray view defaults to 1500 mm (1.5 meters).
The default distance can be altered by double clicking on the cell to select the distance and typing in the new distance (in millimetres).
     Visibility
When the visibility cell is checked the x-ray view can be seen in the 3D-view as a colored dot where the x-ray originated from and a square panel where the x-ray is projected to. De-selecting the visibility will remove the view from the 3D-view but not from the widget's list.
     2D
When the 2D check box is selected a new widget window will be created that has the name of the x-ray view that it corresponds to.
This window shows the view that the x-ray would create, based on the CT data that has been loaded.
     Color
The color section shows the color of the x-ray view that will appear in the 3D-view.
This color is automatically generated and cannot be altered.
     Motion Capture Cameras
The cameras represent motion capture cameras which are pointed at the global origin (0, 0, 0).
Cameras 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 cameras 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.

PlanDSX CamerasWidget.png

     Name
When a new camera is added it will automatically be named Camera(1), Camera(2) ... Camera(N).
The name can be changed from the automatically generated option to a custom option by double clicking on the name and typing the new name.
     X, Y, Z
The position of the camera from the center of the lab space on all three axis defaults to 1500 mm (1.5 meters).
The default distance can be altered by double clicking on each one of the cells to select the distance and typing in the new distance (in millimetres).
     Visibility
When the visibility cell is checked the camera can be seen in the 3D-view as a colored dot projecting a cone of light.
De-selecting the visibility will remove the camera from the 3D-view but not from the widget's list.
     Color
The color section shows the color of the camera that will appear in the 3D-view.
This color is automatically generated and cannot be altered.
     Objects
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.

PlanDSX ObjectsWidget.png

     Name
When a new object is added it will automatically be named Object(1), Object(2) ... Object(N).
The name can be changed from the automatically generated option to a custom option by double clicking on the name and typing the new name.
     Path
The path cell is initially empty when a new object is created.
By double clicking on the blank path cell a file browser window is opened.
The file browser window allows the user to select an .obj file.
The .obj file that is selected will provide the image for the 3D-view.
If there is no object file loaded then all that will appear in the 3D-view is a colored dot.
     Drr
When the Drr checkbox is selected the 2D image of the object will be projected onto the x-ray views.
If the Drr checkbox is left unselected the object will have no impact on the x-ray views.
     Visibility
When the visibility cell is checked the object file that has been loaded can be seen in the 3D-view.
De-selecting the visibility will remove the object from the 3D-view but not from the widget's list.
     Color
The color section shows the color of the dot that will appear in the 3D-view if an .obj file is not loaded.
This color is automatically generated and cannot be altered.
     Parameters
Program-wide parameters that can be edited by the user.

PlanDSX ParametersWidget.png

     Units
Default: mm
     3D View
The 3D-view shows the setup of the lab.
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.

PlanDSX 3DView.png

     manipulating the 3D-view.
The user can manipulate the 3D-view in the following ways:
By pressing the ‘W’ (World) key, the user can manipulate the 3D-view camera:
Rotating: dragging while holding left mouse button
ooming: vertical dragging while holding right mouse button
Panning: dragging while holding middle mouse button
By pressing the ‘O’ (Object) key, the user can manipulate an individual object in the scene. The object is selected with the mouse cursor and can be manipulated as follows:
Rotating: dragging while holding left mouse button
Zooming: vertical dragging while holding right mouse button
Panning: dragging while holding middle mouse button
The virtual floor can be lowered or raised by pressing the Up and Down key, respectively.
The user can browse through the slices of the 3D image data by pressing the Page Up/Page Down keys, respectively.
     Playback
After loading a CMZ file, the mocap model can be controlled using the playback widget situated under the 3D view:

PlanDSX Framecontrol.png

The slider can be moved to the left and right to move backward and forward through the frames, respectively.
The number next to the slider represents the current time.
The 5 push buttons on the far right are used to control the slider:
|< : 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 playback continues with the first frame.
The ' Playback Frequency' controls how many frames are shown per second.
Retrieved from ""