Differences

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

--- visual3d:documentation:pipeline:model_commands:get_vicon_model_metric [2024/06/26 20:27] – created 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 ======
+====== Get Vicon Model Metric ======
 Extracting metric values from Vicon's .MP file into Visual3D Subject/Data Metrics
@@ Line 5: / Line 5: @@
 ===== Pipeline Command =====
-**Get_Vicon_Model_Metric**
+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=
-! /METRIC_VALUES=
+! /DEFAULT_METRIC_VALUES=
-**;**
+! /NAME_PREFIX=V_
-/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
+</code>
-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.
+====Command Parameters====
-/Metric_Names and /Metric_Values are optional
-If Metric_Names is empty or =*, all Metric_Names in the .mp file are selected
+The following table shows the command parameters seen above and their descriptions:
-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.
+|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
-'**Get_Vicon_Model_Metric**
+<code>
+Get_Vicon_Model_Metric
 /CALIBRATION_FILE=*
 /MP_FILE_NAME=
@@ Line 35: / Line 50: @@
 /METRIC_VALUES=
 /NAME_PREFIX=
-**;**
+;
+</code>
   * The current active model will be used.
   * The user will be prompted for the MP file name.
@@ Line 41: / Line 58: @@
   * No prefix will be added to the names.
-\\
+<code>
+Get_Vicon_Model_Metric
-**Get_Vicon_Model_Metric**
 /CALIBRATION_FILE=
 /MP_FILE_NAME=
@@ Line 50: / Line 65: @@
 /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