Differences

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

--- visual3d:documentation:pipeline:model_commands:get_vicon_model_metric [2024/07/16 16:59] – removed sgranger
+++ visual3d:documentation:pipeline:model_commands:get_vicon_model_metric [2026/06/11 19:07] (current) – [Pipeline Command] wikisysop
@@ Line 1: / Line 1: @@
+====== Get Vicon Model Metric ======
+Extracting metric values from Vicon's .MP file into Visual3D Subject/Data Metrics
+===== Pipeline Command =====
+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>
+and the command
+<code>
+Get_Vicon_Model_Metric
+/CALIBRATION_FILE=*
+/MP_FILE_NAME=
+/METRIC_NAMES=
+/METRIC_VALUES=
+/NAME_PREFIX=
+;
+</code>
+  * 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>
+  * 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)