HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » model_commands » Get Vicon Model Metric
visual3d:documentation:pipeline:model_commands:get_vicon_model_metric

Differences

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

Link to this comparison view

Next revision		Previous revision
visual3d:documentation:pipeline:model_commands:get_vicon_model_metric [2024/06/14 17:28] – created sgrangervisual3d:documentation:pipeline:model_commands:get_vicon_model_metric [2025/03/18 17:54] (current) – [Example] wikisysop
Line 1: Line 1:
 +====== Get Vicon Model Metric ======
 +
 Extracting metric values from Vicon's .MP file into Visual3D Subject/Data Metrics Extracting metric values from Vicon's .MP file into Visual3D Subject/Data Metrics
  
-====== Pipeline Command ======+===== Pipeline Command =====
  
-**Get_Vicon_Model_Metric**+<code> 
 +Get_Vicon_Model_Metric
 ! /CALIBRATION_FILE= ! /CALIBRATION_FILE=
 ! /MP_FILE_NAME= ! /MP_FILE_NAME=
 ! /METRIC_NAMES= ! /METRIC_NAMES=
 ! /METRIC_VALUES= ! /METRIC_VALUES=
-**;**+; 
 +</code> 
 /Calibration_File refers to the Link Model in which the metrics will be stored /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. If Calibration_File is empty or =*, the current link model is used.
 +
 /MP_File_Name refers to the Vicon MP file /MP_File_Name refers to the Vicon MP file
 +
 If MP_File_Name is empty, the user is prompted for the filename. 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. MP_File_Name refers to the full path name of the file.
 +
 /Metric_Names and /Metric_Values are optional /Metric_Names and /Metric_Values are optional
 +
 If Metric_Names is empty or =*, all Metric_Names in the .mp file are selected 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. 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 ======+ 
 +===== Example =====
  
 Given an MP file containing the following information: Given an MP file containing the following information:
  
 +<code>
 $RKnee_Width = 150.0 $RKnee_Width = 150.0
 $RFoot_Width = 100.0 $RFoot_Width = 100.0
 $LKnee_Width = 150.0 $LKnee_Width = 150.0
 $LFoot_Width = 100.0 $LFoot_Width = 100.0
 +</code>
 +
 and the command and the command
  
-'**Get_Vicon_Model_Metric**+<code> 
 +Get_Vicon_Model_Metric
 /CALIBRATION_FILE=* /CALIBRATION_FILE=*
 /MP_FILE_NAME= /MP_FILE_NAME=
Line 33: Line 49:
 /METRIC_VALUES= /METRIC_VALUES=
 /NAME_PREFIX= /NAME_PREFIX=
-**;**+; 
 +</code> 
   * The current active model will be used.   * The current active model will be used.
   * The user will be prompted for the MP file name.   * The user will be prompted for the MP file name.
Line 39: Line 57:
   * No prefix will be added to the names.   * No prefix will be added to the names.
  
-\\ +<code> 
- +Get_Vicon_Model_Metric
- +
-**Get_Vicon_Model_Metric**+
 /CALIBRATION_FILE= /CALIBRATION_FILE=
 /MP_FILE_NAME= /MP_FILE_NAME=
Line 48: Line 64:
 /DEFAULT_METRIC_VALUES=0.5*DISTANCE(RIGHT_HIP,LEFT_HIP) /DEFAULT_METRIC_VALUES=0.5*DISTANCE(RIGHT_HIP,LEFT_HIP)
 /NAME_PREFIX= /NAME_PREFIX=
-**;**+; 
 +</code> 
   * RHip_Radius is not part of the MP file   * RHip_Radius is not part of the MP file
   * A default metric value has been provided   * A default metric value has been provided
Line 54: Line 72:
   * The value of the metric will be the expression 0.5*DISTANCE(RIGHT_HIP,LEFT_HIP)   * The value of the metric will be the expression 0.5*DISTANCE(RIGHT_HIP,LEFT_HIP)
  
- 
-Retrieved from "" 
  
  
visual3d/documentation/pipeline/model_commands/get_vicon_model_metric.1718386125.txt.gz · Last modified: 2024/06/14 17:28 by sgranger