GODS Alpha Release Documentation



Graphical Oncology Diagnostic System (GODS)

Production Release Documentation

Date: May 11, 2004

Developers (Team Members):

• Andi Sutedja

• Shih-Ying Yang

• Bipin Vaddi

• Pradeep Kanneganti

Team Manager/Advisor: Professor Ethan Bolker

________________________________________________________

A STATEMENT ABOUT THIS DOCUMENTATION

This production release documentation of Graphical Oncology Diagnostic System is intended for users and installers of the application. For programmers who are interested in understanding the code details of GODS, please access the source files that can be downloaded at , and read the comments/documentation in them.

________________________________________________________

PREREQUISITES

Before downloading, installing, and running the executable file of GODS, the following system requirements should first be met:

1. Make sure your computer is running Windows 2000 or Windows XP. To determine what version of Windows you are running:

a. Right-click on My Computer and click Properties.

b. In the System Properties window, under the General tab, you should see the version of your Windows.

2. Make sure your computer has the Microsoft .Net Framework 1.1 installed. To determine if your computer already has the .Net Framework 1.1 installed:

a. Click on Start -> Control Panel -> Add or Remove Programs.

b. In the list of “Currently installed programs:”, if you see Microsoft .Net Framework 1.1, then you are all set. Otherwise, please follow the following instruction for installing the Microsoft .Net Framework 1.1.

Installing Microsoft .Net Framework 1.1

There are two options to install .Net Framework:

• Use Microsoft Windows Update by accessing it from either clicking on Start -> Windows Update (in Windows 2000) or clicking on Start -> All Programs -> Windows Update (in Windows XP). You can also access Windows Update by going directly to .

• Get it from Microsoft website:

1. Go to .

2. Click on “.NET Framework 1.1” link under the “downloads” section.

3. Click on the link that says “Microsoft .Net Framework 1.1 Redistributable”.

4. Click on the “Download” button.

5. To start the installation immediately, click Open or Run this program from its current location. To copy the download to your computer for installation at a later time, click Save or Save this program to disk.

________________________________________________________

DOWNLOADING AND INSTALLING GODS

How to download and install GODS:

1. Make sure that you have read the Prerequisites section above before continuing.

2. To download GODS, please go to .

3. Under the Production Release section, click on the link “Download the Zipped Executable File Here”.

4. Click on the Save button.

5. Choose the location where you would like to save the file, and click on the Save button.

6. Browse to the location where you chose to save the zip file. The downloaded file name should be GodsExe.zip.

7. Unzip GodsExe.zip using a Zip utility program, such as the WinZip program that can be downloaded freely from .

8. You should now have the GodsExe folder as the result of unzipping GodsExe.zip.

9. Double-click on the GodsExe folder.

10. Double-click on the Gods.exe file to run GODS.

________________________________________________________

PRODUCTION RELEASE FEATURES

As this application is built specifically for Dr. Kevin Hughes of the Massachusetts General Hospital, all the current features of this product are implemented in response to all of needs of Dr. Hughes.

In this production release of this software, user can perform graphical drag-and-drop operations on all of the breast cancer diagnostic marks seen on the user interface, and these include: Normal Lump, Horizontal Lump, Vertical Lump, Cyst Drained, Thickening, Left Gynecomastia, Right Gynecomastia, Auxillary Fat Pad, Mastectomy, Inverted Nipple, Echzematoid Nipple, and Node. In addition to the graphical marks, there are also two non-graphical marks, i.e. Left Nipple Discharge and Right Nipple Discharge. These two non-graphical marks are basically two drop-down menus, from which user can select for each type of the Nipple Discharge characteristics.

In addition to the feature that allows user to enter both graphical and non-graphical marks in the application, user can also have the option of adding custom text entry for each of the mark he/she places on the breast sketch. This includes adding custom text entry to the non-graphical Nipple Discharge marks.

Each time a mark (either graphical or non-graphical) is placed on the breast sketch, the Summary/Description panel at the bottom of the application is updated with data corresponding to the mark. Of course, there can be as many marks as possible that user can placed onto the breast sketch. To determine which of the marks is currently selected, user can just click once on the graphical mark, and the corresponding data in the Summary/Description panel will be highlighted.

Depending on its type, a mark can have different characteristics, and can only be dropped at the predetermined correct locations. More information about this will be provided in the User Manuals section of this documentation.

In addition to seeing the graphical representation of the marks placed on the breast sketch, data about the marks can also be saved into a Microsoft Access database. Once the data are in the Access database, user can search/query it for a particular patient. Furthermore, from the data in the database, user can also create a Microsoft Word document report. An example of this is to generate the report using Word's built-in mail-merge tool.

In this release, however, the database connectivity feature is not yet fully functional. It can now only connect to a table in the default database and retrieve the data there, and user can also select a new location for the Access database from Options in the menu bar. The feature of the database connectivity that has not been implemented is the ability to save the correct data on the marks to the database, and this includes the ability of saving the snap-shot of the marked breast sketch for the particular patient. This feature is expected to be completed for the Maintenance release, which is due in one week time.

