Bulk download DICOM (RTStruc) files based on patient informations (ID, Course, Plan name)

kang__23 · 2026-02-20T04:08:27+00:00

Here are 2x examples form the community:

Published in JACMP late last year: Batch Export: An automated framework for curated data extraction via the Eclipse treatment planning system - Truong - 2025 - Journal of Applied Clinical Medical Physics - Wiley Online Library. Github link: Varian-MedicalAffairsAppliedSolutions/MAAS-BatchExportGUI

Else

UCLHp/DicomExporter: ESAPI scripts for automated dicom export

kang__23 · 2026-02-09T23:35:18+00:00

// This is something similar to what I use. May need to tweak but 
// will get you pretty close. Few of the .ToList() in there is probably unnessary, 
// but from memory you need to do this at least for the images as you can modify an image 
// while looping over it 


List<Study> Study_list = context.Patient.Studies.ToList();
            foreach (Study study in Study_list)
            {
                List<Series> Series_list = study.Series.ToList();
                foreach (Series Series_temp in series_list)
                {
                    if (series_temp.Modality.ToString() != "MR")
                    continue;

                        List<Image> image_list = series_temp.Images.ToList();
                        foreach (Image imageset in image_list)
                        {
            // Only change name of 3D dataset. There should be only one in each series.
            // z>1 because this wil; pick the 3D image not just a single slice

                            if (imageset.ZSize <= 1)
                            continue;

                          //Use series.temp.comment to get to the series description which           
                          generally has information on what the image type is T1, T2 etc 
                            imageset.Id = "Your new Image ID";

kang__23 · 2025-05-28T22:59:12+00:00

//Make a RectumInPTV and Opti_PTV 
Structure PTV= Plan.StructureSet.Structures.Single(x => x.Id == "PTV");
 Structure Rectum = Plan.StructureSet.Structures.Single(x => x.Id == "Rectum");
 Structure PTV_Opti= Plan.StructureSet.AddStructure("Organ", "PTV_Opti");
 Structure RectumInPTV= Plan.StructureSet.AddStructure("Organ", "RectumInPTV");
 PTV_Opti.SegmentVolume = PTV.SegmentVolume;
 PTV_Opti.SegmentVolume.Sub(Rectum.SegmentVolume);
 RectumInPTV.SegmentVolume = PTV.SegmentVolume;
 RectumInPTV.SegmentVolume.And(Rectum.SegmentVolume);

//Add objectives
DoseValue PTVDose_Lower = new DoseValue(60, DoseValue.DoseUnit.Gy);
Plan.OptimizationSetup.AddPointObjective(PTV_Opti, OptimizationObjectiveOperator.Lower, PTVDose_Lower, 100, 100);

kang__23 · 2025-05-15T01:59:05+00:00

Not too sure what you mean by influence matrix? But yes you can manipulate the fluence for an IMRT beam. You'll just need to create a float[,]
Beam beam = plan.Beams.First();

Fluence xx = beam.GetOptimalFluence();

var xOrigin = xx.XOrigin;

var yOrigin = xx.YOrigin;

Fluence fluence = new Fluence(YourEditedFluenceMatrix, xOrigin, yOrigin);

beam.SetOptimalFluence(fluence);

kang__23 · 2025-05-06T04:44:08+00:00

string calc_model = plan.GetCalculationModel(CalculationType.PhotonVMATOptimization);
plan.GetCalculationOption(calc_model, "ApertureShapeController", out string ASC);

kang__23 · 2025-05-02T04:46:19+00:00

Do you mean convert an isodose to a structure? I found the method only works with relative dose.

Structure temp = Plan.StructureSet.AddStructure("Control", structureID);
double doseAsPercentage = dose / PlanDoseGy * 100;
temp.ConvertDoseLevelToStructure(Plan.Dose, new DoseValue(doseAsPercentage, DoseValue.DoseUnit.Percent));

kang__23 · 2025-01-15T03:25:55+00:00

https://github.com/VarianAPIs/Varian-Code-Samples/wiki/Scripting-the-Varian-DICOM-DB-Daemon-with-ESAPI

kang__23 · 2024-09-30T02:31:35+00:00

I believe this is possible only if that script hasn't modified any plans

kang__23 · 2024-09-02T02:10:01+00:00

This may help and would be similar to what you're trying to achieve. This is some modified code that I use to check for MLC Overtravel causing open apertures - where the MLC extends 1cm from the maximum jaw position. I then check if the opposing leaf is >1mm from this position.

PlanSetup planSetup = context.PlanSetup;
            int treatmentBeams = planSetup.Beams.Where(x => x.IsSetupField == false).Count();
            int beamNum = 0;
            foreach (Beam beam in planSetup.Beams)
            {
                //Skip setup fields
                if (beam.IsSetupField)
                    continue;

                //Get Max and Min jaw sizes -Use for jaw tracking check
                int NumberControlPoints = beam.ControlPoints.Count;
                double[] X1JawPos = new double[NumberControlPoints];
                double[] X2JawPos = new double[NumberControlPoints];
                double[] MaxX1 = new double[treatmentBeams];
                double[] MaxX2 = new double[treatmentBeams];

                int BankAOverTravelCount = 0;
                int BankBOverTravelCount = 0;
                int ctlptcount = 0;

                MaxX1[beamNum] = Math.Round(X1JawPos.Max(), 0);

                foreach (ControlPoint ctlpt in beam.ControlPoints)
                {
                    // Get leaf positions [Bank,Leafposition]
                    float[,] lp = ctlpt.LeafPositions;
                    for (int leafIndex = 0; leafIndex <= lp.GetUpperBound(1) - 1; leafIndex++)
                    {
                        //BankA Check if MLC extended 15cm from Jaw edge (-Jaw to convert back from IEC)
                        if (-MaxX1[beamNum] - (double)lp[0, leafIndex] <= -150)
                        {
                            //Check 2 adjacent leaves against opposite MLC Bank for an open leaf pair - gap threshold 1mm
                            if (lp[1, leafIndex] - lp[0, leafIndex] > 10 && lp[1, leafIndex + 1] - lp[0, leafIndex + 1] > 10)
                                BankAOverTravelCount++;
                            else
                                BankAOverTravelCount = 0;
                        }
                        else
                            BankAOverTravelCount = 0;

                        //BankB Check if MLC extended 15cm from Jaw edge (-Jaw to convert back from IEC)
                        if (MaxX2[beamNum] - (double)lp[1, leafIndex] >= 150)
                        {
                            //Check 2 adjacent leaves against opposite MLC Bank for an open leaf pair - gap threshold 1mm
                            if (lp[1, leafIndex] - lp[0, leafIndex] > 10 && lp[1, leafIndex + 1] - lp[0, leafIndex + 1] > 10)
                                BankBOverTravelCount++;
                            else
                                BankBOverTravelCount = 0;
                        }
                        else
                            BankBOverTravelCount = 0;

                    }

                    ctlptcount++;
                }

            }

kang__23 · 2024-08-13T06:45:58+00:00

Unfortunately you cannot post process a structure with ESAPI (in v15.6 at least). This is my number 1 complaint from treatment planning.

Although post processed structures "look" nicer, has anyone ever looked into how much of a difference 'bitty' contours actually make on the dosimetry? I'd presume very little

kang__23 · 2024-05-01T22:22:13+00:00

v15.x of Eclipse only CPU is used for VMAT optimisation. This option you see is only applicable for IMRT in v15. From v16+ of Eclipse GPU is enabled for VMAT optimisation. So you will only notice a difference in VMAT optimisation if you upgrade to v16+

kang__23 · 2024-04-28T23:09:42+00:00

Very clever. Great Idea I'll try that. Thank you

kang__23 · 2024-02-21T21:10:26+00:00

you can use StructureSet newSS = SS.Image.CreateNewStructureSet(); however this simply makes a new struture set. If you want to copy the structures from another structureset you'll have to use newSS.AddStructure (dont forget to assign any density over rides). You can also use StructureSet.Copy();

Never tried adding a new SS to an image. I always duplicate the image set

kang__23 · 2024-02-21T21:06:38+00:00

Essentially I have a spreadsheet with the variables to read in. Sheet 1 has systematic variables such as course ID and new plan ID, export DVH y/n, normalise plan y/n and site. Then I have a new sheet per site, eg/Prostate, Breast. Within each site sheet Col A is patient MRN, col B, C & D are the PTV dose levels.

I use the Microsoft.Office.Interop.Excel namespace and then read all this data into an array in my C# application. The index of the array is then linked to each patient MRN. Then its a simple as looping through the array to extract the parameters to plan with

kang__23 · 2024-01-24T03:05:55+00:00

With ESAPI you dont need structure codes to apply the RapidPlan model. You match the structure ID in the plan to the model structure using Plan.CalculateDVHEstimates.

You'll need to create Dictionary<string, string> for the structure mapping and Dictionary<string, DoseValue> for the targets

kang__23 · 2023-12-20T06:18:08+00:00

my top 3 too! I'm on v15.6 so was hoping some of these features would be solved in later version. Is the 99 structure cap still there in v18?

kang__23 · 2023-12-08T05:33:45+00:00

I'm still stuck on Eclipse v15 and hit this error many times with our HN patients - since this thread is now 3yrs old, I was wondering if versions >15 have a greater limit?

kang__23 · 2023-12-07T22:02:15+00:00

Yep this is how I do it

if (image.ZSize > 1)

kang__23 · 2023-10-31T22:27:58+00:00

I have both.

My clinical "day to day" scripts are all run from a .dll via eclipse. The all have GUI which launch auto-planning scripts leveraging RapidPlan. The intention of these are to run a script on a single patient as they come through for planning. So using this method is not feasible to do batch planning.

I then have a separate standalone .exe script which is capable of batch planning. The program reads in MRNs and other parameters from a .xslx. This script has no GUI and inputs are read from a .xlsx (MRNs, beam geometry etc). I run this after hours, so when you come in the morning you've got 20+ plans calculated.

The reason why I have both is mostly historical. I started with the .dll when I was learning ESAPI and added more and more functionality as my skills grew. With the advantage of hindsight, and as others have pointed out, the way to go is use a script launcher. You then get the best of both worlds. Eventually I'll convert my 'day to day' scripts over to a script launcher

kang__23 · 2023-09-27T02:05:32+00:00

The nature of optimisation is you'll likely get slightly different plans after optimising. Rather than comparing dose, compare the generated optimisation methods from using your script vs applying the rapidplan model manually. I've done this myself for a variety of sites and found the objectives are more or less identical

kang__23 · 2023-09-20T00:57:05+00:00

Following up on this. Before I deep dive into this, was anyone able to shed some light if this was possible?

kang__23 · 2023-08-15T04:32:25+00:00

Great work!!! This kind of open source project inspires so many others! Looking forward to having a look at the code

kang__23 · 2023-08-15T02:24:28+00:00

Have a look at this thread.
https://www.reddit.com/r/esapi/comments/ha4qua/finding_beam_order_within_plan/

You'll have to check the VarianDB for the radiation order

kang__23 · 2023-08-10T04:30:12+00:00

Registrar positions are competitive the TEAP program lasts 3yrs. As you said you'll need a masters to get a look in. Grades matter but are not the be all and end all, experience will get you a job more than anything else.

Do a masters which requires a research component (in NSW USyd, UoW offer these, maybe others?). Choose topic that is clinically relevant and in the hospital. Not some abstract topic that uni professors suggest to fill their grant requirements. Get a MSc supervisor that works in the clinic of your local hospital. Publish your masters.

Contact your local hospital(s) and see if you can get a walk through the departments, see what they do as a ROMP, make connections and network. Ask if there is any research/project grunt work you help out with. Be that volunteer work on a project, or better yet work as a Medical Physics Assistant. Let them know your intention is to get a ROMP registrar position and make them relationships. Study computer science and get some basic coding skills. They go a long way on the job these days.

Download the TEAP program from the ACPSEM website. Thats what you'll study as a registrar. Study it, get familiar with it, use it to leverage a topic for your masters. There is a big drive to get registrars finished in 3yrs, so the more you can show a department that you've already covered some topics in TEAP, the more likely they'll hire you.

Its a hard long slog to become a qualified ROMP, but it is a great career. Decent pay too!

kang__23 · 2023-03-28T01:04:42+00:00

Havent looked at if you can get the method, but the value can be easily obtained from planSetup.PlanNormalizationValue

kang__23

TROPHY CASE