HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » metric_commands » Metric Signal Value At Event
visual3d:documentation:pipeline:metric_commands:metric_signal_value_at_event

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
visual3d:documentation:pipeline:metric_commands:metric_signal_value_at_event [2024/06/18 13:32] – sgrangervisual3d:documentation:pipeline:metric_commands:metric_signal_value_at_event [2024/07/17 15:46] (current) – created sgranger
Line 1: Line 1:
-===== Legacy Command =====+====== Metric Signal Value At Event ====== 
 + 
 +==== Legacy Command ====
  
 **Metric_Signal_At_Event** replaced the command **Signal_Value_At_Event** **Metric_Signal_At_Event** replaced the command **Signal_Value_At_Event**
  
-===== Description =====+==== Description ====
  
 The value of the specified signal at the specified frame of data is stored as a metric. The value of the specified signal at the specified frame of data is stored as a metric.
Line 12: Line 14:
   * There is an option to calculate the mean and standard deviation for metrics that have multiple values.   * There is an option to calculate the mean and standard deviation for metrics that have multiple values.
  
-{{MetricSignalValueAtEvent.png}}+{{:MetricSignalValueAtEvent.png}}
  
 |**Metric_Signal_Value_At_Event**                                                         |                                                                                                                                                                         | |**Metric_Signal_Value_At_Event**                                                         |                                                                                                                                                                         |
Line 26: Line 28:
 |**/Retain_No_Data_Values=**                                                              |(True or False) If the result is no_data, retain the value.                                                                                                              | |**/Retain_No_Data_Values=**                                                              |(True or False) If the result is no_data, retain the value.                                                                                                              |
  
-===== Example Value of a Target =====+==== Example Value of a Target ====
  
 This example calculates the value of the TARGET **RFT1** at the Event_Label **RON** This example calculates the value of the TARGET **RFT1** at the Event_Label **RON**
Line 44: Line 46:
 **Note:** In cases where there is **NO_DATA** at an event, you need to specify the parameter **/Retain_No_Data_Values=TRUE** should you want this included in the resulting signal. **Note:** In cases where there is **NO_DATA** at an event, you need to specify the parameter **/Retain_No_Data_Values=TRUE** should you want this included in the resulting signal.
  
-===== Example Time at an Event =====+==== Example Time at an Event ====
  
 This example calculates the time of the Event_Label **RON** This example calculates the time of the Event_Label **RON**
Line 60: Line 62:
 /Retain_No_Data_Values=FALSE /Retain_No_Data_Values=FALSE
 **;** **;**
-===== Component Workaround =====+==== Component Workaround ====
  
 Since Metric_Signal_Value_At_Event outputs all three components, here is a workaround of the previous example that will output one component. Evaluate_Expression is used to create a signal with one component, the z component for **RFT1**. Then the Metric_Signal_Value_At_Event will calculate the value of the TARGET **RFT1** at the Event_Label **RON**. Since Metric_Signal_Value_At_Event outputs all three components, here is a workaround of the previous example that will output one component. Evaluate_Expression is used to create a signal with one component, the z component for **RFT1**. Then the Metric_Signal_Value_At_Event will calculate the value of the TARGET **RFT1** at the Event_Label **RON**.
Line 87: Line 89:
 </code> </code>
  
-===== P2D Signals =====+==== P2D Signals ====
  
 Consider a P2D signal created using [[Visual3D:Documentation:Pipeline:Signal_Commands:Global_Normalized_Signal_Mean|Global_Normalized_Signal_Mean]]. Consider a P2D signal created using [[Visual3D:Documentation:Pipeline:Signal_Commands:Global_Normalized_Signal_Mean|Global_Normalized_Signal_Mean]].
Line 94: Line 96:
 It isn't possible to directly identify the standard deviation at that index because it isn't possible to define an Event for a time normalized signal (e.g.it has no frame rate or time. It isn't possible to directly identify the standard deviation at that index because it isn't possible to define an Event for a time normalized signal (e.g.it has no frame rate or time.
 Without having an event you cannot get the value of a signal at that event using Metric_Signal_Value_At_Event Without having an event you cannot get the value of a signal at that event using Metric_Signal_Value_At_Event
-One solution, albeit a non-intuitive solution is to [[Visual3D:Documentation:Pipeline:Expressions:Overview#Signal_Functions|SORT]] (descending) the p2D signal by the second component (eg. the MEAN).+One solution, albeit a non-intuitive solution is to [[Visual3D:Documentation:Pipeline:Expressions:Expressions_Overview#Signal_Functions|SORT]] (descending) the p2D signal by the second component (eg. the MEAN).
 **Evaluate_Expression** **Evaluate_Expression**
 /EXPRESSION=SORT(P2D::TEST::LHIP_ANGLE, -1.0, 2) /EXPRESSION=SORT(P2D::TEST::LHIP_ANGLE, -1.0, 2)
visual3d/documentation/pipeline/metric_commands/metric_signal_value_at_event.1718717523.txt.gz · Last modified: 2024/06/18 13:32 by sgranger