Differences

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

--- visual3d:documentation:pipeline:file_commands:export_c3dfile [2024/07/17 15:10] – sgranger
+++ visual3d:documentation:pipeline:file_commands:export_c3dfile [2025/06/09 21:23] (current) – wikisysop
@@ Line 1: / Line 1: @@
-====== Export_C3DFile ======
+====== Export C3DFile ======
-{{:ExportC3DPipeline.png}}
+===== Overview =====
-There are two ways to export to a C3D File. One is through the Export Menu commands that can be found in the File Menu. A dialog will open and allow you to make selections for how you wish to have the data exported.
+The **Export_C3DFile** command is available in the Visual3D as a way to export a C3D file.
+  * The manual option is through the Export Menu commands that can be found in the File Menu. A dialog will open and allow you to make selections for how you wish to have the data exported.
-The other way is to use the **Export_C3DFile** command. The additional feature of the pipeline command that is not available in the menu command is the ability to use wildcards to export multiple C3D files. This page discusses the command **Export_C3DFile**
+  * The additional feature of the pipeline command that is not available in the menu command is the ability to use wildcards to export multiple C3D files.
 ===== 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_C3DFile
+! /OLD_FILE_NAME=
+! /NEW_FILE_NAME=
+! /DESTINATION_FOLDER=
+! /SUFFIX=_
+! /CREATE_FOLDER_PATH=FALSE
+! /PROMPT_FOR_NEW_FILE=TRUE
+! /IF_NEWFILE_EXISTS_REPLACE=FALSE
+! /EXPORT_ENDIAN=
+! /TRUNCATE_POINT_LABELS=FALSE
+! /USE_ORIGINAL_START_FRAME=FALSE
+! /EXPORT_START_FRAME=1
+! /EXPORT_END_FRAME=EOF
+! /EXPORT_PROCESSED_TARGET_DATA=FALSE
+! /EXPORT_PROCESSED_ANALOG_DATA=FALSE
+! /TRUNCATE_PARAMETER_SECTION=FALSE
+/EXPORT_ALL_LANDMARKS=FALSE
+! /EXPORT_DIGITIZING_LANDMARKS=FALSE
+! /EXPORT_FUNCTIONAL_LANDMARKS=FALSE
+! /EXPORT_EMPTY_TARGETS=FALSE
+! /EVENT_LABELS=
+! /EXPORT_OLD_EVENT_LABELS=FALSE
+;
+</code>
+===== Command Parameters =====
 The **Export_C3DFile** command parameter definitions are found below:
