HAS-Motion Software Documentation

This is an old revision of the document!

---

**metric_maximum** | || |**/result_metric_folder=** |specify folder for the metric || |**/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 || metric_maximum.jpg ===== 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>