Differences

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

--- planning:userguide:results_api_functions [2018/01/11 14:09] – [Results API Types] dpatenaude
+++ planning:userguide:results_api_functions [2021/07/29 18:24] (current) – external edit 127.0.0.1
@@ Line 318: / Line 318: @@
 <code c++>
+// Generate the request for the site_info used for constructing the treatment plan.
+api(fun)
+calculation_request
+generate_site_info_request(treatment_plan const& plan);
+// Generate the request for the dicom rt_ion_plan for a treatment_plan
+api(fun)
+calculation_request
+generate_rt_ion_plan_request(
+    treatment_plan const& plan,
+    rt_approval const& approval,
+    rt_tolerance_table const& tol_table,
+    rt_patient_setup const& patient_setup,
+    std::vector<rt_dose_reference> const& prescription_data,
+    unsigned fraction_cycle_length,
+    unsigned fractions_per_day,
+    string const& fraction_pattern);
 // Generate the request for the summary info for a plan.
@@ Line 332: / Line 350: @@
 // Generate the request for the RSP image used for constructing a plan.
 // The spatial coordinate system is that of the CT image.
+// TODO: This currently returns the merged EPF image because we don't actually
+// construct the sliced one as an intermediate step, which is also incorrect.
+// Once that's fixed, this should return the sliced EPF.
 api(fun)
 calculation_request
@@ Line 434: / Line 455: @@
 //
 // If the specified beam has no aperture, this is an error.
-//
 api(fun)
 calculation_request
@@ Line 451: / Line 471: @@
 //
 // If the specified beam has no aperture, this is an error.
-//
 api(fun)
 calculation_request
@@ Line 478: / Line 497: @@
 // space with its downstream edge at the isocentric plane.
 //
+/// TODO: Again, I'm not sure that this should really be a separate request.
+///
 api(fun)
 calculation_request
@@ Line 504: / Line 525: @@
     size_t fraction_group_index,
     size_t beam_index);
 </code>