User Tools

Site Tools


visual3d:documentation:pipeline:file_commands:export_c3dfile

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
visual3d:documentation:pipeline:file_commands:export_c3dfile [2025/06/06 18:04] – [Command Parameters] wikisysopvisual3d:documentation:pipeline:file_commands:export_c3dfile [2025/06/06 18:53] (current) wikisysop
Line 6: Line 6:
   * 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 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 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.   * 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.
- 
-There are two ways to export to a C3D File. One is through the Export Menu commands that can be found in the File  
  
 ===== Pipeline Command ===== ===== Pipeline Command =====
Line 42: Line 40:
  
 The **Export_C3DFile** command parameter definitions are found below: The **Export_C3DFile** command parameter definitions are found below:
- 
  
 |**Parameter**|**Description**| |**Parameter**|**Description**|
Line 49: Line 46:
 |**/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 is added to the new filename.| |**/SUFFIX=**|The suffix is added to the new filename.|
-|**/CREATE_FOLDER_PATH=FALSE| | +|**/CREATE_FOLDER_PATH=FALSE|If 'TRUE', creates the destination folder if it doesn't exist.
-|**/PROMPT_FOR_NEW_FILE=TRUE|+|**/PROMPT_FOR_NEW_FILE=TRUE|If 'TRUE', opens a dialog to allow the user to choose the destination C3D name.|
 |**/EXPORT_ENDIAN=**|The endian for the exported file.| |**/EXPORT_ENDIAN=**|The endian for the exported file.|
 |**/TRUNCATE_POINT_LABELS=FALSE**|Exports all point labels with 4 characters.| |**/TRUNCATE_POINT_LABELS=FALSE**|Exports all point labels with 4 characters.|
-|**/USE_ORIGINAL_START_FRAME=FALSE**| +|**/USE_ORIGINAL_START_FRAME=FALSE**|If 'TRUE', keeps the original start frame of the file.| 
 +|**/EXPORT_START_FRAME=1**|Frame to start the export from.| 
 +|**/EXPORT_END_FRAME=EOF**|Frame to end the export on ('EOF' = end of file).| 
 +|**/EXPORT_PROCESSED_TARGET_DATA=FALSE**|If 'TRUE', exports processed marker data.| 
 +|**/EXPORT_PROCESSED_ANALOG_DATA=FALSE**|If 'TRUE', exports processed analog data.| 
 +|**/TRUNCATE_PARAMETER_SECTION=FALSE**|If 'TRUE', trims parameter section for compatibility.| 
 +|**/EXPORT_ALL_LANDMARKS=FALSE**|(TRUE or FALSE) Export Landmarks as Targets.| 
 +|**/EXPORT_DIGITIZING_LANDMARKS=FALSE**|(TRUE or FALSE) Export Digitizing Landmarks as Targets.| 
 +|**/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.|
  
 +===== 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:
  
-{{:ExportC3DPipeline.png}}+{{: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 =====
  
-|**Export_C3DFile**                                                                                                                                                                   || +The following examples will go through the use of the **Export_C3DFile** command in the Visual3D application.
-|**/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                                                                                                                || +
-|**/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.                                                                                                       || +
-|**/Export_Endian=**              |The endian for the exported file.                                                                                                                    || +
-|**/Truncate_Point_Labels=**      |(true or false) exports all point labels with 4 characters.                                                                                          || +
-|**/Export_Processed_Data=**      |(true or false) exports data from the PROCESSED folder instead of the ORIGINAL folder.                                                               || +
-|**/Truncate_Parameter_Section=** |(true or false) truncates the parameter section.                                                                                                     || +
-|**/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|| +
-|**/EXPORT_START_FRAME**= 1       |The first frame of data to export                                                                                                                    || +
-|**/EXPORT_END_FRAME**= EOF       |The last frame of data to export                                                                                                                     || +
-|**/Export_All_Landmarks=**       |(true or false) Export Landmarks as Targets.                                                                                                         || +
-|**/Export_Digitizing_Landmarks=**|(true or false) Export Digitizing Landmarks as Targets.                                                                                              || +
-|**/Export_Functional_Landmarks=**|(true or false) Export Functional Joint Landmarks as Targets.                                                                                        || +
-|**/Export_Empty_Targets=**       |(true or false) Signals that contain no data will not be exported.                                                                                   || +
-|**/Export_Old_Event_Labels=**    |(true or false) Export Event Labels in the Header Section.                                                                                           || +
-|**/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        ||+
  
-===== Example: Exporting between Event_Labels =====+ 
 +==== 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: Only a START_FRAME and an END_FRAME are available as parameters for the export command. To export between EVENT_LABELS:
Line 117: Line 130:
 ; ;
 </code> </code>
-===== Example: Exporting all C3D files from the Workspace =====+==== Example 2: Exporting all C3D files from the Workspace ====
  
 This example will export all C3D files in the Workspace This example will export all C3D files in the Workspace
Line 168: Line 181:
 </code> </code>
  
-===== Exporting Processed Signals =====+==== Exporting Processed Signals ====
  
 If **/Export_Processed_Data= TRUE**, Visual3D exports only data from the TARGET PROCESSED folder. If **/Export_Processed_Data= TRUE**, Visual3D exports only data from the TARGET PROCESSED folder.
Line 202: Line 215:
 </code> </code>
  
-\\+
 [[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]]
  
  
  
visual3d/documentation/pipeline/file_commands/export_c3dfile.txt · Last modified: 2025/06/06 18:53 by wikisysop