View source for Tutorial:Add an Image to a Report Simple Pipeline

{{Languages}}

{| align="right"
| __TOC__
|}
<br>
<b>
The following pipeline is a simple pipeline script, which can be used to automate the process of adding an image to a report.<br>
<br>
This pipeline automates the process shown in the [[Tutorial:Add_an_Image_to_a_Report | Add Image to Report Tutorial]].
<br>
More advanced pipelines can be made to add an image to a report, an example is shown [[Tutorial:Add_an_Image_to_a_Report_Advanced_Pipeline | Add Image to Report Advanced Pipeline Tutorial]].<br> </b>
<br>
Sample files may be downloaded [http://www.c-motion.com/download/Tutorial_Report_AddImage_SimplePipeline.zip here].<br>
:CreatingReport_Tutorial_Image_blank.cmo will be used in this tutorial<br>
:CreatingReport_Tutorial_Image.cmo contains the completed cmo file <br>
:AddImage.v3s is the pipeline script shown below <br>
<br>

<br>
=Add Image to Report - Simple Pipeline=

<b>The following script will add the two images of the skeleton to page 3 of the report (seen below) by:</b><br>
1) Prompt the user for the desired file to export from a list of files in the workspace (default for this example is NWalk0001.c3d)<br>
2) Prompt the user for the desired frame to export (default for this example is Frame 239)<br>
3) Set the view options:<br>
:a. Turn off lab axes, targets, landmarks, & segment coordinate system axes
:b. Set 3D viewer background to white<br>
4) Get the trial (without .c3d extension) so the exported filename will contain the trial name<br>
5) Set the camera perspective to the sagittal view and export image<br>
6) Set the camera perspective to the A/P view and export image<br>
7) Switch to report mode & plot the images<br>
8) Set the view options back to default values:<br>
:a. Turn on lab axes, targets, landmarks, & segment coordinate system axes<br>
:b. Set 3D viewer background to black<br>
:<b>NOTE:</b> These are not the "default" V3D values, these is my personal preference of what to see in the 3D viewer<br>

{| style= width="80%"
| style="width: 100%" align="center" style="vertical-align:top"| 
[[File:ReportAddImage_FinalReport.jpg|700px|caption]]
|}

