Differences

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

--- visual3d:documentation:kinematics_and_kinetics:external_forces:modifying_c3d_parameters [2024/06/19 12:48] – sgranger
+++ visual3d:documentation:kinematics_and_kinetics:external_forces:modifying_c3d_parameters [2024/07/17 15:45] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{c3d parameters can be modified in visual3d in the file menu commands or via the pipeline commands.
+====== Modifying C3D Parameters ======
-===== modify force platform parameters =====
+C3D parameters can be modified in Visual3D in the File menu commands or via the Pipeline commands.
-a common challenge for a manufacturer creating c3d formatted datafiles is the declaration of the force platform properties in the parameter section of the file.
+==== Modify Force Platform parameters ====
-there are also several minor inconsistencies in the way that manufacturers create the c3d files. visual3d currently uses script commands to "fix" these inconsistencies. please contact c-motion to determine if you need to process the c3d files that have been produced by your motion capture system.
+A common challenge for a manufacturer creating C3D formatted datafiles is the declaration of the Force Platform properties in the parameter section of the file.
-the following minimal set of force platform parameters is assumed to exist in the c3d file.
+There are also several minor inconsistencies in the way that manufacturers create the C3D files. Visual3D currently uses script commands to "FIX" these inconsistencies. Please contact C-Motion to determine if you need to process the C3D files that have been produced by your motion capture system.
-**parameters:force_platform:**
+The following minimal set of force platform parameters is assumed to exist in the C3D File.
-**used**= number of force platforms used
+**PARAMETERS:FORCE_PLATFORM:**
-**type**= types of force platforms (1=default, 2= amti,bertec, 3= kistler)
+**USED**= number of force platforms used
-**zero**= the range of frames for which a background noise level is calculated and then subtracted from each of the analog channels
+**TYPE**= types of force platforms (1=default, 2= AMTI,Bertec, 3= Kistler)
-**channel**= an array containing the analog channels associated with the force platform
+**ZERO**= the range of frames for which a background noise level is calculated and then subtracted from each of the analog channels
-**origin**= the origin of the force platform in the force platform coordinate system (see the force platform manufacturer specifications.
+**CHANNEL**= an array containing the ANALOG channels associated with the force platform
-**corners**= the (x,y,z) coordinates of the force platform corners in the laboratory coordinate system. **note:** that there is a specific ordering of the four corners.
+**ORIGIN**= The origin of the force platform in the force platform coordinate system (see the force platform manufacturer specifications.
-amti4.png
+**CORNERS**= The (x,y,z) coordinates of the force platform corners in the laboratory coordinate system. **Note:** that there is a specific ordering of the four corners.
-this dialog is used to modify the force platform parameters (under the file menu in visual3d) that specify how the analog signals stored in the data file are to be transformed into the grforce, cofp, and freemoment signals. **note:** the number of places that you can go wrong.
+{{:Amti4.png}}
-===== modify_point_parameters pipeline command =====
+This dialog is used to modify the force platform parameters (under the file menu in Visual3D) that specify how the ANALOG signals stored in the data file are to be transformed into the GRFORCE, COFP, and FREEMOMENT signals. **Note:** the number of places that you can go wrong.
-the command **modify_point_parameters** will modify the point labels (e.g. marker names) in the c3d file. the labels listed will be applied to the point parameters in the order listed in the c3d file. if fewer labels are specified in the command than exist in the c3d file, then only the number of labels specified will be modified. the command is below:
+==== Modify_Point_Parameters Pipeline Command ====
-modify_point_parameters
+The command **Modify_Point_Parameters** will modify the POINT LABELS (e.g. Marker Names) in the C3D file. The LABELS listed will be applied to the POINT parameters in the order listed in the C3D file. If fewer LABELS are specified in the command than exist in the C3D file, then only the number of LABELS specified will be modified. The command is below:
-! /point_labels=list of point labels in the order listed in the c3d file
-! /overwrite_c3d_file=false overwrite the c3d file true or false
-**note:** if the parameter **/overwrite_c3d_file=true** c3d file on disk will be modified automatically (dialog browser will appear so you can select the c3d file to overwrite). if false only the current workspace is modified, not the file on disk.
-for example, the following command will modify the first 5 point labels (eg. rename them):
+Modify_Point_Parameters
+! /POINT_LABELS=List of point labels in the order listed in the C3D file
+! /OVERWRITE_C3D_FILE=FALSE Overwrite the C3D file TRUE or FALSE
+**Note:** If the parameter **/OVERWRITE_C3D_FILE=TRUE** C3D file on disk will be modified automatically (dialog browser will appear so you can select the C3D file to overwrite). If FALSE only the current workspace is modified, not the file on disk.
+For example, the following command will modify the first 5 Point labels (eg. rename them):
 <code>
-modify_point_parameters
+Modify_Point_Parameters
-/point_labels= pt1+pt2+pt3+pt4+pt5
+/POINT_LABELS= PT1+PT2+PT3+PT4+PT5
-! /overwrite_c3d_file=false
+! /OVERWRITE_C3D_FILE=FALSE
 ;
 </code>
-===== modify_analog_parameters pipeline command =====
+==== Modify_Analog_Parameters Pipeline Command ====
-this command can be used to change a selection of the analog parameters in a c3d file. there must be the same number of values in the labels, scale, and offset entries. the command will modify the parameters in order. for example, if two entries are specified, the first two entries in the analog parameters will be modified; the remaining parameters will remain the same.
+This command can be used to change a selection of the ANALOG parameters in a C3D file. There must be the same number of values in the LABELS, SCALE, and OFFSET entries. The command will modify the parameters in order. For example, if two entries are specified, the first two entries in the ANALOG parameters will be modified; the remaining parameters will remain the same.
-|**modify_analog_parameters**                                                       |                                                                                                        |
+|**Modify_Analog_Parameters**                                                       |                                                                                                        |
-|/analog_labels=                                                                    |enter the new analog labels in the order that they appear in the c3d file analog parameters.            |
+|/Analog_Labels=                                                                    |Enter the new Analog Labels in the order that they appear in the c3d file ANALOG PARAMETERS.            |
-|/analog_gen_scale=                                                                 |enter a scaling factor that is multiplied by the analog_scale factors that are applied to every signal. |
+|/Analog_Gen_Scale=                                                                 |Enter a scaling factor that is multiplied by the Analog_Scale factors that are applied to every signal. |
-|/analog_scale=                                                                     |enter a scaling factor that is multiplied by the analog_gen_scale and applied to each signal.           |
+|/Analog_Scale=                                                                     |Enter a scaling factor that is multiplied by the Analog_Gen_Scale and applied to each signal.           |
-|/analog_offset=                                                                    |enter an offset for each signal that is subtracted from each signal before the signal is scaled.        |
+|/Analog_Offset=                                                                    |Enter an offset for each signal that is subtracted from each signal before the signal is scaled.        |
-|/analog_baseline=                                                                  |enter a baseline offset for each signal that is subtracted from each signal before the signal is scaled.|
+|/Analog_Baseline=                                                                  |Enter a baseline offset for each signal that is subtracted from each signal before the signal is scaled.|
-|/analog_unit=                                                                      |enter the units for each analog signal.                                                                 |
+|/Analog_Unit=                                                                      |Enter the units for each analog signal.                                                                 |
-|/[[visual3d:documentation:pipeline:file_commands:update_c3d_file|update_c3d_file]]=|(true or false) update the c3d file on disk automatically.                                              |
+|/[[Visual3D:Documentation:Pipeline:File_Commands:Update_C3D_File|Update_C3D_File]]=|(True or False) Update the C3D file on disk automatically.                                              |
 |**;**                                                                              |                                                                                                        |
-**note:** if **update_c3d_file=true** the c3d file on disk will be modified automatically. if false only the current workspace is modified, not the file on disk.
+**Note:** If **UPDATE_C3D_FILE=TRUE** the C3D file on disk will be modified automatically. If FALSE only the current workspace is modified, not the file on disk.
-if the **analog_scale** or **analog_labels** parameter have fewer entries in the command than signals in the file, only the number parameters specified will be processed. //in the order that the signals appear in the c3d parameters section of the file//
+If the **Analog_Scale** or **Analog_Labels** parameter have fewer entries in the command than signals in the file, only the number parameters specified will be processed. //In the order that the signals appear in the C3D PARAMETERS section of the file//
-for example, if only one **analog_labels** parameter is specified in the command, only the first **analog_label** will be modified.
+For example, if only one **Analog_Labels** parameter is specified in the command, only the first **Analog_Label** will be modified.
-the example below will modify the scale to 1.0 for the first 5 analog signals and automatically save the file to disk. no other analog parameters will be modified.
+The example below will modify the SCALE to 1.0 for the first 5 Analog Signals and automatically save the file to disk. No other Analog parameters will be modified.
 <code>
-modify_analog_parameters
+Modify_Analog_Parameters
-! /analog_labels=
+! /ANALOG_LABELS=
-! /analog_gen_scale=
+! /ANALOG_GEN_SCALE=
-/analog_scale= 1.0+1.0+1.0+1.0+1.0
+/ANALOG_SCALE= 1.0+1.0+1.0+1.0+1.0
-! /analog_offset=
+! /ANALOG_OFFSET=
-! /analog_baseline=
+! /ANALOG_BASELINE=
-! /update_c3d_file=true
+! /UPDATE_C3D_FILE=TRUE
 ;
 </code>
-the **/analog_baseline** parameter will accept expressions. the example below will modify the baseline value for the first analog signal using a metric signal metric::processed::offset
+The **/Analog_baseline** parameter will accept expressions. The example below will modify the baseline value for the first analog signal using a metric signal METRIC::PROCESSED::OFFSET
 <code>
-modify_analog_parameters
+Modify_Analog_Parameters
-! /analog_labels=
+! /ANALOG_LABELS=
-! /analog_gen_scale=
+! /ANALOG_GEN_SCALE=
-! /analog_scale=
+! /ANALOG_SCALE=
-! /analog_offset=
+! /ANALOG_OFFSET=
-/analog_baseline=metric::processed::offset
+/ANALOG_BASELINE=METRIC::PROCESSED::OFFSET
-! /update_c3d_file=false
+! /UPDATE_C3D_FILE=FALSE
 ;
 </code>
-==== common analog parameters ====
+=== Common ANALOG Parameters ===
-common parameters that visual3d expects to be in the analog section of the c3d file.
+Common parameters that Visual3D expects to be in the ANALOG Section of the C3D File.
-|**gen_scale**   |scaling factor that is multiplied by the analog_scale factors that are applied to every signal                                                                                                 |
+|**GEN_SCALE**   |Scaling factor that is multiplied by the Analog_Scale factors that are applied to every signal                                                                                                 |
-|**rate**        |the sampling rate of the analog data                                                                                                                                                           |
+|**RATE**        |The sampling rate of the ANALOG data                                                                                                                                                           |
-|**scale**       |a scaling factor for each signal that is multiplied by the analog_gen_scale and applied to each signal.                                                                                        |
+|**SCALE**       |A scaling factor for each signal that is multiplied by the Analog_Gen_Scale and applied to each signal.                                                                                        |
-|**offset**      |an offset for each signal that is subtracted from each signal before the signal is scaled.                                                                                                     |
+|**OFFSET**      |an offset for each signal that is subtracted from each signal before the signal is scaled.                                                                                                     |
-|**used**        |the number of signals containing analog data                                                                                                                                                   |
+|**USED**        |The number of signals containing ANALOG data                                                                                                                                                   |
-|**labels**      |the label names of the analog data signals                                                                                                                                                     |
+|**LABELS**      |The Label Names of the ANALOG data signals                                                                                                                                                     |
-|**descriptions**|the descriptions of the analog data signals. this information is rarely used by visual3d.                                                                                                      |
+|**DESCRIPTIONS**|The Descriptions of the ANALOG data signals. This information is rarely used by Visual3D.                                                                                                      |
-|**format**      |for integer data declares 12 bit or 16 bit data                                                                                                                                                |
+|**FORMAT**      |For integer data declares 12 bit or 16 bit data                                                                                                                                                |
-|**units**       |the units in which the analog data signals are stored in the file. the default value is v (volts)                                                                                              |
+|**UNITS**       |The Units in which the ANALOG data signals are stored in the file. The default value is v (Volts)                                                                                              |
-|**baselines**   |used by visual3d to define a baseline to be subtracted from each analog signal after the scale and offset are applied. this value is typically computed during real_time streaming of the data.|
+|**BASELINES**   |Used by Visual3D to define a baseline to be subtracted from each analog signal after the SCALE and OFFSET are applied. This value is typically computed during Real_Time streaming of the data.|
 \\
-other parameters will be read by visual3d but only in special circumstances will they be used.
+Other Parameters will be read by Visual3D but only in special circumstances will they be used.
-the **baselines** parameter was introduced by c-motion to accommodate real-time streaming data. for streaming data there is no frame number from which to define a range for the zero parameter. this doesn't mean that the zero parameter should be ignored.
+The **BASELINES** parameter was introduced by C-Motion to accommodate Real-time streaming data. For streaming data there is no frame number from which to define a range for the ZERO parameter. This doesn't mean that the ZERO parameter should be ignored.
-in visual3d streaming there is a button to starting the zero range. in order to replicate the data for post-processing these baselines need to be saved with the c3d file and the zero parameter set to 0,0.
+In Visual3D streaming there is a button to starting the ZERO range. In order to replicate the data for post-processing these baselines need to be saved with the C3D file and the ZERO parameter set to 0,0.
 \\
 \\
-[[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]]
-}}