Differences

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

--- visual3d:documentation:pipeline:file_commands:export_3d_animation_to_video [2024/06/19 12:50] – sgranger
+++ visual3d:documentation:pipeline:file_commands:export_3d_animation_to_video [2025/06/03 17:32] (current) – wikisysop
@@ Line 1: / Line 1: @@
-{{exports video from visual3d's 3d viewer.
+====== Export 3D Animation To Video ======
-export3danimationvideo.png
+===== Overview =====
+The **Export_3D_Animation_To_Video** command is used to create a video file (.avi) of the 3D animation displayed in Visual3D's viewer.
+  * Unlike **Export_3D_Animation_To_Image**, which captures static snapshots, this command records a sequence of frames and compiles them into a playable animation.
+  * Useful for exporting video clips for presentations or visual analysis.
+===== Pipeline Command =====
+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_video
+Export_3D_Animation_To_Video
-! /file_name=
+! /FILE_NAME=
-! /video_file_name=
+! /VIDEO_FILE_NAME=
-! /event_sequence=
+! /EVENT_SEQUENCE=
-! /exclude_events=
+! /EXCLUDE_EVENTS=
-! /output_frame_rate_divisor=1
+! /OUTPUT_FRAME_RATE_DIVISOR=1
-! /output_width=320
+! /OUTPUT_WIDTH=320
-! /output_height=240
+! /OUTPUT_HEIGHT=240
+! /AUTO_CLOSE_OUTPUT_DIALOGS=FALSE
+</code>
+===== Command Parameters =====
+The following table shows the command parameters and descriptions:
+|**Parameter**|**Description**|
+|**! /FILE_NAME=**|Name of the motion file (e.g., 'Subject01.c3d'). Wildcards (e.g., '*.c3d*) can also be used.|
+|**! /VIDEO_FILE_NAME=**|Full path and name of the '.avi' file to be created.|
+|**! /EVENT_SEQUENCE=**|Specify an event range (e.g., LHS + LTO) to define the segment to export.|
+|**! /EXCLUDE_EVENTS=**|Events that, if present, will cause sequences to be skipped.|
+|**! /OUTPUT_FRAME_RATE_DIVISOR = 1**|A divisor applied to the original frame rate. For example, '2' means every second frame is kept.|
+|**! /OUTPUT_WIDTH=320**|Width (in pixels) of the output video. Must match a supported resolution.|
+|**! /OUTPUT_HEIGHT=240**|Height (in pixels) of the output video. Must match the supported resolution.|
+|**! /AUTO_CLOSE_OUTPUT_DIALOGS=FALSE**|If 'TRUE', suppresses file dialog popups during batch processing.|
+===== Dialog =====
+The command can be inserted manually or adjusted using the Visual3D dialog editor. The dialog box allows users to configure settings such as output file, resolution, and playback frame rate.
+{{:visual3d:documentation:pipeline:file_commands:animation_to_video_dlgbox.png?400|}}
+  * **Motion File**: Path to the input motion file used for generating the video.
+  * **Exported Video File**: Destination file path and name for the '.avi' video file.
+  * **Frame Rate Divisor**: Adjusts playback speed. A value of '2' halves the frame rate.
+  * **Output Size**: Choose video resolution (e.g., '320x240). Must match a standard aspect ratio.
+  * **Defined Events/Event Sequence**: Restrict the export to a defined event range (e.g., 'LHS' to 'LTO'.)
+  * **Exclude Sequences Containing These Events**: Optionally remove sequences containing listed events from the output.
+===== Examples =====
+The following example will go through the use of the Export_3D_Animation_To_Video Command in the Visual3D application.
+==== Example 1: Simple Use Case ====
+This example exports a video between 'LHS' and 'LTO' using the default resolution and no frame rate change. This is useful for exporting one complete stance phase of the left leg.
+<code>
+Export_3D_Animation_To_Video
+/FILE_NAME=Subject01_Trial1.c3d
+/VIDEO_FILE_NAME=Z:\Videos\LHS_to_LTO.avi
+/EVENT_SEQUENCE=LHS+LTO
+/EXCLUDE_EVENTS=
+/OUTPUT_FRAME_RATE_DIVISOR=1
+/OUTPUT_WIDTH=640
+/OUTPUT_HEIGHT=480
+/AUTO_CLOSE_OUTPUT_DIALOGS=TRUE
 ;
 </code>
-\\
+Frame rate divisor of 1 means the video plays in real-time speed. 'AUTO+CLOSE_OUTPUT_DIALOGS=TRUE' ensures this can run as part of a batch pipeline.
-[[visual3d:documentation:pipeline:general_information:pipeline_commands_reference|back to pipeline commands reference]]
+==== Example 2: Complex Use Case ====
+This example exports reduced-speed videos for all trials in the workspace matching '*.c3d'. It halves the frame rate for slow-motion playback, increases the resolution, and excludes sequences that contain the 'LOFF' events.
+<code>
+Export_3D_Animation_To_Video
+/FILE_NAME=*.c3d
+/VIDEO_FILE_NAME=Z:\ExportedAnimations\SlowMo_
+/EVENT_SEQUENCE=RHS+RTO
+/EXCLUDE_EVENTS=LOFF
+/OUTPUT_FRAME_RATE_DIVISOR=2
+/OUTPUT_WIDTH=800
+/OUTPUT_HEIGHT=600
+/AUTO_CLOSE_OUTPUT_DIALOGS=TRUE
+;
+</code>
+This approach allows comparison of propulsion phases from multiple participants with visual consistency. Output videos are smoother but play at half speed for better observation.
+----
+[[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]]
-}}