Differences

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

--- dicom:userguide:userguide [2015/07/09 12:15] – [Known Application Limitations] dpatenaude
+++ dicom:userguide:userguide [2021/07/29 18:23] (current) – external edit 127.0.0.1
@@ Line 2: / Line 2: @@
 ===== Overview =====
-FIXME
-The .decimal astroid Dosimetry App device is used to aid planning and analysis of proton radiation therapy treatments. The astroid Dosimetry App device is not an interactive end user application and is not intended to perform all the functions of a typical radiation treatment planning system. Users of the system will write scripts or use a fully interactive software program that makes calls to the functions provided by the astroid Dosimetry App. In essence, this device serves as a foundational proton dosimetry calculation library that greatly reduces the burden and time required to develop treatment planning and plan analysis software by making readily available much of the core functionality common to these types of applications. This core functionality includes various CT image processing tools, structure and contour modification operators, proton dose calculations, proton aperture and range compensator device design algorithms, and many other radiotherapy specific calculation functions. Since this application does not include a graphical user interface, much of the usability and plan approval tools are not applicable or available herein, and it is expected that derived treatment planning applications follow the guidelines set forth in IEC 62803 and IEC 62366 to make sure all such features are included in final end user applications.
-Access to the astroid Dosimetry App is provided by the thinknode™ framework using http json formatted requests. thinknode™ provides the 'backbone' used to send and receive requests, maintain users, realms and organizations, and provide data storage and management.
+The astroid Dicom App is used to provide access to functions which are used for reading a dicom file and returning more useable standard data types, such as those from the RT Types App available on the thinknode framework. The astroid Dicom App device is not an interactive end user application. Users of the system will write scripts or use a fully interactive software program that makes calls to the functions provided by the astroid Dicom App API. The core functionality includes parsing dicom RT_Plan, Structure Set, CT Image, and Dose file types. The Dicom App adheres to the Dicom PS3.3 2015c dicom specification.
-The [[http://docs.apps.dotdecimal.com/dosimetry|Dosimetry Manifest Guide]] contains a complete list of all functions and types supported by the astroid Dicom App through API calls.
+Access to the astroid Dicom App is provided by the thinknode™ framework using http json formatted requests. thinknode™ provides the backbone used to send and receive requests, maintain users, realms and organizations, and provide data storage and management.
+The [[http://docs.apps.dotdecimal.com/dicom|Dicom Manifest Guide]] contains a complete list of all functions and types supported by the astroid Dicom App through API calls.
 ===== Purpose =====
@@ Line 14: / Line 14: @@
 ===== Getting Started =====
-FIXME
-The primary purpose of the astroid Dosimetry 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 Dosimetry 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 Dosimetry 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 31: / Line 31: @@
 ==== Precautions ====
-FIXME
-It is the responsibility of those utilizing this application to ensure all that all usages of this product relating to patient treatments are performed by trained and qualified personnel only and that such personnel is aware that the quality of any generated treatment plans is highly dependent on the quality and correctness of the input data; therefore if any questions or uncertainties exist regarding the quality, units, or identification of input data arise, they must be investigated and resolved before the data are used.
+It is the responsibility of those utilizing this application to ensure all that all usages of this product relating to dicom information handling are performed by trained and qualified personnel only and that such personnel is aware that the quality of any generated output data is highly dependent on the quality and correctness of the input data; therefore if any questions or uncertainties exist regarding the quality, units, or identification of input data arise, they must be investigated and resolved before the data are used.
+<WRAP center 80% important round>===HIPAA Compliance===
+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 =====
-FIXME
-The Dosimetry App exposes three primary classes of functions through its API: dose calculation functions (DCF), design task functions (DTF), and radiotherapy support functions (RSF). Each function has its own type of input argument specifications and output results specifications. It is worthy of pointing out the interdependence of these function classes upon one another. Specifically, the DCFs rely heavy on the use of the RSFs and may take as input, the output devices produced by the DTFs. The DTF are typically higher level functions that will modify data parameters and make repeated use of the various DCFs and RSFs to accomplish some type of “optimal” device or plan design.
-    * Details of each function, argument parameters, and return values are provided at the [[http://docs.apps.dotdecimal.com/dosimetry|Dosimetry Manifest Guide]].
+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]].
-    * Notes about manifest documentation:
-      - Previous versions of the dosimetry documentation can be found at the [[dosimetry:dosimetry_versions|Dosimetry Versions]] page.
+  * //**add_dcm_file_to_study:**//
-      - If a manifest is manually pulled down from the thinknode framework, that manifest will not match the one outlined in the [[http://docs.apps.dotdecimal.com/dosimetry|Dosimetry Manifest Guide]]. Only the functions and types detailed in the dosimetry manifest guide have been tested and approved for release for customer use (use of any other functions is beyond the intend scope of this product and is done at your own risk).
+    * 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.
+See the [[dicom:userguide:userguide#Calc_Provider_Examples|Calc Provider Examples section]] for example usage of some of the dicom functions.
 ===== Data Types =====
 Details of each datatype used by the Dosimetry App can be found at the [[http://docs.apps.dotdecimal.com/dicom|Dicom Manifest Guide]].
-===== Examples =====
+===== Calc Provider Examples =====
-==== thinknode™ ====
+==== thinknode™ calculation provider ====
-Official thinknode™ user guide documentation can be found at [[https://developers.thinknode.com|https://developers.thinknode.com]]. Below are basic examples of communicating with thinknode™ calculation providers.
+Official thinknode™ user guide documentation can be found at [[https://developers.thinknode.com|https://developers.thinknode.com]]. Below are basic examples of communicating with thinknode™ calculation providers and using the Dicom App calculation functions.
   * **[[dicom:userguide:thinknode#python|Python]]:** Sample Python project (note: this example requires third party libraries) that details the following thinknode™ api functions:
-    * [[dicom:userguide:thinknode#python:_immutable_storage|Python: Post to Immutable Storage]]
+    * [[dicom:userguide:thinknode#python:_overview|Python: Overview]]
-    * [[dicom:userguide:thinknode#python:_calculation_request|Python: Post a Calculation Request]]
+    * [[dicom:userguide:thinknode#python:_decimal_libraries|Python: Decimal Libraries]]
-==== Dicom App Functions ====
-Refer to the [[dicom:userguide:userguide#functions|Functions]] section for explanation and usages for each function type.
 ===== System Usage =====
@@ Line 70: / Line 94: @@
 When using the astroid Dicom App, as with any complex program, there is the potential for misuse. The thinknode™ framework and Dicom App limit most of the potential misuse of exposed functions and data types, but there's still a potential for misinterpretation of the results provided by the app. Below are a few examples of topics that are easily confused or overlooked when performing even basic tasks.
+{{page>dosimetry:userguide:userguide#Grid_and_Image_Data_Interpretation&nofooter&noeditbutton}}
 ===== Known Application Limitations =====
@@ Line 80: / 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>