HAS-Motion Software Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Metric Maximum ======

=====Overview====
The **Metric Maximum** command computes the Maximum Value of a Signal and stores the value as a metric. This can be useful during event definition and when looking at movements like jumps where values like maximum height are relevant. The command can be found in the **Pipeline Workshop** under **Metric**.

=====Pipeline Command=====
The command syntax, found in the Pipeline Workshop is as so:

<code>
Metric_Maximum
! /RESULT_METRIC_FOLDER=PROCESSED
/RESULT_METRIC_NAME=
! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
/SIGNAL_TYPES=
! /SIGNAL_FOLDER=ORIGINAL
! /SIGNAL_NAMES=
! /COMPONENT_SEQUENCE=
/EVENT_SEQUENCE=
/EXCLUDE_EVENTS=
! /GENERATE_MEAN_AND_STDDEV=TRUE
! /GENERATE_MEAN_AND_STDDEV_ACROSS_SUBJECTS=FALSE
! /APPEND_TO_EXISTING_VALUES=FALSE
! /CREATE_GLOBAL_MAXIMUM=FALSE
! /CREATE_TRIAL_MAXIMUM=FALSE
;
</code>

=====Command Parameters=====

The Parameters for the function are as follows:
                                                                                                                                                                                                                                                        
|**RESULT_METRIC_FOLDER**                                                                               |Name of the folder holding results|                                                                                                                                                                                                                             
|**RESULT_METRIC_NAME**                                                                               |Name of the resulting metric|                                                                                                                                                                                                                                  
|**APPLY_AS_SUFFIX_TO_SIGNAL_NAME**                                                                   |Specify the metric name to be the ORIGINAL signal plus a SUFFIX|                                                                                                                                                                                               
|**SIGNAL_TYPES**                                                                                     |Specify the signal type|                                                                                                                                                                                                                                       
|**SIGNAL_FOLDER**                                                                                    |Specify the signal folder|                                                                                                                                                                                                                                     
|**SIGNAL_NAMES**                                                                                     |Specify the Signal to be used|                                                                                                                                                                                                                                 
|**SIGNAL_COMPONENTS**                                                                                |Specify the Signal components to be used (e.g. X, Y, Z or 0, 1, 2 etc)|                                                                                                                                                                                        
|**[[Visual3D:Documentation:Pipeline:General_Information:COMPONENT_SEQUENCE|COMPONENT_SEQUENCE]]**    |Specify the Signal components to be used (e.g. X + Y + Z or 0 + 1 + 2 etc)|                                                                                                                                                                                    
|**[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Sequence|EVENT_SEQUENCE]]**  |Specify the sequence of Events. Any number of Events can be entered (separated by +). This specific sequence of events must be true for a metric to be computed. The metric is computed from the first event in the sequence to the last event in the sequence|
|**[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Exclude_Events|EXCLUDE_EVENTS]]**  |If this event occurs before the first and last event, do not computed a metric|                                                                                                                                                                            
|**[[Visual3D:Documentation:Pipeline:Metric_Commands:SEQUENCE_PERCENT_START|SEQUENCE_PERCENT_START]]**|Within the event sequence specify the beginning of the range as a percent|                                                                                                                                                                                     
|**[[Visual3D:Documentation:Pipeline:Metric_Commands:SEQUENCE_PERCENT_START|SEQUENCE_PERCENT_END]]**|Within the event sequence specify the end of the range as a percent|                                                                                                                                                                                           
|**GENERATE_MEAN_AND_STDDEV**|Generate the mean and standard deviation of this metric across ranges and files|                                                                                                                                                                             
|**APPEND_TO_EXISTING_VALUES**|Do not Add these metric values to an existing metric|                                                                                                                                                                                                        
|**CREATE_GLOBAL_MAXIMUM**|Create a metric in the GLOBAL Workspace containing the maximum of the maximums|                                                                                                                                                                               


====Dialog====

The command can be edited in a text editor or in a dialog form. To edit in the dialog pop up form either click on the Edit button in the pipeline workshop or double-click on the pipeline command. The dialog is shown below.

{{:Metric_Maximum.jpg}}

The dialog box allows you to assign values to the command parameters outlined above.

==== Examples ====

In the following example, compute the Maximum Value of the derived signal **HANDSPEED** between the events **FRAME1** and **GO**, with any range containing the Event **SPEED_CHANGE** being ignored.

<code>
Metric_Maximum      
/RESULT_METRIC_NAME=_MEAN
/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
/RESULT_METRIC_FOLDER=PROCESSED 
/SIGNAL_TYPES=DERIVED   
/SIGNAL_NAMES=HANDSPEED
/SIGNAL_FOLDER=PROCESSED    
/SIGNAL_COMPONENTS=ALL_COMPONENTS
/EVENT_SEQUENCE=FRAME1 + GO
/EXCLUDE_EVENTS=SPEED_CHANGE
/GENERATE_MEAN_AND_STDDEV=TRUE
/APPEND_TO_EXISTING_VALUES=FALSE
! /CREATE_GLOBAL_MAXIMUM=FALSE
;
</code>