Differences

This shows you the differences between two versions of the page.

--- dicom:userguide:userguide [2015/07/10 20:07] – [Overview] dpatenaude
+++ dicom:userguide:userguide [2021/07/29 18:23] (current) – external edit 127.0.0.1
@@ Line 15: / Line 15: @@
 ===== Getting Started =====
-The primary purpose of the astroid Dicom App is to provide a library of efficient and easily accessible proton dosimetry functions which can serve as the foundational tools for developing higher level radiation treatment planning and analysis software programs. The Dicom App is not intended to be an interactive end-user application; instead it will serve as a source of tested and validated calculation functions which software developers can utilize in other end-user applications. The astroid Dicom App provides access to these calculation functions through the thinknode™ framework which is accessible over the internet and performs all calculations in a cloud based environment. thinknode provides robust, redundant data storage, ensuring industry leading data integrity as well as stable software version management and release process.
+The primary purpose of the astroid Dicom App is to provide a library of efficient and easily accessible DICOM interpretation functions which can serve as building blocks for developing higher level radiation treatment planning and analysis software programs. The Dicom App is not intended to be an interactive end-user application; instead it will serve as a source of tested and validated calculation functions which software developers can utilize in other end-user applications. The astroid Dicom App provides access to these calculation functions through the thinknode™ framework which is accessible over the internet and performs all calculations in a cloud based environment. thinknode provides robust, redundant data storage, ensuring industry leading data integrity as well as stable software version management and release processes.
 ==== Connecting to thinknode™ ====
-The Dicom App, and all its released versions live on thinknode™ hosted on the Amazon S3 service. Communication with the App is performed over the internet through thinknode https requests which are password protected per user and permission based by thinknode organization administrators. The thinknode startup procedure includes full installation of the appropriate application environment onto the virtual servers, which includes hardware and performance checks to ensure sufficient resources are available for the requested application. A full thinknode™ userguide is found at [[https://developers.thinknode.com|https://developers.thinknode.com]].
+The Dicom App, and all its released versions reside on thinknode™. Communication with the App is performed over the internet through thinknode https requests which are password protected, per user, and permission based, by thinknode organization administrators. The thinknode startup procedure includes full installation of the appropriate application environment onto the virtual servers, which includes hardware and performance checks to ensure sufficient resources are available for the requested application. A full thinknode™ userguide is found at [[https://developers.thinknode.com|https://developers.thinknode.com]].
 Basic information needed to communicate with the Dicom App through thinknode™:
@@ Line 37: / Line 37: @@
 Any data posted to thinknode™ is immutable and can not be deleted. Please ensure when posting dicom files that you have anonymized patient data in the dicom files or that you are posting the data to a private bucket in thinknode™.
 </WRAP>
+===== Proton Delivery System Conventions =====
+{{page>dosimetry:userguide:userguide#proton_delivery_system_conventions&noheader&nofooter&noeditbutton}}
 ===== Functions =====
-The Dicom App exposes a few key functions through its API. Below is a list and brief explanation of a few of the most common functions. A full function list can be found at the [[http://docs.apps.dotdecimal.com/dicom|Dicom Manifest Guide]] as well as details of each function, argument parameters, and return values are provided at the.
+The Dicom App exposes a few key functions through its API. Below is a list and brief explanation of a few of the most common functions. A full function list as well as details of each function, its argument parameters, and return values are provided in the [[http://docs.apps.dotdecimal.com/dicom|Dicom Manifest Guide]].
+  * //**add_dcm_file_to_study:**//
+    * Takes in a rt_study and dicom file blob, parses the blob and adds it to the study.
+  * //**add_files_to_study:**//
+    * Adds dicom files to an existing study and returns the updated study.
+  * //**make_study:**//
+    * Makes a new study and initializes plan, ss and ct for importing dicom files
+  * //**write_beam_dose:**//
+    * Writes a dicom dose file for the beam specified in the study
+  * //**write_ct_image_slice:**//
+    * Writes a dicom ct image file as a blob from cradle rt_study data.
+  * //**write_ct_image_slices:**//
+    * Writes all dicom ct image files as blobs from cradle rt_study data.
+  * //**write_dose_image:**//
+    * Writes 3D image data containing dose information into a binary blob dicom dose file.
+  * //**write_patient:**//
+    * Returns a filesystem_item of the patient dicom files.
+  * //**write_plan:**//
+    * Writes dicom plan file as a blob from cradle plan data.
+  * //**write_plan_dose:**//
+    * Writes a dicom dose file for the plan in the study
+  * //**write_structure_set:**//
+    * Writes dicom structure set file as a blob from cradle structure set data.
-  - //**parse_dicom_filesystem_item**//:
-    * Parses a dicom //filesystem_item// type into a //dicom_data// type. The filesystem item can contain a thinknode ISS directory of dicom files.
-  - //**parse_dicom_blob**//:
-    * Parses a single dicom standard formatted file into a //dicom_data// type. This function handles the determination of which type of RT Types to create based on the files modality (e.g. rt plan, structure set, ct image, dose, etc). This function requires the input dicom file to be in a base64 encoded blob.
-  - //**parse_dicom_blobs_to_CT_iamge**//:
-    * Parses a list of dicom (blob) files and constructs the combined CT image set as an //image_3// type. Note: Non-CT files are ignored
-  - //**make_patient**//:
-    * Takes an array of //dicom_data// types and returns it as a //dicom_patient//. If there were CT Images it will combine them in to an //image_3d//.
 See the [[dicom:userguide:userguide#Calc_Provider_Examples|Calc Provider Examples section]] for example usage of some of the dicom functions.
@@ Line 77: / Line 96: @@
 {{page>dosimetry:userguide:userguide#Grid_and_Image_Data_Interpretation&nofooter&noeditbutton}}
 ===== Known Application Limitations =====
@@ Line 86: / Line 106: @@
 ----
-<WRAP center 10%>//USR-006//</WRAP>
-<WRAP center 40%>.decimal LLC, 121 Central Park Place, Sanford, FL. 32771</WRAP>
+<WRAP center 60%>.decimal LLC, 121 Central Park Place Sanford, FL. 32771 1-800-255-1613</WRAP>