HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » meta_commands » Meta Commands Overview
visual3d:documentation:pipeline:meta_commands:meta_commands_overview

Differences

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

Link to this comparison view

Next revision		Previous revision
visual3d:documentation:pipeline:meta_commands:meta_commands_overview [2024/06/14 17:27] – created sgrangervisual3d:documentation:pipeline:meta_commands:meta_commands_overview [2024/07/17 15:46] (current) – created sgranger
Line 1: Line 1:
-|**Language:**|** English**  • [[index.php?title=Pipeline_Commands:Meta_Commands/fr&action=edit&redlink=1|français]] • [[index.php?title=Pipeline_Commands:Meta_Commands/it&action=edit&redlink=1|italiano]] • [[Pipeline_Commands:Meta_Commands/pt|português]] • [[index.php?title=Pipeline_Commands:Meta_Commands/es&action=edit&redlink=1|español]] ****|+====== Meta Commands Overview ======
  
 \\ \\
  
- 
-|===== Contents =====\\ \\ \\ \\ * [[#Meta-Command_Header_Syntax|1 Meta-Command Header Syntax]]\\   * [[#Editing_a_Meta-Command|1.1 Editing a Meta-Command]]\\   * [[#Meta-Command_Examples|1.2 Meta-Command Examples]]\\     * [[#EMG|1.2.1 EMG]]\\     * [[#Events|1.2.2 Events]]\\     * [[#Metrics|1.2.3 Metrics]]\\     * [[#SDSSPP|1.2.4 SDSSPP]]\\     * [[#Other|1.2.5 Other]]| 
  
 A meta-command is a Visual3D pipeline script with additional header lines so that you can pass in parameter values. It has a **.v3m** extension instead of **.v3s**. The meta-command should be stored in a folder labeled **Meta-Commands**, which is located in the Visual3D **Plugins** Folder. You will have to create this folder yourself - it is not part of a default installation. A meta-command is a Visual3D pipeline script with additional header lines so that you can pass in parameter values. It has a **.v3m** extension instead of **.v3s**. The meta-command should be stored in a folder labeled **Meta-Commands**, which is located in the Visual3D **Plugins** Folder. You will have to create this folder yourself - it is not part of a default installation.
Line 15: Line 13:
  
  
-===== Meta-Command Header Syntax =====+==== Meta-Command Header Syntax ====
  
 ! BEGIN_META\\ ! BEGIN_META\\
Line 74: Line 72:
 Example of a default parameter: ! META_PARAM = SEGMENT_NAME:string:RPV:yes Example of a default parameter: ! META_PARAM = SEGMENT_NAME:string:RPV:yes
  
-==== Editing a Meta-Command ====+=== Editing a Meta-Command ===
  
 Meta-commands are stored on the disk, not in the Workspace. In order to edit a meta-command it is necessary to open the file in a text editor such as Notepad. The pipeline stores a reference to the meta-command file, rather than loading the meta-command. Meta-commands are stored on the disk, not in the Workspace. In order to edit a meta-command it is necessary to open the file in a text editor such as Notepad. The pipeline stores a reference to the meta-command file, rather than loading the meta-command.
  
-==== Meta-Command Examples ====+=== Meta-Command Examples ===
  
 Following is a list of Meta-Command Examples: Following is a list of Meta-Command Examples:
  
-=== EMG ===+== EMG ==
  
-**1. Basic_EMG_Filters** - Basic filtering of EMG signals. A series of band-stop (notch) filter for filtering 60 Hz noise, followed by a high pass filter at 10 Hz and a low pass filter at 350 Hz. Click [[|Meta Commands Example 2]] for details.+**1. Basic_EMG_Filters** - Basic filtering of EMG signals. A series of band-stop (notch) filter for filtering 60 Hz noise, followed by a high pass filter at 10 Hz and a low pass filter at 350 Hz. Click [[Visual3D:Documentation:Pipeline:Meta_Commands:Example_-_EMG_Meta_Command|Meta Commands Example 2]] for details.
  
 **2. EMG_Resting_Background and Madonna_EMG_Remove Background** - To Offset trial data to accommodate for any DC shift by quantifying the EMG Background noise based on a "Resting Trial". Click [[Visual3D:Documentation:EMG:Processing_Tools|EMG: Removing Background Noise]] for details. **2. EMG_Resting_Background and Madonna_EMG_Remove Background** - To Offset trial data to accommodate for any DC shift by quantifying the EMG Background noise based on a "Resting Trial". Click [[Visual3D:Documentation:EMG:Processing_Tools|EMG: Removing Background Noise]] for details.
Line 92: Line 90:
 **4. EMG_Normalize** - Typically the Scaling factors for EMG signals are the result of other data trials. Individual files in Visual3D cannot access the data from other files, so they only way signals can be shared is through the Global Workspace. For the sake of this example, we will assume that the scale factors already exist in the Global Workspace. Click [[Visual3D:Documentation:EMG:Processing:Normalize_EMG_to_Generic_Global_Variable|EMG Scale by Global Value]] for details. **4. EMG_Normalize** - Typically the Scaling factors for EMG signals are the result of other data trials. Individual files in Visual3D cannot access the data from other files, so they only way signals can be shared is through the Global Workspace. For the sake of this example, we will assume that the scale factors already exist in the Global Workspace. Click [[Visual3D:Documentation:EMG:Processing:Normalize_EMG_to_Generic_Global_Variable|EMG Scale by Global Value]] for details.
  
-=== Events ===+== Events ==
  
 **1. Copy_Events_Between_Files** - Copy Event Labels from the MoCap c3d file into the Analog c3d file. One set of analog signals are collected with the MoCap system at 1000 Hz. One set of analog signals are collected with different software at 1500 Hz (frame 1 is synchronized). Click [[Visual3D:Documentation:Pipeline:Event_Commands:Example_-_Copy_Events_Between_Files|Events:Example 11]] for details. **1. Copy_Events_Between_Files** - Copy Event Labels from the MoCap c3d file into the Analog c3d file. One set of analog signals are collected with the MoCap system at 1000 Hz. One set of analog signals are collected with different software at 1500 Hz (frame 1 is synchronized). Click [[Visual3D:Documentation:Pipeline:Event_Commands:Example_-_Copy_Events_Between_Files|Events:Example 11]] for details.
Line 102: Line 100:
 **4. Number_Events_Sequentially** - This meta-command will rename an event sequentially across files. There are two examples. One that renames an Event_label sequentially and the other example uses this meta-command to find complete cycles across a series of trials. Click [[Visual3D:Documentation:Pipeline:Meta_Commands:Number_Events_Sequentially_Using_a_Meta-Command|Number Events Sequentially Using a Meta-Command]] for details. **4. Number_Events_Sequentially** - This meta-command will rename an event sequentially across files. There are two examples. One that renames an Event_label sequentially and the other example uses this meta-command to find complete cycles across a series of trials. Click [[Visual3D:Documentation:Pipeline:Meta_Commands:Number_Events_Sequentially_Using_a_Meta-Command|Number Events Sequentially Using a Meta-Command]] for details.
  
-=== Metrics ===+== Metrics ==
  
 **1. Concatenate_Gait_Metrics** - This meta-command will create the gait metrics for each TAG, labeling the GLOBAL Metrics folder by this TAG, then concatenated the metrics from all TAGS into one signal and store it in a GLOBAL METRICS folder labelled ALL_TAGS. Click [[Visual3D:Documentation:Pipeline:Meta_Commands:Concatenate_Gait_Metric_Signals_Using_a_Meta-Command|Concatenate Gait Metric Signals Using a Meta-Command]] for details. **1. Concatenate_Gait_Metrics** - This meta-command will create the gait metrics for each TAG, labeling the GLOBAL Metrics folder by this TAG, then concatenated the metrics from all TAGS into one signal and store it in a GLOBAL METRICS folder labelled ALL_TAGS. Click [[Visual3D:Documentation:Pipeline:Meta_Commands:Concatenate_Gait_Metric_Signals_Using_a_Meta-Command|Concatenate Gait Metric Signals Using a Meta-Command]] for details.
Line 108: Line 106:
 **2. Add_Index_Column_To_Metric** - Visual3D cannot plot an array of metric values since the METRIC signals have no time base. This meta-command will create a new column of data containing index numbers, so that we can plot column1 against column2. Essentially it creates an array for the metric signal which will have the additional index column. Click [[|Metrics Example 3]] for details. **2. Add_Index_Column_To_Metric** - Visual3D cannot plot an array of metric values since the METRIC signals have no time base. This meta-command will create a new column of data containing index numbers, so that we can plot column1 against column2. Essentially it creates an array for the metric signal which will have the additional index column. Click [[|Metrics Example 3]] for details.
  
-=== SDSSPP ===+== SDSSPP ==
  
 **1. Create_3DSSPP_Target_Offsets** - This meta-command creates a collection of DERIVED signals that are used for computing the 3DSSPP Planar Angles. This command is used where there is no Linkmodel, and therefore no Landmarks defined. Click [[|Create 3DSSPP Target Offsets]] for details. **1. Create_3DSSPP_Target_Offsets** - This meta-command creates a collection of DERIVED signals that are used for computing the 3DSSPP Planar Angles. This command is used where there is no Linkmodel, and therefore no Landmarks defined. Click [[|Create 3DSSPP Target Offsets]] for details.
Line 116: Line 114:
 '**3. Create_3DSSPP_Origin_Destination_Events** - This meta-command creates Event Labels for the Origin and Destination of the Lift. Each of the three tasks, floor-to-waist, knee-to-waist, waist-to-overhead are processed differently for the event detection. These algorithms are not fool-proof, so it is imperative that the user check the events visually. Click [[|Create_3DSSPP_Origin_Destination_Events]] for details. '**3. Create_3DSSPP_Origin_Destination_Events** - This meta-command creates Event Labels for the Origin and Destination of the Lift. Each of the three tasks, floor-to-waist, knee-to-waist, waist-to-overhead are processed differently for the event detection. These algorithms are not fool-proof, so it is imperative that the user check the events visually. Click [[|Create_3DSSPP_Origin_Destination_Events]] for details.
  
-=== Other ===+== Other ==
  
 **1. Create_Global_Means_For_Left_Right** - Creates a Global_Normalized_Signal_Mean event for left and right sides with common labels (e.g. RHS and LHS). Click [[Visual3D:Documentation:Pipeline:Signal_Commands:Signal_Management_Commands#Meta-Command_-_Create_Global_Means_For_Left_Right|Create_Global_Means_For_Left_Right]] or [[Visual3D:Documentation:Statistics:Create_Mean_Signal|Statistics Example 1]] for details. **1. Create_Global_Means_For_Left_Right** - Creates a Global_Normalized_Signal_Mean event for left and right sides with common labels (e.g. RHS and LHS). Click [[Visual3D:Documentation:Pipeline:Signal_Commands:Signal_Management_Commands#Meta-Command_-_Create_Global_Means_For_Left_Right|Create_Global_Means_For_Left_Right]] or [[Visual3D:Documentation:Statistics:Create_Mean_Signal|Statistics Example 1]] for details.
Line 126: Line 124:
 **4. Add_Sequential_Tags** - Given a set of C3D files opened in the Workspace, TAG files in numerical order regardless of their filenames. The purpose is to have a series of TAGS Trial1, Trial2, Trial 3,,..., etc for reporting. The order of the files is based on their internal order in Visual3D and may appear random to the user. Click [[Visual3D:Documentation:Pipeline:Meta_Commands:Tag_Files_Sequentially_using_a_Meta-Command|Tag Files Sequentially using a Meta-Command]] for details. **4. Add_Sequential_Tags** - Given a set of C3D files opened in the Workspace, TAG files in numerical order regardless of their filenames. The purpose is to have a series of TAGS Trial1, Trial2, Trial 3,,..., etc for reporting. The order of the files is based on their internal order in Visual3D and may appear random to the user. Click [[Visual3D:Documentation:Pipeline:Meta_Commands:Tag_Files_Sequentially_using_a_Meta-Command|Tag Files Sequentially using a Meta-Command]] for details.
  
-**5. Example_Meta** - This is an example of using a meta-command to process differing experimental protocols, models, metrics, and reports. The specifics for each experimental protocol can be passed as meta-command parameters. This could be used to standardize scripts and protocols within a lab. Click [[|Meta Commands Example 3]] for details.+**5. Example_Meta** - This is an example of using a meta-command to process differing experimental protocols, models, metrics, and reports. The specifics for each experimental protocol can be passed as meta-command parameters. This could be used to standardize scripts and protocols within a lab. Click [[Visual3D:Documentation:Pipeline:Meta_Commands:Example_-_Meta_Command_Parameters|Meta Commands Example 3]] for details.
  
 **6. Linear_Regression_Explicit** - This is an example of using a meta-command to perform a linear regression of data that is passed as meta-command parameters. Click [[Visual3D:Documentation:Statistics:Compute_Linear_Regression|Statistics Example 4]] for details. **6. Linear_Regression_Explicit** - This is an example of using a meta-command to perform a linear regression of data that is passed as meta-command parameters. Click [[Visual3D:Documentation:Statistics:Compute_Linear_Regression|Statistics Example 4]] for details.
Line 132: Line 130:
 **7. Linear_Regression_Events** - This is an example of using a meta-command to perform a linear regression between an event range for data that is passed as meta-command parameters. Click [[Visual3D:Documentation:Statistics:Meta_Command_for_Linear_Regression|Statistics Example 5]] for details. **7. Linear_Regression_Events** - This is an example of using a meta-command to perform a linear regression between an event range for data that is passed as meta-command parameters. Click [[Visual3D:Documentation:Statistics:Meta_Command_for_Linear_Regression|Statistics Example 5]] for details.
  
- 
-Retrieved from "" 
  
  
visual3d/documentation/pipeline/meta_commands/meta_commands_overview.1718386047.txt.gz · Last modified: 2024/06/14 17:27 by sgranger