HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » file_commands » Export C3DFile
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
Next revision		Previous revision
visual3d:documentation:pipeline:file_commands:export_c3dfile [2024/06/19 12:50] – sgrangervisual3d:documentation:pipeline:file_commands:export_c3dfile [2024/12/27 16:51] (current) – [Example: Exporting between Event_Labels] wikisysop
Line 1: Line 1:
-{{exportc3dpipeline.png+====== Export C3DFile ======
  
-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.+{{:ExportC3DPipeline.png}}
  
-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**+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.
  
-====== pipeline command ======+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 **export_c3dfile** command parameter definitions are found below:+===== Pipeline Command =====
  
-|**export_c3dfile**               |                                                                                                                                                     || +The **Export_C3DFile** command parameter definitions are found below:
-|**/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 ======+|**Export_C3DFile**               |                                                                                                                                                     || 
 +|**/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.         ||
  
-only a start_frame and an end_frame are available as parameters for the export command. to export between event_labels:+===== Example: Exporting between Event_Labels =====
  
-**set_pipeline_parameter_from_expression** +Only a START_FRAME and an END_FRAME are available as parameters for the export command. To export between EVENT_LABELS:
-/parameter_name=start_frame +
-/expression=1+event_label::original::start*parameters::point::rate +
-/as_integer=true +
-**;** +
-\\+
  
 +<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
 +/PARAMETER_NAME=ENDFRAME
 +/EXPRESSION=1+EVENT_LABEL::ORIGINAL::END*PARAMETERS::POINT::RATE
 +/AS_INTEGER=TRUE
 +;
  
-**set_pipeline_parameter_from_expression** +Export_C3DFile 
-/parameter_name=endframe +/OLD_FILE_NAME=C:\Demo Files\CaseAMD\amd001.c3d 
-/expression=1+event_label::original::end*parameters::point::rate +/NEW_FILE_NAME=test.c3d 
-/as_integer=true +/DESTINATION_FOLDER=Z:\scottselbie 1\Desktop\test\ 
-**;** +/SUFFIX= 
-**export_c3dfile** +/EXPORT_ENDIAN=1 
-/old_file_name=c:\demo files\caseamd\amd001.c3d +! /TRUNCATE_POINT_LABELS=FALSE 
-/new_file_name=test.c3d +! /USE_ORIGINAL_START_FRAME=FALSE 
-/destination_folder=z:\scottselbie 1\desktop\test\ +/EXPORT_START_FRAME=::START_FRAME 
-/suffix= +/EXPORT_END_FRAME=::END_FRAME 
-/export_endian=1 +! /EXPORT_PROCESSED_TARGET_DATA=FALSE 
-! /truncate_point_labels=false +! /EXPORT_PROCESSED_ANALOG_DATA=FALSE 
-! /use_original_start_frame=false +! /TRUNCATE_PARAMETER_SECTION=FALSE 
-/export_start_frame=::start_frame +/EXPORT_ALL_LANDMARKS=FALSE 
-/export_end_frame=::end_frame +! /EXPORT_DIGITIZING_LANDMARKS=FALSE 
-! /export_processed_target_data=false +! /EXPORT_FUNCTIONAL_LANDMARKS=FALSE 
-! /export_processed_analog_data=false +! /EXPORT_EMPTY_TARGETS=FALSE 
-! /truncate_parameter_section=false +! /EVENT_LABELS= 
-/export_all_landmarks=false +! /EXPORT_OLD_EVENT_LABELS=FALSE 
-! /export_digitizing_landmarks=false +; 
-! /export_functional_landmarks=false +</code> 
-! /export_empty_targets=false +===== Example: Exporting all C3D files from the Workspace =====
-! /event_labels= +
-! /export_old_event_labels=false +
-**;** +
-====== example: 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
  
 <code> <code>
-export_c3dfile +Export_C3DFile 
-/old_file_name= *.c3d +/Old_File_Name= *.c3d 
-!/new_file_name= +!/New_File_Name= 
-/destination_folder= +/Destination_Folder= 
-/suffix= +/Suffix= 
-!/export_endian= +!/Export_Endian= 
-!/truncate_point_labels= +!/Truncate_Point_Labels= 
-!/use_original_start_frame=false +!/USE_ORIGINAL_START_FRAME=FALSE 
-!/export_start_frame=1 +!/EXPORT_START_FRAME=1 
-!/export_end_frame=eof +!/EXPORT_END_FRAME=EOF 
-!/export_processed_data= false +!/Export_Processed_Data= false 
-!/truncate_parameter_section=false +!/Truncate_Parameter_Section=false 
-!/export_junk_targets=false +!/Export_Junk_Targets=false 
-!/export_old_event_labels=false +!/Export_Old_Event_Labels=false 
-!/event_labels=+!/Event_Labels=
 ; ;
 </code> </code>
  
-note that the **/destination_folder=** is not specified in the command above. to have control over the destination folder for the exported c3d file, the entire path to the exported file should be specified. often this is done by adding a pipeline command to prompt the user for the folder path.+Note that the **/Destination_Folder=** is not specified in the command above. To have control over the destination folder for the exported C3D file, the entire path to the exported file should be specified. Often this is done by adding a pipeline command to prompt the user for the Folder Path.
  
 <code> <code>
-! this will allow the user to set the folder path for the destination files +! This will allow the user to set the folder path for the destination files 
-set_pipeline_parameter_to_folder_path +Set_Pipeline_Parameter_To_Folder_Path 
-/parameter_name= folder +/PARAMETER_NAME= FOLDER 
-/parameter_value=+/PARAMETER_VALUE=
 ; ;
  
-! export all c3d files in the workspace to the folder path specified by the user +! Export all C3D files in the Workspace to the Folder path specified by the user 
-export_c3dfile +Export_C3DFile 
-/old_file_name= *.c3d +/Old_File_Name= *.c3d 
-!/new_file_name= +!/New_File_Name= 
-/destination_folder=::folder +/Destination_Folder=::FOLDER 
-/suffix= +/Suffix= 
-!/export_endian= +!/Export_Endian= 
-!/truncate_point_labels= +!/Truncate_Point_Labels= 
-!/use_original_start_frame=false +!/USE_ORIGINAL_START_FRAME=FALSE 
-!/export_start_frame=1 +!/EXPORT_START_FRAME=1 
-!/export_end_frame=eof +!/EXPORT_END_FRAME=EOF 
-!/export_processed_data= false +!/Export_Processed_Data= false 
-!/truncate_parameter_section=false +!/Truncate_Parameter_Section=false 
-!/export_junk_targets=false +!/Export_Junk_Targets=false 
-!/export_old_event_labels=false +!/Export_Old_Event_Labels=false 
-!/event_labels=+!/Event_Labels=
 ; ;
 </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.
  
-if there are no signals in the processed folder, the exported c3d file will contain no point data.+If there are no signals in the PROCESSED folder, the exported C3D file will contain no POINT data.
  
 <code> <code>
-! this will allow the user to set the folder path for the destination files +! This will allow the user to set the folder path for the destination files 
-set_pipeline_parameter_to_folder_path +Set_Pipeline_Parameter_To_Folder_Path 
-/parameter_name= folder +/PARAMETER_NAME= FOLDER 
-/parameter_value=+/PARAMETER_VALUE=
 ; ;
  
-! export all c3d files in the workspace to the folder path specified by the user +! Export all C3D files in the Workspace to the Folder path specified by the user 
-! visual3d exports only data from the target processed folder +! Visual3D exports only data from the TARGET PROCESSED folder 
-export_c3dfile +Export_C3DFile 
-/old_file_name= *.c3d +/Old_File_Name= *.c3d 
-!/new_file_name= +!/New_File_Name= 
-/destination_folder=::folder +/Destination_Folder=::FOLDER 
-/suffix= +/Suffix= 
-!/export_endian= +!/Export_Endian= 
-!/truncate_point_labels= +!/Truncate_Point_Labels= 
-!/use_original_start_frame=false +!/USE_ORIGINAL_START_FRAME=FALSE 
-!/export_start_frame=1 +!/EXPORT_START_FRAME=1 
-!/export_end_frame=eof +!/EXPORT_END_FRAME=EOF 
-/export_processed_data= true +/Export_Processed_Data= TRUE 
-!/truncate_parameter_section=false +!/Truncate_Parameter_Section=false 
-!/export_junk_targets=false +!/Export_Junk_Targets=false 
-!/export_old_event_labels=false +!/Export_Old_Event_Labels=false 
-!/event_labels= +!/Event_Labels= 
-!/number_of_frames_to_export=all+!/Number_Of_Frames_To_Export=ALL
 ; ;
 </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.1718801409.txt.gz · Last modified: 2024/06/19 12:50 by sgranger