Shift docs to root

This commit is contained in:
dannyrb committed 2019-07-15 15:50:47 -04:00
1 parent 83e627e5c9
commit 91564bfa06
200 files changed
+7

No files matched your search

+6
View File
@@ -0,0 +1,6 @@
# Lesion Tracker - Audit Trail
1. To view Audit Trails, select **View Audit Log** on the Configuration menu.
2. To filter audit logs for a column or multiple columns, type or select in the related column or columns.
![Audit Trails](../assets/img/LesionTracker/LT_Audit_Trails.png)
@@ -0,0 +1,85 @@
# Lesion Tracker - Installation on Windows
On Windows, the easiest way to install LesionTracker is using the provided Windows Installer. You can download the latest version of LesionTracker installer from [OHIF](ohif.org)
## Install
1. After you have obtained the latest version of LesionTracker installer, double-click the installer to install the application.
2. When you start the installer, setup wizard will pop up.
![Installer Initial](../assets/img/LesionTracker/LT_Installer_Initial.png)
3. Click **Install** to start the installation.
4. LesionTracker will install prerequisites if they do not exist before installing the application.
![Prerequisites](../assets/img/LesionTracker/LT_Installer_Prerequisites.png)
5. Click the **Next** if you accept the installation.
![After Prerequisites](../assets/img/LesionTracker/LT_Installer_After_Prerequisites.png)
6. Read the license agreement, and if you agree, click **I accept the terms in the License Agreement** and then click the **Next**.
![License Aggrement](../assets/img/LesionTracker/LT_Installer_License_Aggrement.png)
7. Select a location to install LesionTracker and click the **Next** to continue.
![Select Location](../assets/img/LesionTracker/LT_Installer_Select_Location.png)
8. Click the **Install** to start the installation and the installation will be started.
![Launch Installation](../assets/img/LesionTracker/LT_Installer_Launch_Installation.png)
9. Click **Finish** to complete the installation.
![Finish](../assets/img/LesionTracker/LT_Installer_Finish.png)
10. When the installation is done,
* You will see the final dialog which gives the URLs in order to connect to LesionTracker Viewer and Orthanc Server.
* It will launch computer's default browser and display LesionTracker Viewer if you click 'http://localhost:3000'
* It will launch computer's default browser and enables to upload studies to Orthanc Server if you click 'http://localhost:8042'
![Final](../assets/img/LesionTracker/LT_Installer_Final.png)
* Also, LesionTracker installer will create two shortcuts named LesionTracker and Orthanc Server on the Desktop.
* It will launch computer's default browser and display LesionTracker image viewer if you click LesionTracker application on the Desktop.
* It will launch computer's default browser and enables to upload studies to Orthanc Server if you click Orthanc Server application.
![Desktop Shortcuts](../assets/img/LesionTracker/LT_Installer_Desktop_Shortcuts.png)
11. Click the **Done** and **Close** to close the installation window.
![Installation Successful](../assets/img/LesionTracker/LT_Installer_Successful.png)
12. After the installation is completed,
* You can find the project folder in C:\Program Files\OHIF\LesionTracker if you use the default installation location.
* You will find 4 program executables which eases managing the services in the project folder:
* **Start Services.exe:** Starts LesionTracker, MongoDB and Orthanc services manually.
* **Stop Services.exe:** Stops LesionTracker, MongoDB and Orthanc services manually.
* **Turn Off Auto Services.exe:** Configures not to start LesionTracker, MongoDB and Orthanc services automatically when Windows starts up.
* **Turn On Auto Services.exe:** Configures to start LesionTracker, MongoDB and Orthanc services automatically when Windows starts up.
![Services](../assets/img/LesionTracker/LT_Installer_Services.png)
## Uninstall
1. Open the Start Menu.
2. Click **Settings**.
3. Click **Apps** on the Settings menu.
4. Select **Apps & features** from the left panel.
5. Find the LesionTracker in programs list and click LesionTracker, then click the **Uninstall**.
![Uninstall](../assets/img/LesionTracker/LT_Installer_Uninstall.png)
6. Click **Uninstall** from the LesionTracker Setup dialog.
![Launch Uninstall](../assets/img/LesionTracker/LT_Installer_Launch_Uninstall.png)
When the uninstallation is done, the uninstallation will remove;
* Prerequisites: MongoDB, nodejs and Orthanc Server
* The project folder, OHIF, from C:\Program Files
* Background Services: LesionTracker Server, MongoDB and Orthanc services
* Shortcuts: LesionTracker and Orthanc Server shortcuts on the Desktop
@@ -0,0 +1,34 @@
# Lesion Tracker - Manage Studies in Orthanc
Orthanc is an open-source, simple and powerful standalone DICOM server which eases DICOM scripting and data management for clinical routine and medical research. LesionTracker installer installs Orthanc as a service and runs automatically in the background. Orthanc serves a web interface, Orthanc Explorer, and it can be accessed through http://localhost:8042 in your web browser or the Orthanc Server shortcut which is created by LesionTracker installer and loads http://localhost:8042 in your default browser.
## Upload a study into Orthanc using Orthanc Explorer
1. Click **Upload** button at the top-right of Orthanc Explorer and you will be brought to the upload page.
![Upload](../assets/img/LesionTracker/LT_Orthanc_Upload.png)
2. Select the DICOM files and drag those files into Orthanc Explorer.
![Drag and Drop Studies](../assets/img/LesionTracker/LT_Orthanc_Drag_and_Drop.png)
3. Click **Start the upload** and wait until the upload is complete.
![Start the Upload](../assets/img/LesionTracker/LT_Orthanc_Start_Upload.png)
4. Click **Patients** to view the uploaded study.
![Upload Result](../assets/img/LesionTracker/LT_Orthanc_Upload_Result.png)
## Delete a study from Orthanc using Orthanc Explorer
1. Select a patient from Patients list.
![Select Patient](../assets/img/LesionTracker/LT_Orthanc_Delete_Select_Patient.png)
2. Select a study of the patient.
![Select Study](../assets/img/LesionTracker/LT_Orthanc_Delete_Select_Study.png)
3. Select **Delete this study** in the Interact menu.
![Delete Study](../assets/img/LesionTracker/LT_Orthanc_Delete_Study.png)
@@ -0,0 +1,5 @@
# Lesion Tracker - Server Management
LesionTracker supports configuration of multiple servers and allows to switch between them. To configure the servers, click **Server Information** on the Configuration Menu.
![Server Information](../assets/img/LesionTracker/LT_Server_Info.png)
@@ -0,0 +1,51 @@
# Lesion Tracker - Study and Timepoint Management
![Study List](../assets/img/LesionTracker/LT_StudyList.png)
1. Study List allows to sort each column. To sort studies, click the desired column header.
2. Study List is filterable for each column and you can filter by more than one column by typing in the column field. To filter a column, type the text in the desired column header field and press Enter.
3. Pagination is provided for the Study List at the bottom of the page. You can change the number of rows per page or the current page.
## Study List Context Menu
When you right-click on the study row, Study Context Menu will pop up. Study Context Menu includes operations at the study level.
There are a couple of ways to view a study:
* Simply double-click on the study row.
* Select **View** option on the Study Context Menu, then you will be redirected to Viewer page.
![View Study](../assets/img/LesionTracker/LT_View_Study.png)
### Timepoint Association
1. To link a study with a timepoint, right-click on the study row and select **Associate** option on the Study Context Menu. You will see Study Association dialog.
2. To link multiple studies at the same time, hold Shift key and select studies you would like to associate, then right-click and select Associate on the Study Context Menu
![Select Associate](../assets/img/LesionTracker/LT_Select_Associate.png)
The Study Association dialog allows you to select and unselect Timepoint Type for the selected study or studies. Also, it will include all studies within 14 days of your selected studies, in case you forgot to select a study. After you identify timepoints for the selected study or studies, click **Save** to save the association.
![Association Dialog](../assets/img/LesionTracker/LT_Association_Dialog.png)
### Remove Timepoint Association
To unlink a timepoint association with a study, right-click on the study row and select **Remove Association** option on the Study Context Menu. Remove Association will be disabled if the study is already dissociated.
![Remove Associate](../assets/img/LesionTracker/LT_Remove_Associate.png)
### View Series Details
To view details of related series, right-click on the study row and select **View Series Details** option on the Study Context Menu, then Series Details dialog will pop up. Series Details dialog gives a summary of the selected study.
![View Series Details](../assets/img/LesionTracker/LT_View_Series_Details.png)
### Anonymize (Under Development)
...
### Send (Under Development)
...
### Export (Under Development)
...
### Delete (Under Development)
...
+37
View File
@@ -0,0 +1,37 @@
# Lesion Tracker - User Accounts
## Sign In
LesionTracker requires authentication to access the viewer.
If you are already a registered user, enter Your Email and Password and click **Sign In**
![Login](../assets/img/LesionTracker/LT_Login.png)
## Register An Account
If you are a new user, click **Need An Account** and fill the all fields and click **Join Now**
![Need Account](../assets/img/LesionTracker/LT_Need_Account.png)
Note: There is a Test Drive button on the top-right of Login page. Test Drive is used to skip registration process and allows to use LesionTracker with a test account. This will be removed in the next versions.
## Forgot Password
To reset the password, enter Your Email and click **Send Reminder**. An email that includes a link to reset your password will be sent to your email address.
![Forgot Password](../assets/img/LesionTracker/LT_Forgot_Password.png)
## Change Password
To change password:
1. Click Configuration menu icon at the top-right of the workspace then select **Change Password**
2. Enter your password and click **Change Password**
![Change Password](../assets/img/LesionTracker/LT_Change_Password.png)
## Logout
To logout, click **Logout** on the Configuration menu.
![Logout](../assets/img/LesionTracker/LT_Logout.png)
+10
View File
@@ -0,0 +1,10 @@
# Lesion Tracker - User Manual
1. [Installation on Windows](../installation-on-windows.md)
2. [Manage Studies in Orthanc](../manage-studies-in-orthanc.md)
3. [User Accounts](../user-accounts.md)
4. [Study and Timepoint Management](../study-and-timepoint-management.md)
5. [Lesion Tracking](../lesion-tracking.md)
6. [User Preferences](../user-preferences.md)
7. [Server Management](../server-management.md)
8. [Audit Trail](../audit-trail.md)
@@ -0,0 +1,21 @@
# Lesion Tracker - User Preferences
To view User Preferences dialog, select **Preferences** on the Configuration menu. User Preferences dialog includes a couple of tabs:
![Configuration Menu](../assets/img/LesionTracker/LT_Configuration_Menu.png)
#### Keyboard Shortcuts
There are a number of default shortcuts for the defined tools. To change the shortcut for the tool, type the desired key into the tool field.
![Keyboard Shortcuts](../assets/img/LesionTracker/LT_Keyboard_Shortcuts.png)
#### Window Width & Level Presets
There are a number of default Window Width/Level settings in the Window W/L tab. To create a new setting, enter the desired column field.
![Window W/L](../assets/img/LesionTracker/LT_WL_Presets.png)
## Color Themes
1. To modify the colors in the viewer, select **Themes** from Configuration menu.
2. Select a theme then click **Apply theme** to change the theme.
![Themes](../assets/img/LesionTracker/LT_Themes.png)
+270
View File
@@ -0,0 +1,270 @@
# Lesion Tracker - Using the Viewer
After you double-click a study, the Lesion Tracking imaging application will be launched. The basic patient and study data is displayed in the Image Viewer.
![Viewer](../assets/img/LesionTracker/LT_Viewer.png)
### Switching Studies and Series
There are two methods to switch studies and series inside each viewport:
#### Studies Panel
Studies Panel at the left side of the workspace allows you to change studies and series. Click **Studies** button to toggle Studies Panel. You can view images in two ways:
1. Double-click the desired series thumbnail.
2. Drag and drop the desired series thumbnail on the image viewer.
![Studies Panel](../assets/img/LesionTracker/LT_Studies_Panel.png)
#### Quick Switch Tool
Quick Switch Tool in the top-middle of the workspace allows you to switch studies and series for the active image viewer easily. Selected series will be colored by the theme colors.
![Quick Switch Tool](../assets/img/LesionTracker/LT_Quick_Switch_Tool.png)
## Image Manipulation Tools
Image Manipulation Tools are available in the toolbar at the top of the workspace.
### Zoom Tool
There are a couple of ways to zoom the image:
1. Select **Zoom Tool** and down on the image with the left mouse button.
2. Down on the image the right mouse button without selecting Zoom Tool.
![Zoom](../assets/img/LesionTracker/LT_Studies_Panel.png)
### Window Width & Level
There are a couple of ways to change the window/level of the image:
1. Select **Levels Tool** and drag on the image with the left mouse button. Dragging up decreases the level and dragging left decreases the window width.
![Window W/L](../assets/img/LesionTracker/LT_WL.png)
2. Alternatively, you can use default Window/Level Presets which are defined in User Preferences dialog or create your window level values.
![Window W/L Presets](../assets/img/LesionTracker/LT_WL_Presets.png)
### Pan Tool
There are a couple of ways to pan the image:
1. Select **Pan Tool** and move the image around the screen with the left mouse button.
2. Move the image around the screen with the middle mouse button without selecting Pan Tool.
![Pan Tool](../assets/img/LesionTracker/LT_Pan.png)
### Stack Scroll Tool
There are a number of ways to scroll images:
1. Scroll up and down the mouse wheel.
2. Drag the scroll bar at the right side of the image viewer.
3. Use Up and Down buttons on the keyboard.
![Scroll Tool](../assets/img/LesionTracker/LT_Scroll.png)
## Lesion Tracking Basics
### View Case Response Criteria
LesionTracker supports Conformance Checks for RECIST 1.1 and click **Trial** to view Response Criteria details.
_Note:_ Trial button is available if the study is associated with a timepoint.
![Response Criteria](../assets/img/LesionTracker/LT_Response_Criteria.png)
### Measurements Table
To view measurements and manipulate the lesions, click **Measurements** button at the top-right of the workspace. The Measurements table will be displayed at the right side of the workspace. To hide the Measurements the table, click Measurements button.
_Note:_ Measurements button is available if the study is associated with a timepoint.
![Measurements](../assets/img/LesionTracker/LT_Measurements.png)
### Target Tool
1. To create a target, select **Target Tool** and click on the image.
2. Hold, drag and release the mouse button to create the target.
![Target Tool](../assets/img/LesionTracker/LT_Target.png)
3. To label the target, click **Add Label** button.
![Target Label](../assets/img/LesionTracker/LT_Target_Label.png)
4. To resize the measurement, hover the mouse over the end points of the target then click and drag.
5. To rename the lesion, click the lesion number in the Measurements table then click **Rename**
![Rename Target](../assets/img/LesionTracker/LT_Target_Rename.png)
6. To delete the lesion, click the lesion number in the Measurements table then click **Delete**. It will delete the lesion from the Measurements table and the image.
![Delete Target](../assets/img/LesionTracker/LT_Target_Delete.png)
#### Completely Resolved (CR) Target Tool
To make a lesion completely resolved, click Target Tool and select **CR Target** from Target Tool pop up.
![CR Target Tool](../assets/img/LesionTracker/LT_Target_CR.png)
#### Unknown (UN) Target Tool
To mark a lesion as unknown, click Target Tool and select ** UN Target** from Target Tool pop up.
![UN Target Tool](../assets/img/LesionTracker/LT_Target_UN.png)
### Non-Target Tool
1. To create a non-target, select **Non-Target Tool** and click on the image.
2. Hold, drag and release the mouse button to create a non-target.
![Non-Target Tool](../assets/img/LesionTracker/LT_NonTarget_Tool.png)
3. Select Lesion Location and Lesion Location Response then click **Confirm**.
![Non-Target Select Location](../assets/img/LesionTracker/LT_NonTarget_Select_Location.png)
4. To resize the measurement, hover the mouse over the end points of the non-target then click and drag.
5. To rename the lesion, click the lesion number in the Measurements table then click **Rename**
6. To delete the lesion, click the lesion number in the Measurements table then click **Delete**. It will delete the lesion from the Measurements table and the image.
### View Lesion
To view the lesion on the image, click the measurement record in the Measurements table then the image which includes the lesion will be displayed by activating the selected lesion.
![View Lesion](../assets/img/LesionTracker/LT_View_Lesion.png)
### Conformance Checks
Any lesion that will conflict with Response Criteria for RECIST 1.1 will be flagged in the Measurements table. To view criteria non-conformities, click the icon at the left of the lesion record in the Measurements table.
![Conformance Check](../assets/img/LesionTracker/LT_Conformance_Check.png)
### Generating PDF Reports
1. To generate reports of measurements, click **Generate Report** button at the bottom of the Measurements table.
![Generate PDF](../assets/img/LesionTracker/LT_Generate_Report.png)
2. A PDF file which includes target and non-target measurements with annotated image snapshots will be created.
![Report PDF](../assets/img/LesionTracker/LT_Report_PDF.png)
### Saving Measurements
There a couple of ways to save changes:
1. Click **Save** button at the top-right of the workspace.
![Save](../assets/img/LesionTracker/LT_Save1.png)
2. Click **Study list** to save changes and go back to Study List.
![Save](../assets/img/LesionTracker/LT_Save2.png)
### Timepoint Comparison
LesionTracker allows to compare time points and manipulate the measurements on the timepoint images. To launch the compare mode:
1. Associate a study with Follow-up timepoint then double-click Follow-up study. Follow-up and Baseline studies will be displayed in 1x2 layout and Baseline study will show the image which includes the first target measurement as default.
2. Measurements in the Follow-up must be created in the same order as they were on Baseline.
![Compare Mode](../assets/img/LesionTracker/LT_CompareMode.png)
#### Comparison
    **Comparison** tab in the Measurements table allows you to display lesions in the timepoint compared.
