Pinnacle Scripting - Scorecard Data

Description

>Pinnacle³ includes “scorecards” that allow users to quickly see if primary or secondary dose constraints have been met.

Parameters

1. ROI Name

Scorecard.DoseVolClinicalGoalList.Current.ExpectedRoi.Name

1a. ROI Name box color

I believe this number is “5890551” if the Scorecard ROI is not connected to a plan ROI (i.e. the yellow box). Otherwise no value is returned (see example below).

Scorecard.DoseVolClinicalGoalList.Current. ExpectedRoi.Color

2. Type (Min/Max DVH, Min/Max/Mean Dose)

Scorecard.DoseVolClinicalGoalList.Current.GoalType

3. Primary Goal Dose

Scorecard.DoseVolClinicalGoalList.Current.DosePassingCriteria

4. Primary Goal Volume

Scorecard.DoseVolClinicalGoalList.Current.VolPassingCriteria

5. Volume Units (cm^3 or %)

Scorecard.DoseVolClinicalGoalList.Current.VolUnits

6. Secondary Goal Dose

Scorecard.DoseVolClinicalGoalList.Current.DoseAcceptableVariance

7. Secondary Goal Volume

Scorecard.DoseVolClinicalGoalList.Current.VolAcceptableVariance

8. Actual Dose

Scorecard.DoseVolClinicalGoalList.Current.ActualDoseString

9. Dose Type (Min/Max/Mean)

Scorecard.DoseVolClinicalGoalList.Current.DoseType

10. Volume at Primary Goal Dose

Scorecard.DoseVolClinicalGoalList.Current.ActualVolumeString

11. Result (Not Met, OK, Met)

Scorecard.DoseVolClinicalGoalList.Current.Status

Examples

Access Scorecard Parameters

These parameters can be accessed using scripting.

InfoMessage = Scorecard.DoseVolClinicalGoalList.Current.ExpectedRoi.Name; //Display a pop-up with the name of the currently selected ROI:

Check if Scorecard ROI is connected to ROI in Plan (if the box is yellow or not)

IF. Scorecard.DoseVolClinicalGoalList.Current. ExpectedRoi.Color. Is. THEN. InfoMessage="ROI does not exist in plan"; //This code checks if a Scorecard ROI is connected to an ROI in the plan.

Load a scorecard

NameFilter and FilterScoreCard both seem to be necessary to specify the scorecard.
The full name doesn’t need to be used, just enough to filter the list.

//Filter and Load scorecard
Scorecard .NameFilter = "ScorecardName";
Scorecard .FilterScoreCard ="ScorecardName";
Scorecard .PerformLibraryOperation = "LoadFromLib";

Display and close a scorecard

*P16: It may be necessary to add to Xt to WindowList (i.e. XtWindowList….)

WindowList .TrialScoreCardEditor .Create = "Load..."; //Display scorecard
WindowList .TrialScoreCardEditor .Unrealize="Close Window";

Compute Scorecard

Scorecard .Compute = "Compute";

Lock Scorecards

Prepare for locking

1. Log in to the root account on the server or on a client and open an xterm window.
2. Type the following commands, and press the Enter key after each command:
chmod 1775 /usr/local/adacnew/PinnacleSiteData/UserSettings/Scorecards
chown root /usr/local/adacnew/PinnacleSiteData/UserSettings/Scorecards

Lock a scorecard (or technique)

In the following instructions, replace “<filename>” with the name of the scorecard (or technique).
1. Log in to the root account on the server or on a client and open an xterm window.
2. Type the following commands, and press the Enter key after each command:
chmod 644 /usr/local/adacnew/PinnacleSiteData/UserSettings/Scorecards/<filename>
chown root /usr/local/adacnew/PinnacleSiteData/UserSettings/Scorecards/<filename>

Pinnacle : Scorecards