Differences

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

--- visual3d:documentation:pipeline:file_commands:export_3d_animation_to_image [2024/06/19 12:50] – sgranger
+++ visual3d:documentation:pipeline:file_commands:export_3d_animation_to_image [2025/06/09 21:11] (current) – wikisysop
@@ Line 1: / Line 1: @@
-{{{{{{export a snapshot of the 3d viewer and save the file to disk.
+====== Export 3D Animation To Image ======
-  * multiple files in the workspace can be selected
+===== Overview =====
-  * multiple frames of data can be exported to individual files
+The **Export_3D_Animation_To_Image** command is used to capture and export static images from the 3D viewer in Visual3D.
+  * Command supports exporting one or more frames to multiple image formats for documentation and presentation.
+  * Multiple files in the workspace can be selected, and images can be exported for single or multiple frames within specific event sequences.
-**note: if there are multiple output files (either because of multiple files or multiple frames), the name of the file is used as a prefix on the output file and the frame number is appended.**
+===== Pipeline Command =====
-===== contents =====
+The command below is as seen on the Visual3D application, it has many parameters as there are many options to manipulate this command.
+<code>
+Export_3D_Animation_To_Image
+! /FILE_NAME=
+! /IMAGE_FILE_NAME=
+! /APPEND_FRAME_TO_FILENAME=FALSE
+! /APPEND_C3DNAME_TO_FILENAME=FALSE
+! /IMAGE_FORMAT=png
+! /START_FRAME=1
+! /END_FRAME=
+! /EVENT_SEQUENCE=
+! /EXCLUDE_EVENTS=
+! /OUTPUT_WIDTH=640
+! /OUTPUT_HEIGHT=480
+;
+</code>
-  * [[#pipeline_command|1 pipeline command]]
+===== Command Parameters =====
-    * [[#exporting_one_image|1.1 exporting one image]]
-    * [[#exporting_multiple_images|1.2 exporting multiple images]]
-  * [[#version_4_implementation|2 version 4 implementation]]
+The following table shows the command parameters and descriptions:
-===== pipeline command =====
+|**Parameter**|**Description**|
+|**! /FILE_NAME=**|Motion file(s) to export frames from. Can use wildcards (e.g., '*.c3d) or specify a specific file.|
+|**! /IMAGE_FILE_NAME=**|Path and name (or folder) where image will be saved.|
+|**! /APPEND_FRAME_TO_FILENAME=**|If 'TRUE', appends source file name (C3D) to the image file name when batch exporting.|
+|**! /APPEND_C3DNAME_TO_FILENAME=**|If 'TRUE', appends source file name (C3D) to the image file name when batch exporting.|
+|**! /IMAGE_FORMAT=**|Output format (e.g., .png, .bmp, .jpg). Defaults to .png.|
+|**! /START_FRAME=**|First frame to export. Use a specific number (e.g.m 10) or combine with event sequences.|
+|**! /END_FRAME=**|Final frame to export. Leave blank to export only the start frame.|
+|**! /EVENT_SEQUENCE=**|Optional event sequence (e.g., 'LHS+LTO') to restrict frame export to specific gait phases.|
+|**! /EXCLUDE_EVENTS=**|Events that, if present, will exclude the sequence from being exported.|
+|**! /OUTPUT_WIDTH=**|Width of the output image in pixels. Default is '640'.|
+|**! /OUTPUT_HEIGHT=**|Height of the output image in pixels. Default is '480'.|
-**export_3d_animation_to_image**
-/file_name=
-/image_file_name=
-/append_frame_to_filename=
-/start_frame=1
-/end_frame=
-/event_sequence=
-/exclude_events=
-/output_width=640
-/output_height=480
-**;**
-==== exporting one image ====
-in the following example:
+===== Dialog =====
-  * one image is exported from the first file that matches the wildcard specificat
+The command can be edited in a text editor or opened as a dialog. The dialog allows user to select export parameters using visual options.
-  * frame 10 is exported
-  * the output file is specified using the image_file_name parameter
-\\
+{{:visual3d:documentation:pipeline:file_commands:exportc3danim_image_dlog.png?400|}}
+  * **Motion File**: Drop-down to select the motion file currently loaded in the workspace.
+  * **Export File as Filename plus Frame Number**: Appends frame number to image name (e.g., 'Frame_001.png')
+  * **Exported Image File**: Specify the base name or folder where the image(s) will be saved.
+  * **Output Width/Height**: Dimensions of the exported image in pixels.
+  * **Start Frame/End Frame**: Set the frame range to export. Leave 'End Frame' blank to export just one.
+  * **Event Sequence & Exclusion**: Limit frame export to within specified gait phases and exclude sequences with specific events.
-**export_3d_animation_to_image**
+===== Examples =====
-/file_name=*2.c3d
-/image_file_name=z:\temp\outimage.png
-/append_frame_to_filename=false
-! /image_format=png
-/start_frame=10
-/end_frame=
-/event_sequence=
-/exclude_events=
-! /output_width=640
-! /output_height=480
-**;**
-exportimagedlg2.jpg
-mvc002_61.png
-==== exporting multiple images ====
-in the following example:
+The following examples will go through the use of the Export_3D_Animation_To_Image command in the Visual3D.
-  * images are exported from all files in the workspace.
+==== Example 1: Exporting a single image ====
-  * frames 1 and 2 are exported
-  * all frames within the event_sequence (lhs-lto) are exported
-  * the target folder for the files is specified using the image_file_name parameter
-  * the exported file contains the name of the original file appended with the frame number
-\\
+This example exports one snapshot from a trial matching '*2.c3d', at frame 10. The file is saved for a specific location using a fixed filename.
+<code>
+Export_3D_Animation_To_Image
+/FILE_NAME=*2.c3d
+/IMAGE_FILE_NAME=Z:\temp\outImage.png
+/APPEND_FRAME_TO_FILENAME=FALSE
+/APPEND_C3DNAME_TO_FILENAME=FALSE
+/IMAGE_FORMAT=.png
+/START_FRAME=10
+/END_FRAME=
+! /EVENT_SEQUENCE=
+! /EVENT_EVENTS=
+/OUTPUT_WIDTH=640
+/OUTPUT_HEIGHT=480
+;
+</code>
-**export_3d_animation_to_image**
+==== Example 2: Exporting multiple images from gait phase ====
-/file_name=*.c3d
-/image_file_name=z:\temp\
-/append_frame_to_filename=true
-/start_frame=1
-/end_frame=2
-/event_sequence=lhs+lto
-/exclude_events=
-/output_width=640
-/output_height=480
-**;**
-exportimagedlg.jpg
-===== version 4 implementation =====
-export a snapshot of the 3d viewer and save the file to disk.
+This example exports frame 1 and 2 from all trials (*.c3d) in the workspace. The frame range is restricted to 'LHS' and 'LTO' sequences.
-in version 4:
+Each output file will include both the C3D name and the frame number.
+<code>
+Export_3D_Animation_To_Image
+/FILE_NAME=*.c3d
+/IMAGE_FILE_NAME=Z:\temp\
+/APPEND_FRAME_TO_FILENAME=TRUE
+/APPEND_C3DNAME_TO_FILENAME=TRUE
+/IMAGE_FORMAT=.png
+/START_FRAME=1
+/END_FRAME=2
+/EVENT_SEQUENCE=LHS+LTO
+! /EXCLUDE_EVENTS=
+/OUTPUT_WIDTH=640
+/OUTPUT_HEIGHT=480
+;
+</code>
+This example helps automate capturing consistent gait-phase images across multiple subjects.
+----
+===== Notes =====
+==== Version 4 Implementation ====
+Export a snapshot of the 3D viewer and save the file to disk.
+In Version 4:
   * only one file in the workspace can be selected
   * only one frame of data can be exported
   * only one exported filename can be specified.
-**export_3d_animation_to_image**
+<code>
-! /file_name=
+Export_3D_Animation_To_Image
-! /image_file_name=
+! /FILE_NAME=
-! /frame=1
+! /IMAGE_FILE_NAME=
-! /output_width=640
+! /FRAME=1
-! /output_height=480
+! /OUTPUT_WIDTH=640
-**;**
+! /OUTPUT_HEIGHT=480
-this is consistent with the export option under the [[[https://www.c-motion.com/v3dwiki/index.php?title=menus#file_menu|file menu item]]]
+;
+</code>
+This is consistent with the export option under the [[https://www.c-motion.com/v3dwiki/index.php?title=Menus#File_Menu|File Menu Item]]
+----
+[[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]]
-\\
-[[visual3d:documentation:pipeline:general_information:pipeline_commands_reference|back to pipeline commands reference]]
-}}}}}}