________________________________________________________

USER MANUALS

Running the application:

1. Make sure that you have read and followed the instructions in the Prerequisites section of this documentation.

2. To run the application, simply double-click on Gods.exe file.

3. The default GODS Access database file comes with the GodsExe.zip package that you downloaded in step 1.

Changing the location of GODS Access database:

1. Go to Options on the menu bar.

2. Click on Import Database to open the Windows File Open dialog.

3. You can now select the location of your own Access database using this standard Windows File Open dialog.

Exiting the application:

1. To exit the application, you can perform one of the following methods:

a. Click on the Windows "X" button (close button).

b. Click on the Exit button.

c. Go to File on the menu bar, then click on Exit.

2. Click Yes, when prompted for Exit confirmation.

Saving to database:

1. Simply click on the Save button.

Placing a graphical mark (either Lump, HLump, VLump, Cyst Drained, Thick, R Gynecomastia, L Gynecomastia, Auxilarry Fat Pad, Mastectomy, Inverted, Echzematoid, or Node) onto the breast sketch:

1. Use the mouse to click and hold on the mark.

2. While holding it, drag the mouse to the breast sketch.

3. Release the mouse button.

4. Please note that each mark has its designated drop target. Please refer to the Mark Characteristics section of this User Manuals.

Removing a graphical mark (either Lump, HLump, VLump, Cyst Drained, Thick, R Gynecomastia, L Gynecomastia, Auxilarry Fat Pad, Mastectomy, Inverted, Echzematoid, or Node) from the breast sketch:

1. Click and hold on a mark which is already on the breast sketch.

2. Drag it away from the breast sketch.

3. Release the mouse button.

Adding a non-graphical mark (either Right Nipple Discharge or Left Nipple Discharge):

1. Click on either of the Nipple Discharge drop-down menu.

2. Selected the desired characteristics.

3. Since this is non-graphical mark, you will not see it on the breast sketch, but you can see the reflected change on the Summary/Description panel.

Removing a non-graphical mark (either Right Nipple Discharge or Left Nipple Discharge):

1. Click on either of the Nipple Discharge drop-down menu.

2. Select none.

Adding custom text entry to a graphical mark:

1. Click on a mark that is already on the breast sketch.

2. Click on the Edit Mark Data button.

3. Type in the custom text data into the text box of the Mark Text Data Editor window.

4. Click OK to confirm or Cancel to cancel the operation.

Adding custom text entry to a non-graphical mark:

1. Click on either of the Nipple Discharge drop-down menu.

2. Click on the Edit Mark Data button.

3. Type in the custom text data into the text box of the Mark Text Data Editor window.

4. Click OK to confirm or Cancel to cancel the operation.

Valid Mark Drop-Target Image for Reference:

[pic]

Mark Characteristics (please refer to the image above for valid drop-target areas):

1. Lump

• A Lump can only be dropped onto areas 4 and 5.

• When a Lump is dropped (or selected), the clock-wise position is automatically shown.

• User can change the dimension of a Lump by selecting the dimension value of the drop-down menu from the Mark Dimension section.

2. HLump (Horizontal Lump)

• An HLump can only be dropped onto areas 4 and 5.

• When an HLump is dropped (or selected), the clock-wise position is automatically shown.

• User can change the dimension of an HLump by selecting the dimension value of the drop-down menu from the Mark Dimension section.

3. VLump (Vertical Lump)

• A VLump can only be dropped onto areas 4 and 5.

• When a VLump is dropped (or selected), the clock-wise position is automatically shown.

• User can change the dimension of a VLump by selecting the dimension value of the drop-down menu from the Mark Dimension section.

4. Cyst Drained

• A Cyst Drained can only be dropped onto areas 4 and 5.

• When a Cyst Drained is dropped (or selected), the clock-wise position is automatically shown.

5. Thick

• A Thick can only be dropped onto areas 4 and 5.

• When a Thick is dropped (or selected), the clock-wise position is automatically shown.

• User can change the dimension of a Thick by selecting the dimension value of the drop-down menu from the Mark Dimension section.

6. Right Gynecomastia

• A Right Gynecomastia can only be dropped onto areas 4 and 5.

• When a Right Gynecomastia is dropped (or selected), the clock-wise position is automatically shown.

• User can change the dimension of a Right Gynecomastia by selecting the dimension value of the drop-down menu from the Mark Dimension section.

7. Left Gynecomastia

• A Left Gynecomastia can only be dropped onto areas 4 and 5.

• When a Left Gynecomastia is dropped (or selected), the clock-wise position is automatically shown.

• User can change the dimension of a Left Gynecomastia by selecting the dimension value of the drop-down menu from the Mark Dimension section.

8. Auxillary Fat Pad

• An Auxillary Fat Pad can only be dropped onto areas 3 and 6.

9. Mastectomy

• A Mastectomy can only be dropped onto areas 4 and 5.

10. Inverted

• An Inverted can only be dropped onto areas 7 and 8.

11. Echzematoid

• An Echzematoid can only be dropped onto areas 7 and 8.

