Differences

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

--- dicom:userguide:userguide [2015/08/17 13:59] – [Functions] dpatenaude
+++ dicom:userguide:userguide [2021/07/29 18:23] (current) – external edit 127.0.0.1
@@ Line 46: / Line 46: @@
 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_dose_to_patient**//:
+  * //**add_dcm_file_to_study:**//
-    * Adds a plan summation dose (image3) to a dicom_patient. Requires a dicom patient to have an associated rt_plan.
+    * Takes in a rt_study and dicom file blob, parses the blob and adds it to the study.
-  - //**add_structure_set_to_patient**//:
+  * //**add_files_to_study:**//
-    * Adds a structure set to a dicom_patient. Replaces the existing structure set (if present). Requires a dicom patient to have an associated rt_plan.
+    * Adds dicom files to an existing study and returns the updated study.
-  - //**make_patient**//:
+  * //**make_study:**//
-    * Takes an array of //dicom_data// types and returns it as a //dicom_patient// containing all supported data that was found within the provided files. If there were CT Images it will combine them in to an //image_3d//.
+    * Makes a new study and initializes plan, ss and ct for importing dicom files
-  - //**parse_dicom_filesystem_item**//:
+  * //**write_beam_dose:**//
-    * Parses a dicom //filesystem_item// type into a //dicom_data// type. The filesystem item can contain a thinknode ISS directory of dicom files.
+    * Writes a dicom dose file for the beam specified in the study
-  - //**parse_dicom_blob**//:
+  * //**write_ct_image_slice:**//
-    * 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 file's modality (e.g. rt plan, structure set, ct image, dose, etc). This function requires the input dicom file to be a binary file blob.
+    * Writes a dicom ct image file as a blob from cradle rt_study data.
-  - //**parse_dicom_blobs_to_CT_iamge**//:
+  * //**write_ct_image_slices:**//
-    * 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.
+    * Writes all dicom ct image files as blobs from cradle rt_study data.
-  - //**write_ct_image**//:
+  * //**write_dose_image:**//
-    * Writes dicom ct image file as a blob from cradle structure set data.
+    * Writes 3D image data containing dose information into a binary blob dicom dose file.
-  - //**write_dose**//:
+  * //**write_patient:**//
-    * Converts a //dicom_data// object containing dose information into a binary blob dicom dose file.
-  - //**write_patient**//:
     * Returns a filesystem_item of the patient dicom files.
-  - //**write_plan**//:
+  * //**write_plan:**//
     * Writes dicom plan file as a blob from cradle plan data.
-  - //**write_structure_set**//:
+  * //**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.
@@ Line 106: / 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>