Differences

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

--- visual3d:documentation:statistics:create_mean_signal [2024/06/19 12:53] – sgranger
+++ visual3d:documentation:statistics:create_mean_signal [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{{{{{{{||
+====== Create Mean Signal ======
-this example will time normalize a signal (in this case knee flexion angle) between events (**rhs** to **rhs**) for right knee angles and (**lhs** to **lhs**) for left knee angles, and compute a **global** mean and standard deviation. a meta-command will be used.
+||
+This example will time normalize a signal (in this case Knee Flexion Angle) between events (**RHS** to **RHS**) for Right Knee angles and (**LHS** to **LHS**) for Left Knee angles, and compute a **GLOBAL** mean and Standard Deviation. A meta-command will be used.
 \\
-add the **global_normalized_signal_mean** command to the pipeline. double click on the command to launch the dialog.
+Add the **Global_Normalized_Signal_Mean** command to the pipeline. Double click on the command to launch the dialog.
-gnsm1.jpg
+{{:GNSM1.jpg}}
-select the **rknee_angle** signal and the event sequence (e.g **rhs** to **rhs**) and select add a new signal
+Select the **RKNEE_ANGLE** Signal and the event sequence (e.g **RHS** to **RHS**) and select Add A New Signal
-gnsm2.jpg
+{{:GNSM2.jpg}}
-select the **lknee_angle** signal and the event sequence (e.g **lhs** to **lhs**) and select add a new signal
+Select the **LKNEE_ANGLE** Signal and the event sequence (e.g **LHS** to **LHS**) and select Add A New Signal
-gnsm3.jpg
+{{:GNSM3.jpg}}
-enter in the **p2d result signal name** and the select **create standard deviation button**
+Enter in the **P2D Result Signal Name** and the select **Create Standard Deviation Button**
-gnsm4.jpg
+{{:GNSM4.jpg}}
-when you select **ok** the text representation of the command should be as follows:
+When you select **OK** the text representation of the command should be as follows:
 <code>
-global_normalized_signal_mean
+Global_Normalized_Signal_Mean
-/signal_types=link_model_based+link_model_based
+/SIGNAL_TYPES=LINK_MODEL_BASED+LINK_MODEL_BASED
-/signal_names=rknee_angle+lknee_angle
+/SIGNAL_NAMES=RKNEE_ANGLE+LKNEE_ANGLE
-/signal_folder=original+original
+/SIGNAL_FOLDER=ORIGINAL+ORIGINAL
-/signal_components=x+x
+/SIGNAL_COMPONENTS=X+X
-/start_label=
+/START_LABEL=
-/end_label=
+/END_LABEL=
-/event_sequence= rhs+rhs++lhs+lhs
+/EVENT_SEQUENCE= RHS+RHS++LHS+LHS
-! /exclude_events=
+! /EXCLUDE_EVENTS=
-/result_name=knee_flexion
+/RESULT_NAME=KNEE_FLEXION
-! /result_folder=original
+! /RESULT_FOLDER=ORIGINAL
-/normalize_points=101
+/NORMALIZE_POINTS=101
-/create_standard_deviation=true
+/CREATE_STANDARD_DEVIATION=TRUE
-! /calculate_per_file=false
+! /CALCULATE_PER_FILE=FALSE
 ;
 </code>
-**note:** if **calculate_per_file=false**. signals from all active files are used to compute the mean
+**Note:** If **CALCULATE_PER_FILE=FALSE**. Signals from all active files are used to compute the mean
-**note:** if **calculate_per_file=true**. the mean value is computed for signals from each active files. the global mean value is then the mean value of the mean values.
+**Note:** If **CALCULATE_PER_FILE=TRUE**. The mean value is computed for Signals from each active files. The global mean value is then the mean value of the mean values.
-**note:** that the output signal is a p2d signal, which is associated with every file. the resulting signal, therefore, is stored in the **global_workpace**
+**Note:** That the Output signal is a P2D Signal, which is associated with every file. The resulting signal, therefore, is stored in the **GLOBAL_WORKPACE**
 \\
-the meta-command **create_global_means_for_left_right** will be used for processing all 3 components of a number of model based signals using one pipeline command. let the original cmo file contain the following signals:
+The Meta-Command **Create_Global_Means_For_Left_Right** will be used for processing all 3 components of a number of model based signals using one pipeline command. Let the original cmo file contain the following signals:
-rankle_angle
+RANKLE_ANGLE
-rknee_angle
+RKNEE_ANGLE
-rhip_angle
+RHIP_ANGLE
-lankle_angle
+LANKLE_ANGLE
-lknee_angle
+LKNEE_ANGLE
-lhip_angle
+LHIP_ANGLE
-let the events for heel strike be labeled **lhs** and **rhs** and that mean signal should be computed from heel strike to heel strike.
+Let the events for heel strike be labeled **LHS** and **RHS** and that mean signal should be computed from heel strike to heel strike.
 \\
-the pipeline script for the **create_global_means_for_left_right** meta-command is below:
+The Pipeline script for the **Create_Global_Means_For_Left_Right** meta-command is below:
 <code>
-create_global_means_for_left_right
+Create_Global_Means_For_Left_Right
-/type=angle
+/TYPE=ANGLE
-/joints=ankle+knee+hip
+/JOINTS=ANKLE+KNEE+HIP
-/start_event=hs
+/START_EVENT=HS
-/end_event=hs
+/END_EVENT=HS
 ;
 </code>
-the following should be cut and pasted into the **create_global_means_for_left_right.v3m** meta_command folder which should be placed within the plugins folder.
+The following should be cut and pasted into the **Create_Global_Means_For_Left_Right.v3m** Meta_Command folder which should be placed within the Plugins folder.
 <code>
-! begin_meta
+! BEGIN_META
-! meta_cmd_name=create_global_means_for_left_right
+! META_CMD_NAME=Create_Global_Means_For_Left_Right
-! meta_param=    type  :   string ::yes
+! META_PARAM=    TYPE  :   string ::yes
-! meta_param=    joints  :   string ::yes
+! META_PARAM=    JOINTS  :   string ::yes
-! meta_param=    start_event  :   string ::yes
+! META_PARAM=    START_EVENT  :   string ::yes
-! meta_param=    end_event  :   string ::yes
+! META_PARAM=    END_EVENT  :   string ::yes
-! end_meta
+! END_META
-! create a global_normalized_signal_mean event for left and right
+! Create a Global_Normalized_Signal_Mean event for left and right
-! sides with common labels (e.g. rhs and lhs)
+! sides with common labels (e.g. RHS and LHS)
-for_each
+For_Each
-/iteration_parameter_name=index1
+/ITERATION_PARAMETER_NAME=INDEX1
-/items=::joints
+/ITEMS=::JOINTS
 ;
-for_each
+For_Each
-/iteration_parameter_name=index2
+/ITERATION_PARAMETER_NAME=INDEX2
-/items=x+y+z
+/ITEMS=X+Y+Z
 ;
-global_normalized_signal_mean
+Global_Normalized_Signal_Mean
-/signal_types=link_model_based+link_model_based
+/SIGNAL_TYPES=LINK_MODEL_BASED+LINK_MODEL_BASED
-/signal_names=r&::index1&_&::type+l&::index1&_&::type
+/SIGNAL_NAMES=R&::INDEX1&_&::TYPE+L&::INDEX1&_&::TYPE
-/signal_folder=original+original
+/SIGNAL_FOLDER=ORIGINAL+ORIGINAL
-/signal_components=::index2+::index2
+/SIGNAL_COMPONENTS=::INDEX2+::INDEX2
-/start_label=r&::start_event+l&::end_event
+/START_LABEL=R&::START_EVENT+L&::END_EVENT
-/end_label=r&::start_event+l&::end_event
+/END_LABEL=R&::START_EVENT+L&::END_EVENT
-! /event_sequence=
+! /EVENT_SEQUENCE=
-! /exclude_events=
+! /EXCLUDE_EVENTS=
-/result_name=::index1&_&::type&_&::index2
+/RESULT_NAME=::INDEX1&_&::TYPE&_&::INDEX2
-! /result_folder=original
+! /RESULT_FOLDER=ORIGINAL
-! /normalize_points=101
+! /NORMALIZE_POINTS=101
-! /create_standard_deviation=false
+! /CREATE_STANDARD_DEVIATION=FALSE
-! /calculate_per_file=false
+! /CALCULATE_PER_FILE=FALSE
 ;
-end_for_each
+End_For_Each
-/iteration_parameter_name=index2
+/ITERATION_PARAMETER_NAME=INDEX2
 ;
-end_for_each
+End_For_Each
-/iteration_parameter_name=index1
+/ITERATION_PARAMETER_NAME=INDEX1
 ;
 </code>
-}}}}}}}}