12. Node

• A Node can only be dropped onto areas 1, 2, 3, and 6.

• User can change the dimension of a Node by selecting the dimension value of the drop-down menu from the Mark Dimension section.

• To select a Node's characteristics, click on the drop-down menu right by the Node section, and select a characteristic.

________________________________________________________

SOME SAMPLE KNOWN BUGS

• When a Mark is dropped on top of another existing Mark, the later Mark will stay behind the previous Mark. (Not Fixed)

• When a Mark, which is already on the breast sketch, is being dragged and dropped too many times (over 10 times), it will take longer time to redraw the mark. (Not Fixed)

• Currently when the application saves the marks' data into the database, the table used to store the data in the database only shows blank lines. (Not Fixed)

• When exiting the application, it does not check to see if the data about the marks have been saved to the database. (Not Fixed)

• After the save button is clicked, the application does not exit, which it should do so in principle in order to prevent duplicate entries each time the save button is clicked. (Not Fixed)

• When this application is run on a Traditional Chinese version of Microsoft Windows XP, the valid drop target is no longer accurate. (Not Fixed)

• Summary/Description panel did not display description that has the length which is longer than the width of the panel. (Fixed)

• Clock wise position value sometimes did not display the right value. (Fixed)

________________________________________________________

TESTING

This version of the software has been thoroughly tested, including Usability Testing, Unit Testing, Customer Testing, as well as Non-customer Testing. Based on all those testing efforts we had conducted, this release of the application is bug-free and has fulfilled the needs of our primary customer, who is Dr. Kevin Hughes of the Massachusetts General Hospital.

The following is a simple set of test steps and users are welcome to follow them to get a first impression of what this application can do:

1. Using the mouse, click and drag a Lump over to the right breast at about 9 o’clock from the right nipple. Notice that the Summary/Description panel now shows a line of texts that say, “Lump of size 1cm x 1cm is in right breast at 9 o’clock.” Notice also that the Position box displays “9” and the Mark Dimension drop-down menus display “1” and “1”. Furthermore, you will notice that the Summary/Description panel highlights the line corresponding to the Lump.

2. Using the mouse, click and drag a Cyst Drained over to the left breast at about 3 o’clock from the left nipple. Notice that the Summary/Description panel now shows a second line of text (highlighted), which says, “Cyst Drained is in the left breast at 3 o’clock.” Notice also that the Position box now displays “3” and the Mark Dimension drop-down menus are disabled.

3. Now click once on the Lump mark that is on the right breast. Notice that the Summary/Description panel is now highlighting the line of text describing the Lump mark. And at the same time, the Position and the Mark Dimension drop-down menus also now reflect the properties of the selected Lump Mark.

4. Click on the down arrow of the left drop-down menu of the Mark Dimension to select a width for the Lump. You will notice that the Lump information line in the Summary/Description panel will now reflect the change of the width value. Do the same for the height of the Lump.

5. Now similar to step 3, click once on the Cyst Drained mark, and you will notice that the Summary/Description panel is now highlighting the line of text corresponding to the Cyst Drained, as the Cyst Drained mark is the currently selected mark on the breast sketch.

6. Now drag and move the Lump mark to the left breast at 12 o’clock from the left nipple. The change of the Lump properties is reflected in the Summary/Description panel, in terms of its new position on the left breast and the new clock-wise position.

7. Now drag and move the Cyst Drained mark to the right breast at 6 o’clock from the right nipple. The change of the Cyst properties is reflected in the Summary/Description panel, in terms of its new position on the right breast and the new clock-wise position.

8. Now click once on the Lump mark which is on the breast sketch.

9. Click on the Edit Mark Data button; type in a custom text data, and click the OK button.

10. Notice that the custom text data is now added to the line of text corresponding to the Lump mark in the Summary/Description panel.

11. Repeat step 8 to 10 for the Cyst Drained mark.

12. You can now repeat step 1 to step 11 as many times as you want for other available marks on the mark panel.

13. To remove a mark from the breast image, just drag it away from the breast image.

14. To save the information displayed in the Summary/Description panel into a database, simply click on the Save button.

15. This concludes the main features of this application.

16. To access the Help Documentation from this application, just click on Help from the menu bar and then click on Documentation.

17. To close and exit the application, click on File from the menu bar and then click on Exit. You can also exit this application by clicking on the Exit button or clicking on the Windows "X" (close) button. Choose Yes when prompted to confirm the exit.

________________________________________________________

WHAT TO FOLLOW IN MAINTENANCE RELEASE

• For the maintenance release of this application, our main goal is to clean up our source code, mainly to remove any unnecessary commented-out code.

• We will also add more detail comments (documentation meant to be read by other programmers) to the source code.

• When time permits, we will continue on polishing up our database connectivity feature. This should include:

o making sure that the data being saved are correct.

o making sure that a snap-shot of the marked breast sketch is also saved.

o making sure that the application will check to see if data have been saved before exiting it.

o making sure that the application should exit after the save button is clicked to prevent duplicate entries in the database.

_________End of GODS Production Release Documentation_________

................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download