Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_signal_value_at_event [2025/05/21 17:36] – Cleaned up page for a customer. Still needs to be put into Pipeline project format. wikisysop
+++ visual3d:documentation:pipeline:metric_commands:metric_signal_value_at_event [2025/09/18 19:32] (current) – wikisysop
@@ Line 1: / Line 1: @@
 ====== Metric Signal Value At Event ======
-The Metric_Signal_Value_At_Event command provides the value of the specified signal at the specified frame of data is stored as a metric.
+====Overview====
+The Metric_Signal_Value_At_Event command provides the value of the specified signal at the specified frame of data is stored as a metric. It can be found in the **Pipeline Workshop** under **Metric**. This command is useful for recording the value of a signal at a specific moment in a sequence, like at the deepest point in a squat or foot on in a stride.
 Notes:
@@ Line 10: / Line 12: @@
   * **Metric_Signal_At_Event** replaced the legacy command **Signal_Value_At_Event**
-{{:MetricSignalValueAtEvent.png}}
+====Pipeline Command====
+The syntax for the function is as follows:
-===== Parameters =====
+<code>
+Metric_Signal_Value_At_Event
+/SIGNAL_TYPES=
+! /SIGNAL_FOLDER=ORIGINAL
+! /SIGNAL_NAMES=
+! /RESULT_METRIC_FOLDER=PROCESSED
+/RESULT_METRIC_NAME=
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
+! /SIGNAL_COMPONENTS=
+! /COMPONENT_SEQUENCE=
+/EVENT_NAME=
+! /EVENT_INSTANCE=0
+! /SCALE_FACTORS=1
+! /GENERATE_GLOBAL_MEAN_AND_STDDEV=TRUE
+! /GENERATE_LOCAL_MEAN_AND_STDDEV=TRUE
+! /APPEND_TO_EXISTING_VALUES=FALSE
+! /GENERATE_VECTOR_LENGTH_METRIC=FALSE
+! /RETAIN_NO_DATA_VALUES=FALSE
+;
+</code>
+=====Command Parameters =====
+The pipeline command parameters shown above are described in the table below:
-^ Parameter ^ Description ^
 |**/Result_Metric_Name=**                                                                 |The name of the resulting signal.                                                                                                                                        |
 |**/Result_Metric_Folder=**                                                               |The folder that will contain the resulting signal                                                                                                                        |
@@ Line 24: / Line 49: @@
 |**/Append_To_Existing_Values=**                                                          |(True or False) If the metric exists, the new values will be appended to the metric, retaining all of the previous values.                                               |
 |**/Generate_Metric_Length_Metric=**                                                      |(True or False) If the metric is a vector quantity (e.g. has 3 components), compute the magnitude of the vector.                                                         |
-|**/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.                                                                           |
+====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.
+{{:MetricSignalValueAtEvent.png}}
+The dialog box allows you to assign values to the command parameters outlined above.
 ===== Example: Find Value of a Target =====