Differences

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

--- visual3d:documentation:pipeline:signal_commands:merge_data [2024/06/19 12:53] – sgranger
+++ visual3d:documentation:pipeline:signal_commands:merge_data [2024/10/15 02:05] (current) – Cleaned up page. Still need to meet Pipeline Command format. wikisysop
@@ Line 1: / Line 1: @@
-{{this command merges data from more than one data name into a single one either by **append_to_end** (appending one signal to the end of another signal) or by **merge_as_new_components** (treat each original signal as a component of the new signal).
+===== Merge Data =====
-|<code>\\ merge_data\\ /signal_types=\\ /signal_folder=\\ /signal_names=\\ ! /component_sequence=\\ ! /result_types=derived\\ ! /result_folders=processed\\ /result_name=\\ ! /merge_type=append_to_end\\ ! /ignore_missing_signals=false\\ ! /pre_clear_result_signal=false\\ ;\\ </code>  |  merge_data.png|
+This command merges data from multiple signals into a single signal in one of two ways:
+  - either via **APPEND_TO_END**, appending one signal to the end of another signal, or
+  - via **MERGE_AS_NEW_COMPONENTS**, treating each original signal as a component of the new signal.
-\\
+<code>
+Merge_Data
+\SIGNAL_TYPES=
+\SIGNAL_FOLDER=
+\SIGNAL_NAMES=
+!\COMPONENT_SEQUENCE=
+!\RESULT_TYPES=DERIVED
+!\RESULT_FOLDERS=PROCESSED
+!\RESULT_NAME=
+!\MERGE_TYPE=APPEND_TO_END
+!\IGNORE_MISSING_SIGNALS=FALSE
+!\PRE_CLEAR_RESULT_SIGNAL=FALSE
+;
+</code>
+{{:Merge_Data.png}}
-===== parameters =====
+==== Parameters ====
-**component_sequence:** if empty, all components of the signals will be used\\
+**COMPONENT_SEQUENCE:** if empty, all components of the signals will be used
-**merge_type:** append_to_end or merge_as_new_components\\
+**MERGE_TYPE:** APPEND_TO_END or MERGE_AS_NEW_COMPONENTS
-append_to_end append one signal to the end of another signal
+  - APPEND_TO_END append one signal to the end of another signal
-merge_as_new_components treat each original signal as a component of the new signal
+  - MERGE_AS_NEW_COMPONENTS treat each original signal as a component of the new signal
-**ignore_missing_signals:**\\
-**pre_clear_result_signal:** will delete the resulting signal prior to beginning\\
+**IGNORE_MISSING_SIGNALS:**
-===== examples =====
+**PRE_CLEAR_RESULT_SIGNAL:** Will delete the resulting signal prior to beginning
-below are two examples for the merge_data command
+==== Examples ====
-==== simple example ====
+Below are some examples for using the Merge_Data command demonstrating both types of merges.
-the command below will create a vector named **vector** from 3 analog signals. this is an example of merging 3 signals into one signal.
+=== Simple Example ===
+The command below will create a vector named **Vector** from 3 analog signals. This is an example of merging 3 signals into one signal.
 <code>
-merge_data
+Merge_Data
-/signal_names=analog1+analog2+analog3
+/SIGNAL_NAMES=Analog1+Analog2+Analog3
-/signal_types=analog+analog+analog
+/SIGNAL_TYPES=ANALOG+ANALOG+ANALOG
-/signal_folder=original+original+original
+/SIGNAL_FOLDER=ORIGINAL+ORIGINAL+ORIGINAL
-/signal_components=0+0+0
+/SIGNAL_COMPONENTS=0+0+0
-/result_name=vector
+/RESULT_NAME=Vector
-/result_type=derived
+/RESULT_TYPE=DERIVED
-/result_folder=processed
+/RESULT_FOLDER=PROCESSED
-/merge_type=merge_as_new_components
+/MERGE_TYPE=MERGE_AS_NEW_COMPONENTS
 ;
 </code>
-==== add a column to a metric ====
+=== Create Global List of all Instances ===
-another example using the merge_data command can be found on the [[|metrics example 3]] page. in this example, the command is used to add an indexing column to a metric (single values). this will allow the metric to be graphed.
-==== merge for ascii export ====
-the example found on [[visual3d:documentation:pipeline:file_commands:export_data_to_ascii_file#example_6:_export_concatenated_metric_signals|export_data_to_ascii_file#example_6:_export_concatenated_metric_signals]] will concatenate metrics signals prior to exporting to an ascii file.
-when exporting, all signals are exported to separate columns in the exported file. for metric signals (e.g. signals with only one or two entries/frames) this can be inconvenient. it is not possible to concatenate the signals in the export command, but it is possible to concatenate the signals explicitly before export.
-==== create global list of all instances ====
 <code>
-select_active_file
+Select_Active_File
-/file_name=all_files
+/FILE_NAME=ALL_FILES
 ;
-merge_data
+Merge_Data
-/signal_types=metric
+/SIGNAL_TYPES=METRIC
-/signal_folder=processed
+/SIGNAL_FOLDER=PROCESSED
-/signal_names=global::list_of_instances+l_ankle_stiffness
+/SIGNAL_NAMES=GLOBAL::List_of_Instances+L_Ankle_Stiffness
-/component_sequence=all
+/COMPONENT_SEQUENCE=ALL
-/result_types=metric
+/RESULT_TYPES=METRIC
-! /result_folders=processed
+! /RESULT_FOLDERS=PROCESSED
-/result_name=global::list_of_instances
+/RESULT_NAME=GLOBAL::List_of_Instances
-! /merge_type=append_to_end
+! /MERGE_TYPE=APPEND_TO_END
-/ignore_missing_signals=false
+/IGNORE_MISSING_SIGNALS=FALSE
-/pre_clear_result_signal=true
+/PRE_CLEAR_RESULT_SIGNAL=TRUE
 ;
 </code>
+=== Add a column to a metric ===
+Another [[Metrics Example 3|example]] adds an indexing column to a metric (single values). This will allow the metric to be graphed.
+=== Merge for ASCII export ===
+The example found on [[Visual3D:Documentation:Pipeline:File_Commands:Export_Data_To_ASCII_File#Example_6:_Export_Concatenated_Metric_Signals|Exporting Concatenated Metric Signals]] will concatenate metrics signals prior to exporting to an ASCII file.
+When exporting, all signals are exported to separate columns in the exported file. For metric signals (e.g. signals with only one or two entries/frames) this can be inconvenient. It is not possible to concatenate the signals in the export command, but it is possible to concatenate the signals explicitly before export.
-}}