Differences

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

--- visual3d:documentation:pipeline:report_commands:add_an_image_to_a_report [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:report_commands:add_an_image_to_a_report [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{{{{{{{{{{{{{{{{{\\
+====== Add an Image to a Report ======
-**to complete this tutorial, please download the sample files [[https://www.has-motion.com/download/tutorial_report_addimage.zip|here]].**
-creatingreport_tutorial_image_blank.cmo will be used in this tutorial
-creatingreport_tutorial_image.cmo contains the completed cmo file
 \\
-**all the steps in this tutorial may also be scripted in a pipeline. to see an example please view the [[visual3d:documentation:pipeline:report_commands:add_an_image_to_a_report_simple_pipeline|simple pipeline]] tutorial.\\
+**To complete this tutorial, please download the sample files [[https://www.has-motion.com/download/Tutorial_Report_AddImage.zip|here]].**
+CreatingReport_Tutorial_Image_blank.cmo will be used in this tutorial
+CreatingReport_Tutorial_Image.cmo contains the completed cmo file
+\\
+**All the steps in this tutorial may also be scripted in a pipeline. To see an example please view the [[Visual3D:Documentation:Pipeline:Report_Commands:Add_an_Image_to_a_Report_Simple_Pipeline|Simple Pipeline]] tutorial.\\
 \\
-more advanced pipelines can be made to add an image to a report, an example is shown [[visual3d:documentation:pipeline:report_commands:add_an_image_to_a_report_advanced_pipeline|here]].\\
+More advanced pipelines can be made to add an image to a report, an example is shown [[Visual3D:Documentation:Pipeline:Report_Commands:Add_an_Image_to_a_Report_Advanced_Pipeline|here]].\\
 **\\
-====== outline ======
+===== Outline =====
-adding an image to a report can be completely automated using a pipeline script, or images can be manually created.\\
+Adding an image to a report can be completely automated using a pipeline script, or images can be manually created.\\
 \\
-**to add an image to a report:**\\
+**To add an image to a report:**\\
-) the image must be exported from the **signals and events tab** by:\\
+) The image must be exported from the **Signals and Events tab** by:\\
-a. setting the 3d view options\\
+a. Setting the 3D View Options\\
-b. setting the camera perspective\\
+b. Setting the camera perspective\\
-c. exporting the image by going to file -> export animation frame to image\\
+c. Exporting the image by going to File -> Export Animation Frame to Image\\
-) the image can then be added to the report by selecting **"image"** as the item to add from the **report tab**\\
+) The image can then be added to the report by selecting **"Image"** as the item to add from the **Report tab**\\
 \\
 \\
-**note:** images are specific to the subject and are saved within the cmo file, not the report template.\\
+**NOTE:** Images are specific to the subject and are saved within the cmo file, not the report template.\\
 \\
-====== export animation frame to image ======
+===== Export Animation Frame to Image =====
 \\
-===== prepare the image for export =====
+==== Prepare the image for export ====
 \\
-export the first image of the sagittal view of the subject.\\
+Export the first image of the sagittal view of the subject.\\
-|1. **set the current frame** to 239\\   |  reportaddimage_currentframe.jpg|
+|1. **Set the current frame** to 239\\   |  {{:ReportAddImage_CurrentFrame.jpg}}|
-|2. modify **3d animation view options**\\ \\ \\ a. set the **background** to white\\ \\ b. **turn off:**\\ \\ lab/floor\\ \\ lab axes\\ \\ landmarks\\ \\ targets\\ \\ segment coordinate system axes\\ \\ c. close the 3d animation view options dialog box  |  reportaddimage_3dviewoptions.jpg|
+|2. Modify **3D Animation View Options**\\ \\ \\ a. Set the **Background** to White\\ \\ b. **Turn off:**\\ \\ Lab/Floor\\ \\ Lab Axes\\ \\ Landmarks\\ \\ Targets\\ \\ Segment Coordinate System Axes\\ \\ c. Close the 3D Animation View Options dialog box  |  {{:ReportAddImage_3DViewOptions.jpg}}|
-|3. set the **camera perspective** to the sagittal view of the subject\\ \\ \\ **note:** the perspective seen in the 3d viewer will the exported perspective.  |  reportaddimage_skeletonsagittal.jpg  |
+|3. Set the **camera perspective** to the sagittal view of the subject\\ \\ \\ **NOTE:** The perspective seen in the 3D viewer will the exported perspective.  |  {{:ReportAddImage_SkeletonSagittal.jpg}}  |
-===== export the image =====
+==== Export the image ====
 \\
-|after setting the 3d viewer options, export the image by going to:\\ 1. the **file** drop down menu\\ 2. selecting **export animation frame to image**\\ \\ \\ a.**browse** to the location to export the image  |  reportaddimage_fileexportimage.jpg|
+|After setting the 3D viewer options, export the image by going to:\\ 1. The **File** drop down menu\\ 2. Selecting **Export Animation Frame to Image**\\ \\ \\ a.**Browse** to the location to export the image  |  {{:ReportAddImage_FileExportImage.jpg}}|
 \\
-===== export image 2 - a/p view =====
+==== Export Image 2 - A/P View ====
-follow the same instructions as for the first image, but change the camera export perspective to the a/p view of the subject and export the image using a different name.
+Follow the same instructions as for the first image, but change the camera export perspective to the A/P view of the subject and export the image using a different name.
-====== add the image to the report ======
+===== Add the image to the report =====
-|1. go to the **reports** tab\\   |  reportaddimage_reporttab.jpg|
+|1. Go to the **Reports** Tab\\   |  {{:ReportAddImage_ReportTab.jpg}}|
-|2. add the **sagittal view** image by setting **image** as the "item to add" and clicking **add**.  |  reportaddimage_itemimage.jpg|
+|2. Add the **Sagittal view** image by setting **Image** as the "Item to add" and clicking **Add**.  |  {{:ReportAddImage_ItemImage.jpg}}|
-|set the parameters to the following:\\ \\ \\ a. **column:** 1\\ \\ b. **row:** 1\\ \\ c. **page:** 3\\ \\ c. **image file name:** browse to the sagittal view exported image\\ \\ d. select **ok**  |  reportaddimage_imagesagittal.jpg|
+|Set the parameters to the following:\\ \\ \\ a. **Column:** 1\\ \\ b. **Row:** 1\\ \\ c. **Page:** 3\\ \\ c. **Image File Name:** Browse to the sagittal view exported image\\ \\ d. Select **OK**  |  {{:ReportAddImage_ImageSagittal.jpg}}|
 \\
-|3. add the **a/p view** image by setting **image** as the "item to add" and clicking **add**. set the parameters to the following:\\ \\ \\ a. **column:** 1\\ \\ b. **row:** 2\\ \\ c. **page:** 3\\ \\ c. **image file name:** browse to the a/p view exported image\\ \\ d. select **ok**  |  reportaddimage_imageap.jpg|
+|3. Add the **A/P view** image by setting **Image** as the "Item to add" and clicking **Add**. Set the parameters to the following:\\ \\ \\ a. **Column:** 1\\ \\ b. **Row:** 2\\ \\ c. **Page:** 3\\ \\ c. **Image File Name:** Browse to the A/P view exported image\\ \\ d. Select **OK**  |  {{:ReportAddImage_ImageAP.jpg}}|
 \\
-|4. the images will be loaded into the report.  |  reportaddimage_finalreport.jpg|
+|4. The images will be loaded into the report.  |  {{:ReportAddImage_FinalReport.jpg}}|
-}}}}}}}}}}}}}}}}}}