-|**Export_C3DFile**               |                                                                                                                                                     ||
+|**Parameter**|**Description**|
-|**/Old_File_Name=**              |The name of a c3d file in the workspace. Wildcards (*) are acceptable                                                                                ||
+|**/OLD_FILE_NAME=**|The name of a c3d file in the workspace. Wildcards (*) are acceptable.|
-|**/New_File_Name=**              |The names of the files to be exported                                                                                                                ||
+|**/NEW_FILE_NAME=**|The names of the files to be exported.|
-|**/Destination_Folder=**         |The name of the folder to save the files. If no folder is specified, the user is prompted for the folder.                                            ||
+|**/DESTINATION_FOLDER=**|The name of the folder to save the files. If no folder is specified, the user is prompted for the folder.|
-|**/Suffix=**                     |The suffix will be added to the new file name.                                                                                                       ||
+|**/SUFFIX=**|The suffix is added to the new filename.|
-|**/Export_Endian=**              |The endian for the exported file.                                                                                                                    ||
+|**/CREATE_FOLDER_PATH=FALSE**|If 'TRUE', creates the destination folder if it doesn't exist.|
-|**/Truncate_Point_Labels=**      |(true or false) exports all point labels with 4 characters.                                                                                          ||
+|**/PROMPT_FOR_NEW_FILE=TRUE**|If 'TRUE', opens a dialog to allow the user to choose the destination C3D name.|
-|**/Export_Processed_Data=**      |(true or false) exports data from the PROCESSED folder instead of the ORIGINAL folder.                                                               ||
+|**/EXPORT_ENDIAN=**|The endian for the exported file.|
-|**/Truncate_Parameter_Section=** |(true or false) truncates the parameter section.                                                                                                     ||
+|**/TRUNCATE_POINT_LABELS=FALSE**|Exports all point labels with 4 characters.|
-|**/USE_ORIGINAL_START_FRAME**=   |Visual3D always refers to the first frame of data as Frame 1. Some C3D files specify a different start frame that Visual3D stores for possible export||
+|**/USE_ORIGINAL_START_FRAME=FALSE**|If 'TRUE', keeps the original start frame of the file.|
-|**/EXPORT_START_FRAME**= 1       |The first frame of data to export                                                                                                                    ||
+|**/EXPORT_START_FRAME=1**|Frame to start the export from.|
-|**/EXPORT_END_FRAME**= EOF       |The last frame of data to export                                                                                                                     ||
+|**/EXPORT_END_FRAME=EOF**|Frame to end the export on ('EOF' = end of file).|
-|**/Export_All_Landmarks=**       |(true or false) Export Landmarks as Targets.                                                                                                         ||
+|**/EXPORT_PROCESSED_TARGET_DATA=FALSE**|If 'TRUE', exports processed marker data.|
-|**/Export_Digitizing_Landmarks=**|(true or false) Export Digitizing Landmarks as Targets.                                                                                              ||
+|**/EXPORT_PROCESSED_ANALOG_DATA=FALSE**|If 'TRUE', exports processed analog data.|
-|**/Export_Functional_Landmarks=**|(true or false) Export Functional Joint Landmarks as Targets.                                                                                        ||
+|**/TRUNCATE_PARAMETER_SECTION=FALSE**|If 'TRUE', trims parameter section for compatibility.|
-|**/Export_Empty_Targets=**       |(true or false) Signals that contain no data will not be exported.                                                                                   ||
+|**/EXPORT_ALL_LANDMARKS=FALSE**|(TRUE or FALSE) Export Landmarks as Targets.|
-|**/Export_Old_Event_Labels=**    |(true or false) Export Event Labels in the Header Section.                                                                                           ||
+|**/EXPORT_DIGITIZING_LANDMARKS=FALSE**|(TRUE or FALSE) Export Digitizing Landmarks as Targets.|
-|**/Event_Labels=**               |List of Event_Labels to be exported. If empty, all Event labels\\ (up to a maximum of 18 if Old Event Labels are selected) will be exported.         ||
+|**/EXPORT_EMPTY_TARGETS=FALSE**|If 'TRUE', includes empty target signals in export.|
+|**/EVENT_LABELS=**|Specify which event labels to export.|
+|**/EXPORT_OLD_EVENT_LABELS=FALSE**|If 'TRUE", uses old event label format for compatibility.|
-===== Example: Exporting between Event_Labels =====
+===== Dialog =====
+The command can be edited in a text editor or in dialog form. To edit in the dialog, either click on the **Edit** button in the pipeline workshop, or double-click on the pipeline command. The dialog is shown below:
+{{:visual3d:documentation:pipeline:file_commands:exportc3dfile_dialogbox.png?500|}}
+  * **File to Export**: Dropdown to select the currently loaded motion file (C3D) from the workspace.
+  * **New File Name**: Field to define the new exported C3D file name.
+  * **Export Folder**: Directory where the exported file will be saved. You can browse to select a location.
+  * **File Suffix**: Text suffix added to the original filename.
+  * **Replace File if it Exists**: If checked, allows overwriting existing C3D files with the same name.
+  * **Prompt for new file if folder and filename are blank**: Ensures a prompt appears if no filename or folder is specified.
+  * **Select Old 4/18 Character Event Labels in Header to Export**: Text field or listbox to manually enter or select legacy event labels.
+  * **Export Original First Frame**: Maintains the original file's start frame (otherwise export starts at frame 1 or a specified value.
+  * **Export All Landmarks as Targets**: Includes digitized anatomical landmarks in the export as regular target points.
+  * **Export Functional Joint Landmarks as Targets**: Exports joint center landmarks as target markers.
+  * **Export Unnamed and Empty Targets**: Includes targets that do not have reliable tracking or are unnamed.
+  * **Export Processed Target Data**: Exports the filtered or otherwise processed marker data instead of raw target signals.
+  * **Export Processed Analog Data**: Exports processed analog signals (e.g., filtered EMG) instead of raw analog data.
+  * **4 Character Labels**: If checked, trims target names to four characters for older software compatibility.
+  * **Truncate Parameters Section**: Reduces the parameter section to the minimum required set (useful for older systems or simpler exports).
+  * **Export Old 4/18 Character Event Labels in Header**: Uses older event label format in the C3D header for compatibility with legacy systems.
+  * **Endian**: Dropdown to select the endian format (PC, VAX, SGI) for the binary C3D output.
+  * **Export Start Frame**: Specifies which frame of the motion file to begin exporting.
+  * **Export End Frame**: Specifies the final frame to export. Default is EOF (End of File).
+===== Examples =====
+The following examples will go through the use of the **Export_C3DFile** command in the Visual3D application.
+==== Example 1: Exporting between Event_Labels ====
 Only a START_FRAME and an END_FRAME are available as parameters for the export command. To export between EVENT_LABELS:
-**Set_Pipeline_Parameter_From_Expression**
+<code>
+Set_Pipeline_Parameter_From_Expression
 /PARAMETER_NAME=START_FRAME
 /EXPRESSION=1+EVENT_LABEL::ORIGINAL::START*PARAMETERS::POINT::RATE
 /AS_INTEGER=TRUE
-**;**
+;
-\\
+Set_Pipeline_Parameter_From_Expression
-**Set_Pipeline_Parameter_From_Expression**
 /PARAMETER_NAME=ENDFRAME
 /EXPRESSION=1+EVENT_LABEL::ORIGINAL::END*PARAMETERS::POINT::RATE
 /AS_INTEGER=TRUE
-**;**
+;
-**Export_C3DFile**
+Export_C3DFile
 /OLD_FILE_NAME=C:\Demo Files\CaseAMD\amd001.c3d
 /NEW_FILE_NAME=test.c3d
@@ Line 66: / Line 128: @@
 ! /EVENT_LABELS=
 ! /EXPORT_OLD_EVENT_LABELS=FALSE
-**;**
+;
-===== Example: Exporting all C3D files from the Workspace =====
+</code>
+==== Example 2: Exporting all C3D files from the Workspace ====
 This example will export all C3D files in the Workspace
@@ Line 118: / Line 181: @@
 </code>
-===== Exporting Processed Signals =====
+==== Exporting Processed Signals ====
 If **/Export_Processed_Data= TRUE**, Visual3D exports only data from the TARGET PROCESSED folder.
@@ Line 152: / Line 215: @@
 </code>
-\\
+----
 [[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]]