Differences

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

--- visual3d:documentation:pipeline:signal_commands:set_data_to_new_values [2024/06/19 12:53] – sgranger
+++ visual3d:documentation:pipeline:signal_commands:set_data_to_new_values [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{{{{{this command replaces the following commands:
+====== Set Data To New Values ======
-set_frames_to_zero\\
+This command replaces the following commands:
-set_frames_to_new_values\\
+Set_Frames_To_Zero\\
+Set_Frames_To_New_Values\\
@@ Line 8: / Line 10: @@
-===== pipeline command =====
+==== Pipeline Command ====
-|**set_data_to_new_values**                                                                           |                                                                      |
+|**Set_Data_To_New_Values**                                                                           |                                                                      |
-|**/signal_types=**                                                                                   |the type of signal to be processed                                    |
+|**/SIGNAL_TYPES=**                                                                                   |The type of signal to be processed                                    |
-|**/signal_names=**                                                                                   |the names of the signals to be processed                              |
+|**/SIGNAL_NAMES=**                                                                                   |The names of the signals to be processed                              |
-|**/signal_folder=**                                                                                  |the name of the signal folder                                         |
+|**/SIGNAL_FOLDER=**                                                                                  |The name of the signal folder                                         |
-|**/signal_components=**                                                                              |the signal components to be modified                                  |
+|**/SIGNAL_COMPONENTS=**                                                                              |The signal components to be modified                                  |
-|**/result_suffix=**                                                                                  |optional suffix to add to the result name                             |
+|**/RESULT_SUFFIX=**                                                                                  |Optional Suffix to Add to the Result Name                             |
-|**/result_folder=**                                                                                  |the folder for the results                                            |
+|**/RESULT_FOLDER=**                                                                                  |The Folder for the Results                                            |
-|**/start_frame=\**                                                                                   |start frame                                                           |
+|**/START_FRAME=\**                                                                                   |Start Frame                                                           |
-|**/end_frame=**                                                                                      |end frame                                                             |
+|**/END_FRAME=**                                                                                      |End Frame                                                             |
-|**/[[visual3d:documentation:c3d_signal_types:event_label_data_type#event_sequence|event_sequence]]=**|a list of events (separated by "+" signs). for example, lhs+rto       |
+|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Sequence|EVENT_SEQUENCE]]=**|A list of events (separated by "+" signs). For example, LHS+RTO       |
-|**/[[visual3d:documentation:c3d_signal_types:event_label_data_type#exclude_events|exclude_events]]=**|exclude sequences containing these events.                            |
+|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Exclude_Events|EXCLUDE_EVENTS]]=**|Exclude Sequences containing these Events.                            |
-|**/use_point_rate=**                                                                                 |(true or false) explicitly uses the motion capture point rate.        |
+|**/USE_POINT_RATE=**                                                                                 |(true or false) Explicitly uses the motion capture point rate.        |
-|**/replacement_values=**                                                                             |the new signal value at each frame                                    |
+|**/REPLACEMENT_VALUES=**                                                                             |The new signal value at each frame                                    |
-|**/threshold_high=**                                                                                 |optional. replace only if signal values is greater that this threshold|
+|**/THRESHOLD_HIGH=**                                                                                 |Optional. Replace only if signal values is greater that this threshold|
-|                                                                                                     |default=data_not_found                                                |
+|                                                                                                     |default=DATA_NOT_FOUND                                                |
-|**/threshold_low=**                                                                                  |optional. replace only if signal values is greater that this threshold|
+|**/THRESHOLD_LOW=**                                                                                  |Optional. Replace only if signal values is greater that this threshold|
-|                                                                                                     |default=data_not_found                                                |
+|                                                                                                     |default=DATA_NOT_FOUND                                                |
 **;**
-set the frames of data from start_frame to end_frame and/or from start event to end event.
+Set the frames of data from start_frame to end_frame and/or from Start Event to End Event.
-if a target signal is set to data_not_found, all components of the signal are set to data_not_found.
+If a TARGET signal is set to DATA_NOT_FOUND, all components of the signal are set to DATA_NOT_FOUND.
-**replacement_value, threshold_high, and threshold_low** can be expressions
+**Replacement_Value, Threshold_High, and Threshold_Low** can be Expressions
-===== example: using a metric values as the low threshold =====
+==== Example: Using a Metric values as the low threshold ====
-set_data_to_new_values_example_dlg.jpg
+{{:Set_Data_To_New_Values_Example_Dlg.jpg}}
-this example could use an expression instead of simply a metric value
+This example could use an expression instead of simply a metric value
-set_data_to_new_values_example_dlg2.jpg
+{{:Set_Data_To_New_Values_Example_Dlg2.jpg}}
 \\
-===== example: change missing data to zero =====
+==== Example: Change missing data to zero ====
-visual3d has a special number which we refer to as data_not_found.
+Visual3D has a special number which we refer to as DATA_NOT_FOUND.
-the actual value used internally is -999999
+The actual value used internally is -999999
-the following command properties will change every occurrence of data_not_found to 0
+The following command properties will change every occurrence of DATA_NOT_FOUND to 0
 \\
-set_data_to_new_values_3.jpg
+{{:Set_Data_To_New_Values_3.jpg}}
-}}}}}}