![Comparison](../assets/img/LesionTracker/LT_Comparison.png)
#### Key Timepoints
**Key Timepoints** tab in the Measurements table allows you to display the lesions by the timepoints at the same time.
![Key Timepoints](../assets/img/LesionTracker/LT_Key_Timepoints.png)
#### Image Review
To compare the lesions in Baseline and Follow-up, click the lesion record in the Measurements table. The recorded lesions will be displayed on the Baseline and Follow-up images
#### Stack Scroll Tool**
To scroll between two series synchronously, click More button and select **Stack Scroll Tool**.
![Stack Scroll](../assets/img/LesionTracker/LT_StackScroll_Multiple.png)
#### Case Progress
Case Progress icon displays the progress of target and non-target lesions which are assessed out of total lesions. Number in the middle of the icon shows the number of lesions which are not assessed.
![Assessment Progress](../assets/img/LesionTracker/LT_Assessment_Progress.png)
#### Heads Up Display (HUD) Panel
To have a quick view of the Measurements table, click **HUD** button at the top-right of the workspace. You can easily move and resize the HUD Panel on the workspace.
![HUD Panel](../assets/img/LesionTracker/LT_HUD_Panel.png)
Note: HUD button is only available if the study is associated with a timepoint.
### Additional Tools
#### Temporary Length Measurement
To check the size of a lesion without adding to the Measurements table, select **Temp Tool**.
![Temp Tool](../assets/img/LesionTracker/LT_Temp_Tool.png)
#### Stack Scroll Tool
To scroll images:
1. Click More button and select **Stack Scroll Tool**.
2. Drag down and up on the image viewer with the left mouse button.
![Stack Scroll](../assets/img/LesionTracker/LT_StackScroll_Single.png)
#### Reset Image Tool
To reset the geometric orientation, position and magnification of the image in the active image viewer, click More button and select **Reset Tool**.
![Reset](../assets/img/LesionTracker/LT_Reset.png)
#### Rotate Right Tool
To rotate the image in the active image viewer 90 degree clockwise, click More button and select **Rotate Right Tool**.
![Rotate Right](../assets/img/LesionTracker/LT_Rotate_Right.png)
#### Flip H Tool
To flip the image in the active image viewer horizontally, click More button and select **Flip H Tool**.
![FlipH](../assets/img/LesionTracker/LT_FlipH.png)
#### Flip V Tool
To flip the image in the active image viewer vertically, click More button and select **Flip V Tool**.
![FlipV](../assets/img/LesionTracker/LT_FlipV.png)
#### Invert Tool
To invert the image in the active image viewer, click More button and select **Invert Tool**.
![Invert](../assets/img/LesionTracker/LT_Invert.png)
#### Magnify Tool
Magnify Tool allows to zoom in a part of the image without changing zoom level of the whole image.
1. Click More button and select **Magnify Tool**.
2. Click and drag around the image with the left mouse button.
![Magnify](../assets/img/LesionTracker/LT_Magnify.png)
#### 3.7.9. Ellipse Tool
Ellipse Tool allows you to draw elliptical annotation with mean and standard deviation values.
1. Click More button and select **Ellipse Tool** then click on the image.
2. Hold, move and release the mouse button to create the annotation.
![Ellipse](../assets/img/LesionTracker/LT_Ellipse.png)
#### Save Screenshot
To save a screenshot of the current active viewport:
1. Click More button and click **Save Screenshot**.
2. Set image name and sizes and click Download.
![Download](../assets/img/LesionTracker/LT_Download.png)
#### CINE Tool
CINE Tool allows to play through stacks of images in the active viewport.
1. Click More button and click **CINE Tool**. The CINE dialog will pop up.
2. Click the desired media options from the CINE dialog.
3. To close CINE dialog, click **CINE Tool**.
![CINE](../assets/img/LesionTracker/LT_CINE.png)