Introduction
Eclipse is used to plan radiotherapy treatments for patients with malignant or benign diseases. The users of Eclipse are medical professionals who have been trained in radiation dosimetry. After an oncologist has decided that radiotherapy is the suitable treatment for a patient, the medical professionals use Eclipse to plan the treatment for the patient. Eclipse can be used to plan external beam irradiation with photon, electron, and proton beams, as well as for internal irradiation (brachytherapy) treatments. Eclipse is part of Varian's integrated oncology environment.
The Eclipse Scripting Application Programming Interface (Eclipse Scripting API or ESAPI) is a programming interface and a software library for Eclipse. It allows software developers to write scripts to access the treatment planning information in Eclipse. The scripts can be integrated into the Eclipse user interface, or they can be run as stand-alone executables.
Who Should Read This Manual
This manual is written mainly for medical/technical personnel who wish to write custom scripts to be used in Eclipse. It is assumed that you are familiar with:
Eclipse Treatment Planning System
Radiation oncology domain and concepts
DICOM
Software engineering practices
Microsoft Visual Studio development environment
Microsoft Visual C# programming language and object oriented development
Visual Cues
This publication uses the following visual cues to help you find information:
This publication uses the following visual cues to help you find information:
WARNING
A warning describes actions or conditions that can result in serious injury or death.
Caution
A caution describes hazardous actions or conditions that can result in minor or moderate injury.
NOTICE
A notice describes actions or conditions that can result in damage to equipment or loss of data
Note
A note describes information that may pertain to only some conditions, readers, or sites.
Tip
A tip describes useful but optional information such as a shortcut, reminder, or suggestion, to help get optimal performance from the equipment or software.
Related Publications
RT Administration Reference Guide
Beam Configuration Reference Guide
BrachyVision Instructions for Use
BrachyVision Reference Guide
BrachyVision Algorithms Reference Guide
Eclipse Photon and Electron Algorithms Reference Guide
Eclipse Cone Planning Online Help
Eclipse Photon and Electron Instructions for Use
Eclipse Photon and Electron Reference Guide
Eclipse Proton Reference Guide
Eclipse Proton Instructions for Use
Eclipse Proton Algorithms Reference Guide
Eclipse Scripting API Online Help
Varian Service Portal User Rights Reference Guide
Varian Service Portal Administration Reference Guide
DICOM Import and Export Reference Guide
Varian Medical Systems Backup Guidelines (CTB-GE-936)
Contact Varian Customer Support
Varian Customer Support is available on the internet, by e-mail, and by telephone. Support services are available without charge during the initial warranty period.
The MyVarian website provides contact information, product documentation, and other resources for all Varian products.
Use MyVarian to report incidents. Any serious incident that has occurred while using the device should be reported to the manufacturer and the competent authority of the Member State in which the user or patient is established.
- Go to www.MyVarian.com.
- Choose an option:
- If you have an account, enter your user login information (e-mail and password).
- If you do not have an account, use the on-screen prompts to create one. Establishing an account may take up to two working days.
- To get customer support:
- To display contact information, click Contact Us at the top of the page.
- To access product information and other support options, click Documentation at the top of the page, or use the menu on the top right side of the screen.