Differences

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

--- visual3d:documentation:pipeline:model_commands:get_vicon_model_metric [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:model_commands:get_vicon_model_metric [2026/06/11 19:07] (current) – [Pipeline Command] wikisysop
@@ Line 1: / Line 1: @@
-extracting metric values from vicon's .mp file into visual3d subject/data metrics
+====== Get Vicon Model Metric ======
-====== pipeline command ======
+Extracting metric values from Vicon's .MP file into Visual3D Subject/Data Metrics
-**get_vicon_model_metric**
+===== Pipeline Command =====
-! /calibration_file=
-! /mp_file_name=
-! /metric_names=
-! /metric_values=
-**;**
-/calibration_file refers to the link model in which the metrics will be stored
-if calibration_file is empty or =*, the current link model is used.
-/mp_file_name refers to the vicon mp file
-if mp_file_name is empty, the user is prompted for the filename.
-mp_file_name refers to the full path name of the file.
-/metric_names and /metric_values are optional
-if metric_names is empty or =*, all metric_names in the .mp file are selected
-if metric_values is populated, this is the default value of metric_names and is used if metric_names does not exist in the .mp file.
-====== example ======
-given an mp file containing the following information:
+The command can be found in the **Pipeline Workshop** under **Model Building** as so
+<code>
+Get_Vicon_Model_Metric
+! /CALIBRATION_FILE=
+! /MP_FILE_NAME=
+! /METRIC_NAMES=
+! /DEFAULT_METRIC_VALUES=
+! /NAME_PREFIX=V_
+;
+</code>
+====Command Parameters====
+The following table shows the command parameters seen above and their descriptions:
+|CALIBRATION_FILE| The Link Model in which the metrics will be stored if empty or =*, the current link model is used|
+|MP_FILE_NAME| The Vicon MP file ensure it is full pathname, if empty, the user is prompted for the filename |
+|METRIC_NAMES| The names of the metric, if empty or =*, all names in the .mp file are selected |
+|DEFAULT_METRIC_VALUES | Default name value|
+|NAME_PREFIX| Prefix for the given name |
+===== Example =====
+Given an MP file containing the following information:
+<code>
+$RKnee_Width = 150.0
+$RFoot_Width = 100.0
+$LKnee_Width = 150.0
+$LFoot_Width = 100.0
+</code>
-$rknee_width = 150.0
-$rfoot_width = 100.0
-$lknee_width = 150.0
-$lfoot_width = 100.0
 and the command
-'**get_vicon_model_metric**
+<code>
-/calibration_file=*
+Get_Vicon_Model_Metric
-/mp_file_name=
+/CALIBRATION_FILE=*
-/metric_names=
+/MP_FILE_NAME=
-/metric_values=
+/METRIC_NAMES=
-/name_prefix=
+/METRIC_VALUES=
-**;**
+/NAME_PREFIX=
-  * the current active model will be used.
+;
-  * the user will be prompted for the mp file name.
+</code>
-  * all 4 metric values in the mp file will be added to the model subject metrics
-  * no prefix will be added to the names.
-\\
+  * The current active model will be used.
+  * The user will be prompted for the MP file name.
+  * All 4 metric values in the MP file will be added to the model subject metrics
+  * No prefix will be added to the names.
+<code>
+Get_Vicon_Model_Metric
+/CALIBRATION_FILE=
+/MP_FILE_NAME=
+/METRIC_NAMES=RHip_Radius
+/DEFAULT_METRIC_VALUES=0.5*DISTANCE(RIGHT_HIP,LEFT_HIP)
+/NAME_PREFIX=
+;
+</code>
-**get_vicon_model_metric**
+  * RHip_Radius is not part of the MP file
-/calibration_file=
+  * A default metric value has been provided
-/mp_file_name=
+  * A model metric RHip_Radius will be created (or modified)
-/metric_names=rhip_radius
+  * The value of the metric will be the expression 0.5*DISTANCE(RIGHT_HIP,LEFT_HIP)
-/default_metric_values=0.5*distance(right_hip,left_hip)
-/name_prefix=
-**;**
-  * rhip_radius is not part of the mp file
-  * a default metric value has been provided
-  * a model metric rhip_radius will be created (or modified)
-  * the value of the metric will be the expression 0.5*distance(right_hip,left_hip)