<br>
<br>
==Sample Script==
 <b>
 ! ================================================
 !  Export and add two images to the Report
 ! ================================================
 
 ! ------------------------------------------------
 !  Prompt the user for the desired image from a 
 !	list of files in the workspace
 ! ------------------------------------------------
 </b>
 <b>Set_Pipeline_Parameter_To_List_Of_Tagged_Files</b>
 <b>/PARAMETER_NAME=</b>FILES
 <b>/TAG_NAME=</b>ALL_FILES
 <b>/GET_CURRENT_SELECTED_FILES=</b>false
 <b>/USE_SHORT_FILENAMES=</b>TRUE
 <b>;</b>
 
 <b>Prompt_For_Pipeline_Parameter_Value</b>
 <b>/PIPELINE_PARAMETER_NAME=S</b>ELECTED_FILE
 <b>/PROMPT=</b>Select image file
 <b>! /DATA_TYPE=</b>
 <b>/DEFAULT_VALUE=</b>::FILES
 <b>;</b>
 
 <b>Select_Active_File</b>
 <b>/FILE_NAME=</b>*&::SELECTED_FILE
 <b>! /QUERY=</b>
 <b>;</b>
 <b>
 ! ------------------------------------------------
 !  Prompt the user for the desired frame
 ! ------------------------------------------------
 </b>
 <b>Prompt_For_Pipeline_Parameter_Value</b>
 <b>/PIPELINE_PARAMETER_NAME=</b>EXPORT_FRAME
 <b>/PROMPT=</b>Export Frame:
 <b>! /DATA_TYPE=</b>
 <b>/DEFAULT_VALUE=</b>239
 <b>;</b>
 <b>
 ! ------------------------------------------------
 !  Set the view options:
 ! Turn off lab axes, targets, landmarks, 
 !	segment coordinate system axes (SCS) &
 ! Set 3D viewer background to white
 ! ------------------------------------------------
 </b>
 <b>Set_View_Options</b>
 <b>! /VIEW_GRAPH_ANIMATION_FRAME_LINE=</b>
 <b>! /VIEW_FORCE_PLATFORMS=</b>
 <b>! /VIEW_GRF_BUTTERFLY=</b>
 <b>! /VIEW_GRF=</b>
 <b>! /VIEW_GRF_COFP=</b>
 <b>! /VIEW_FREEMOMENT_AT_COP=</b>
 <b>! /VIEW_FORCE_STRUCTURE_VECTOR=</b>
 <b>! /VIEW_CUSTOM_FORCES=</b>
 <b>! /VIEW_JOINTS=</b>
 <b>/VIEW_LAB=F</b>ALSE
 <b>/VIEW_LAB_AXES=F</b>ALSE
 <b>/VIEW_LANDMARKS=F</b>ALSE
 <b>! /VIEW_MODEL_COM=</b>
 <b>! /VIEW_MUSCLES=</b>
 <b>! /VIEW_MUSCLES_AS_LINES=</b>
 <b>! /VIEW_MUSCLES_AS_CYLINDERS=</b>
 <b>/VIEW_SCS_AXES=</b>FALSE
 <b>! /VIEW_SCS_AXES_COM=</b>
 <b>! /VIEW_SEGMENTS=</b>
 <b>! /VIEW_KINEMATIC_ONLY_SEGMENTS=</b>
 <b>! /VIEW_SEGMENT_COLORIZATION=</b>
 <b>! /VIEW_SEGMENT_GEOMETRY=</b>
 <b>! /VIEW_SEGMENT_LINES=</b>
 <b>/VIEW_TARGETS=</b>FALSE
 <b>! /VIEW_TARGETS_WITH_RESIDUAL_COLORMAP=</b>
 <b>! /VIEW_COM_TRAIL=</b>
 <b>! /VIEW_LANDMARK_TRAIL=</b>
 <b>! /VIEW_SEGMENT_TRAIL=</b>
 <b>! /VIEW_TARGET_TRAIL=</b>
 <b>! /VIEW_WHITE_BACKGROUND=</b>FALSE
 <b>/SET_BACKGROUND_COLOR=</b>1+1+1
 <b>;</b>
 <b>
 ! ------------------------------------------------
 !  Remove ".c3d" from the filename so the 
 !	filename may be used in the export
 ! ------------------------------------------------
 </b>
 <b>Set_Pipeline_Parameter</b>
 <b>/PARAMETER_NAME=</b>SELECTED_FILE_NUMBER
 <b>/PARAMETER_VALUE=</b>::SELECTED_FILE
 <b>/PARAMETER_VALUE_SEARCH_FOR=</b>.c3d
 <b>/PARAMETER_VALUE_REPLACE_WITH=</b>
 <b>! /PARAMETER_VALUE_PREFIX=</b>
 <b>! /PARAMETER_VALUE_APPEND=</b>
 <b>;</b>
 <b>
 ! ------------------------------------------------
 !  Set the camera perspective to the sagittal 
 !	view and export image
 ! ------------------------------------------------
 </b>
 <b>Set_Camera_Perspective</b>
 <b>! /USE_STATIONARY_CAMERA=</b>TRUE
 <b>! /SEGMENT=</b>
 <b>/CAMERA_X_CENTER=</b>0.379
 <b>/CAMERA_Y_CENTER=</b>-1.228
 <b>/CAMERA_Z_CENTER=</b>-0.873
 <b>/CAMERA_ZOOM=</b>2.472
 <b>/CAMERA_PAN=</b>0.825
 <b>/CAMERA_TILT=</b>-0.9
 <b>;</b>
 
 <b>Export_3D_Animation_To_Image</b>
 <b>/FILE_NAME=</b>*&::SELECTED_FILE
 <b>/IMAGE_FILE_NAME=</b>\\psf\Home\Desktop\WikiTutorials\ReportTutorial\AddImage_Pipeline\&::SELECTED_FILE_NUMBER&_Sag.png
 <b>! /APPEND_FRAME_TO_FILENAME=</b>FALSE
 <b>! /APPEND_C3DNAME_TO_FILENAME=</b>FALSE
 <b>! /IMAGE_FORMAT=</b>png
 <b>/START_FRAME=</b>::EXPORT_FRAME
 <b>! /END_FRAME=</b>
 <b>! /EVENT_SEQUENCE=</b>
 <b>! /EXCLUDE_EVENTS=</b>
 <b>! /OUTPUT_WIDTH=</b>640
 <b>! /OUTPUT_HEIGHT=</b>480
 <b>;</b>
 <b>
 ! ------------------------------------------------
 !  Set the camera perspective to the A/P 
 !	view and export image
 ! ------------------------------------------------
 </b>
 <b>Set_Camera_Perspective</b>
 <b>! /USE_STATIONARY_CAMERA=</b>TRUE
 <b>! /SEGMENT=</b>
 <b>/CAMERA_X_CENTER=</b>0.379
 <b>/CAMERA_Y_CENTER=</b>-1.228
 <b>/CAMERA_Z_CENTER=</b>-0.873
 <b>/CAMERA_ZOOM=</b>2.493
 <b>/CAMERA_PAN=</b>-89.175
 <b>/CAMERA_TILT=</b>-1.05
 <b>;</b>
 
 <b>Export_3D_Animation_To_Image</b>
 <b>/FILE_NAME=</b>*&::SELECTED_FILE
 <b>/IMAGE_FILE_NAME=</b>\\psf\Home\Desktop\WikiTutorials\ReportTutorial\AddImage_Pipeline\&::SELECTED_FILE_NUMBER&_AP.png
 <b>! /APPEND_FRAME_TO_FILENAME=</b>FALSE
 <b>! /APPEND_C3DNAME_TO_FILENAME=</b>FALSE
 <b>! /IMAGE_FORMAT=</b>png
 <b>/START_FRAME=</b>::EXPORT_FRAME
 <b>! /END_FRAME=</b>
 <b>! /EVENT_SEQUENCE=</b>
 <b>! /EXCLUDE_EVENTS=</b>
 <b>! /OUTPUT_WIDTH=</b>640
 <b>! /OUTPUT_HEIGHT=</b>480
 <b>;</b>
 <b>
 ! ------------------------------------------------
 !  Switch to report mode & plot the images
 ! ------------------------------------------------
 </b>
 <b>Switch_to_Report_Mode</b>
 <b>! /SHOW_ANIMATION=</b>FALSE
 <b>/PAGE_NUMBER=</b>3
 <b>;</b>
 
 <b>Make_Image_Item</b>
 <b>/IMAGE_FILE=</b>\\psf\Home\Desktop\WikiTutorials\ReportTutorial\AddImage_Pipeline\&::SELECTED_FILE_NUMBER&_Sag.png
 <b>/PAGE_NUMBER=</b>3
 <b>/COLUMN_NUMBER=</b>1
 <b>/ROW_NUMBER=</b>1
 <b>! /COLUMN_SPAN=</b>1
 <b>! /ROW_SPAN=</b>1
 <b>;</b>
 
 <b>Make_Image_Item</b>
 <b>/IMAGE_FILE=</b>\\psf\Home\Desktop\WikiTutorials\ReportTutorial\AddImage_Pipeline\&::SELECTED_FILE_NUMBER&_AP.png
 <b>/PAGE_NUMBER=</b>3
 <b>/COLUMN_NUMBER=</b>1
 <b>/ROW_NUMBER=</b>2
 <b>! /COLUMN_SPAN=</b>1
 <b>! /ROW_SPAN=</b>1
 <b>;</b>
 <b>
 ! ------------------------------------------------
 !  Set the view options back to default values: 
 !	(default values are lab dependent)
 ! Turn on lab axes, targets, landmarks, 
 !	segment coordinate system axes (SCS) &
 ! Set 3D viewer background to black
 ! ------------------------------------------------
 </b>
 <b>Set_View_Options</b>
 <b>! /VIEW_GRAPH_ANIMATION_FRAME_LINE=</b>
 <b>! /VIEW_FORCE_PLATFORMS=</b>
 <b>! /VIEW_GRF_BUTTERFLY=</b>
 <b>! /VIEW_GRF=</b>
 <b>! /VIEW_GRF_COFP=</b>
 <b>! /VIEW_FREEMOMENT_AT_COP=</b>
 <b>! /VIEW_FORCE_STRUCTURE_VECTOR=</b>
 <b>! /VIEW_CUSTOM_FORCES=</b>
 <b>! /VIEW_JOINTS=</b>
 <b>! /VIEW_LAB=</b>
 <b>/VIEW_LAB_AXES=</b>TRUE
 <b>/VIEW_LANDMARKS=</b>TRUE
 <b>! /VIEW_MODEL_COM=</b>
 <b>! /VIEW_MUSCLES=</b>
 <b>! /VIEW_MUSCLES_AS_LINES=</b>
 <b>! /VIEW_MUSCLES_AS_CYLINDERS=</b>
 <b>/VIEW_SCS_AXES=</b>TRUE
 <b>! /VIEW_SCS_AXES_COM=</b>
 <b>! /VIEW_SEGMENTS=</b>
 <b>! /VIEW_KINEMATIC_ONLY_SEGMENTS=</b>
 <b>! /VIEW_SEGMENT_COLORIZATION=</b>
 <b>! /VIEW_SEGMENT_GEOMETRY=</b>
 <b>! /VIEW_SEGMENT_LINES=</b>
 <b>/VIEW_TARGETS=</b>TRUE
 <b>! /VIEW_TARGETS_WITH_RESIDUAL_COLORMAP=</b>
 <b>! /VIEW_COM_TRAIL=</b>
 <b>! /VIEW_LANDMARK_TRAIL=</b>
 <b>! /VIEW_SEGMENT_TRAIL=</b>
 <b>! /VIEW_TARGET_TRAIL=</b>
 <b>! /VIEW_WHITE_BACKGROUND=</b>
 <b>! /SET_BACKGROUND_COLOR=</b>0+0+0
 <b>;</b>


[[Category:Tutorial]]
[[Category:Visual3D_Reports]]