PlanScoreCard
Medical Affairs Applied Solutions ESAPI tool to create dosimetric ScoreCards and score plans.
Features:
- Quantitative piecewise linear scoring functions for each metric
- optional: flag for point where "variation acceptable" sited on referenced protocol
- optional: note section to site referenced protocol or justification for metric (points)
- optional: qualitative colors and labels for metric points, ie: orange="Just OK"
- Compare multiple plans in multiple courses at the same time for a given patient
- Advanced scoring criteria supported
- Advanced structure matching logic with integrated customizable preloaded json structure dictionary
- In-metric Structure Boolean/expansions created dynamically for scoring
- optionally save back to Plan if script approval/writable (to auto-create optimization tuning structures)
- Normalize dose to max score
- removes noise during plan comparison from suboptimal normalization impacting relative scores
- re-normalized to max score plans saved into a new course
- Dose per fraction and number of fractions stored in scorecard
- Linear scaling of all doses on scorecard possible if # fx and dose/fx not matching Eclipse
- Checkbox to annotate note explaining specific metric performance (for report printing)
- CSV or PDF output reports
- Example ScoreCards can be found here: https://medicalaffairs.varian.com/dose-scorecards
Main Screen
ScoreCard Editor
Structure Builder
Installation Guide: Quick-Start
- Click "releases" on the right side of this window
- Find your Eclipse version, expand "Assests" and click the largest ".zip" file to download
- Locate the downloaded file and move it to a location that can be acessed by your Eclipse system
- Once the .zip file has been moved to where Eclipse can acccess, right click select "properties" and unblock (if blocked)
- Extract the .zip file to create a directory by right clicking the file and selecting "Extract All...", click next until finished
- In Ecllipse, click Tools from the menu bar and select "Scripts", click folder, then "Change Folder..."
- Browse into the directory you created after extracting the file above and click "Open"
- Run the PlanScoreCardLauncher.cs
Installation Guide: Move PlanScoreCard to system scripts directory, copy and edit launcher (optional)
- Open your system scripts directory, click "System Scripts", "Open Folder...", OK
- Cut/paste or drag/drop the directory you extracted from the .zip above into the PublishedScripts directory
- Open the directory containing the PlanScoreCard software and right click PlanScoreCardLauncher.cs, select Copy
- Go up a directory, back to the PublishedScripts directory and paste the PlanScoreCardLauncher.cs there
- Copy the name of the PlanScoreCard software directory
- Open the PlanScoreCardLauncher.cs file with Notepad, highlight "SubDirectory", right click and "Paste"
- Cut the "//" comment from that line of the file
- Paste it onto the beginning the following line instead and save the file, close Notepad
- Reopen the Scripts window in Eclipse, click System Scripts, select PlanScoreCardLauncher.cs and select "Run"
Common Troubleshooting
error after accepting the EULA (legal agreement) because the software can't write to the config file over a network (UNC path)
This error:
Can be worked around by maunaully editing the planscorecard.exe.config, set EULAAgree to "true" manually
Unblock .zip prior to unzipping
Permissions on Directory with executable
Current version: V2.5.6.X-06/01/2022
Improvements:
N/A
Bugfixes:
- Fixed unable to change metric type or edit metrics after clicking recalculate score (must restart PlanScoreCard and reload to edit)
- Fixed no longer real time plot updating in Metric Editor
- Fixed modified gradient index crashes if values left blank
- Fixed metrics, structures, and Rx from a previously opened scorecard are propagated to the editor
- Fixed change the Rx in the scorecard editor, back on scorecard page the Rx isn't updated
- Fixed ScoreCardBuilder Selecting metric value for variation does not update plot
- Fixed ScoreCardBuilder Possible to select multiple variation values in a single metric
- Fixed certain patients cause crash on launching PlanScoreCard (only seen in V17)
Known issues:
- ScoreCardBuilder Intermittent color/label change also changes lowest color/label in qualitative label/edit color picker
- ScoreCardBuilder Copying metric without structure assigned crashes app
- StructureBuilder Reparse existing structurebuilder structures for editing (currently must delete and re-create)
2.X Feature roadmap:
- guided structure builder (aka: simple mode, to be in front of current advanced structure builder)
- reload current patient from Eclipse button
- command line interface to output plan scores to the CLI or automate generation of CSV/PDF
- Import/Export buttons on ScoreCard Builder to support opening and saving various file types
- optional DVH rendering below UI with horizontal(D@V)+vertical(V@D) scoring brackets per selected structure
Changelog
V2.5.0.6-05/19/2022
Improvements:
MainScreen UI improvements:
A. Not Validated for Clinical USE moved to title
B. The word Summary Removed
C. Summary moved to top of application.
D. Flags and Warnings turned into buttons and don't grow with the number of messages anymore.
E. The word "Plan Scores:" is no longer on its own line.
F. Unit put on value.
G. EULA moved under Plan Selection.
H. Open Patient button removed (it didn't do anything anyway)
I. Patient selection textbox disable from editing.
J. Score Rx scaling disappears if PRIMARY plan Rx matches the scorecard
ScoreCard Builder improvements: Fixed issues with "Do Not Ask Again" on structure matching.
- Initial structure dictionary
- If a structure is unrecognized it will be unmatched.
- Then if you match a structure that is unmatched, you'll get the prompt about the structure dictionary.
- If you say yes, you should see all the structures get matched. (just use the default) selection
- Now the dictionary looks like this:
- Note that you have to click on the new row to get the text in the structure column to update.
- Then if you want to change that match you now can.
- The prompt won't come up again, but if you wanted to add this to the dictionary as well, then you can use the dictionary editor tool.
- Then you'll have 2 synonym entries in there so make sure that if you have 2 matches in your structure set, maybe you don't know which one the tool is going to choose (but I'd assume the first in order). Notice when I reload the tool they all match to "Hearts" because that's the first in the list.
- If you wanted to modify the actual scorecard, there is a new button to do that. This should allow you to maybe change the scorecard to a new naming convention you'd want to use.
- This will change the value in the scorecard (although even just changing the Plan structure and resaving would allow for you to reload the scorecard because the tool look at structure ID first and then tries to match from Template Structure Id second)
- Finally, there is a new tool for managing the scorecard. If you use the last option to Delete Match, you can break the complete between a structure and its structure checkbox.
- This removes the structure synonyms from that structure completely (because I selected both of the matches for removal)
Structure Builder improvements
- Operations between non-HighRes and HighRes solved (non-HighRes converted to HighRes first)
Bugfixes:
- Fixed issue where scorecard was crashing on modified gradient index.
- This was crashing because the structure was left empty when building the scorecard. Now if the structure is null, then the scorecard will not crash, but going forward if the user tries to build a scorecard and doesn't select the structure than it will not let the user save.
- Please choose body when selecting this metric if the metric is to be calculated in the entire body
- Fixed CI throwing error
- Fixed HI defaulting to cGy when not selected
- Set the structure collection to clear each time so it should only show the primary plan's structures.
- Can now delete metric comment all the way
Known issues:
- Unable to change metric type or edit metrics after clicking recalculate score (must restart PlanScoreCard and reload to edit)
- No longer real time plot updating in Metric Editor
- Intermittent color/label change on adjacent color/label in qualitative label/edit color picker
- Certain patients cause crash on launching PlanScoreCard (only seen in V17)
- Reparse existing structurebuilder structures for editing (currently must delete and re-create)
- Modified gradient index crashes if values left blank
2.X Feature roadmap:
- guided structure builder (aka: simple mode, to be in front of current advanced structure builder)
- reload current patient from Eclipse button
- command line interface to output plan scores to the CLI or automate generation of CSV/PDF
- Import/Export buttons on ScoreCard Builder to support opening and saving various file types
- optional DVH rendering below UI with horizontal(D@V)+vertical(V@D) scoring brackets per selected structure