Differences

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

--- visual3d:documentation:pipeline:pipeline_commands:for_each_and_end_for_each [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:pipeline_commands:for_each_and_end_for_each [2024/09/03 13:57] (current) – [Command Syntax] wikisysop
@@ Line 1: / Line 1: @@
-executes pipeline commands multiple times for each item in a list of items. it is not identical with a "for loop" or "do loop" in a programming language because the items must be explicitly defined as items in the command. this has some powerful consequences because it means that you can "loop" through disconnected items or strings as easily as using a structured list.
+====== For Each and End For Each ======
-===== command syntax =====
+Executes pipeline commands multiple times for each item in a list of items. It is not identical with a "for loop" or "do loop" in a programming language because the items must be explicitly defined as ITEMS in the command. This has some powerful consequences because it means that you can "loop" through disconnected items or strings as easily as using a structured list.
-**for_each**
+==== Command Syntax ====
-/iteration_parameter_name= index
-!/iteration_parameter_count_name=
-/items= item1+item2+item3
-**;**
-! starting from the for_each command and ending at the end_for_each command
-! the loop is repeated once for each item in the for_each command at each
-! loop index is a pipeline command this is identified as ::index in any other command
-**end_for_each**
-/iteration_parameter_name=index
-**;**
-as of version 5.02.17, a new parameter "iteration_parameter_count_name" count was added. a pipeline parameter name (ex. index_count) can be placed here. any where the parameter index_count is referenced, will return the iteration number (the result will be 1 based, so the first loop through will return 1, and the second will return 2).
-===== example: compute the global mean value of a signal for each of 3 tags =====
+<code>
+For_Each
+/Iteration_Parameter_Name= INDEX
+!/ITERATION_PARAMETER_COUNT_NAME=
+/Items= ITEM1+ITEM2+ITEM3
+;
-this example computes the global mean value of a signal for each of 3 tags (tag1, tag2, tag3) and adds the tag name to the global signal names that are created.
+! Starting from the For_Each command and ending at the End_For_Each command
+! the loop is repeated once for each item in the For_Each command at each
+! loop INDEX is a pipeline command this is identified as ::INDEX in any other command
+End_For_Each
+/Iteration_Parameter_Name=INDEX
+;
+</code>
+As of version 5.02.17, a new parameter "ITERATION_PARAMETER_COUNT_NAME" count was added. A pipeline parameter name (ex. INDEX_COUNT) can be placed here. Any where the parameter INDEX_COUNT is referenced, will return the iteration number (the result will be 1 based, so the first loop through will return 1, and the second will return 2).
+==== Example: Compute the GLOBAL mean value of a signal for each of 3 tags ====
+This example computes the GLOBAL mean value of a signal for each of 3 tags (TAG1, TAG2, TAG3) and adds the TAG name to the GLOBAL signal names that are created.
 <code>
-for_each
+For_Each
-/iteration_parameter_name= tag_names
+/Iteration_Parameter_Name= TAG_NAMES
-/items= tag1+tag2+tag3
+/Items= TAG1+TAG2+TAG3
 ;
-select_active_file
+Select_Active_File
-/file_name= ::tag_names
+/File_Name= ::TAG_NAMES
 ;
-metric_mean
+Metric_Mean
-/result_metric_name=_&::tag_names
+/RESULT_METRIC_NAME=_&::TAG_NAMES
-/apply_as_suffix_to_signal_name=true
+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/signal_types=target
+/SIGNAL_TYPES=TARGET
-! /signal_names=
+! /SIGNAL_NAMES=
-! /signal_folder=original
+! /SIGNAL_FOLDER=ORIGINAL
-! /signal_components=all_components
+! /SIGNAL_COMPONENTS=ALL_COMPONENTS
-! /component_sequence=
+! /COMPONENT_SEQUENCE=
-/event_sequence=
+/EVENT_SEQUENCE=
-/exclude_events=
+/EXCLUDE_EVENTS=
-! /generate_mean_and_stddev=true
+! /GENERATE_MEAN_AND_STDDEV=TRUE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
 ;
-end_for_each
+End_For_Each
-/iteration_parameter_name=tag_names
+/Iteration_Parameter_Name=TAG_NAMES
 ;
 </code>
-===== example: implementing a while loop =====
+==== Example: Implementing a while loop ====
-visual3d doesn't have a while command, so there is no option but to use a kludge. you will need to set the option to make visual3d stop processing the pipeline on the first error. the visual 3d solution for the following algorithm can be found on [[|example: implementing a //while// loop]].
+Visual3D doesn't have a WHILE command, so there is no option but to use a kludge. You will need to set the option to make Visual3D stop processing the pipeline on the first error. The Visual 3D solution for the following algorithm can be found on [[|Example: Implementing a //while// loop]].
-variable blncontinue = true
+<code>
-**while** continue = true
+Variable blnContinue = true
-prompt user for variable blncontinue (true or false)
+While Continue = true
-filecounter = filecounter +1
+Prompt user for variable blnContinue (true or false)
+FileCounter = FileCounter +1
 [load and process another file (e.g. filename_filecounter)]
-**end while**
+End while
-===== example: processing many files =====
+</code>
+==== Example: Processing many files ====
-first create a pipeline parameter that contains all of the filenames selected (e.g. all files that have the same tag) concatenated into a string.
+First create a pipeline parameter that contains all of the filenames selected (e.g. all files that have the same TAG) concatenated into a string.
 <code>
-set_pipeline_parameter_to_list_of_tagged_files
+Set_Pipeline_Parameter_To_List_Of_Tagged_Files
-/parameter_name=filenames
+/PARAMETER_NAME=FILENAMES
-/tag_name= all_males
+/TAG_NAME= ALL_MALES
-! /get_current_selected_files= false
+! /GET_CURRENT_SELECTED_FILES= false
-! /use_short_filenames= false
+! /USE_SHORT_FILENAMES= false
 ;
-! now set up the for each loop using this string
+! Now set up the for each loop using this string
-for_each
+For_Each
-/iteration_parameter_name= index
+/ITERATION_PARAMETER_NAME= INDEX
-/items= ::filenames
+/ITEMS= ::FILENAMES
 ;
-! put any command that you like into this location
+! Put any command that you like into this location
-end_for_each
+End_For_Each
-/iteration_parameter_name= index
+/ITERATION_PARAMETER_NAME= INDEX
 ;
 </code>
-! **note:** filenames do not have to be in any sequence or have any special naming convention.
+! **NOTE:** Filenames do not have to be in any sequence or have any special naming convention.
-===== exporting multiple files =====
+==== Exporting multiple files ====
-using [[#export_data_to_ascii_file|export_data_to_ascii_file]] to export data from individual c3d files to unique text files.
+Using [[#Export_Data_to_ASCII_File|Export_Data_to_ASCII_File]] to export data from individual C3D files to unique text files.
-[[visual3d:documentation:pipeline:file_commands:export_data_to_ascii_file#example_1:_file_export_of_multiple_files|export_data_to_ascii_file#example_1:_file_export_of_multiple_files]]
+[[Visual3D:Documentation:Pipeline:File_Commands:Export_Data_To_ASCII_File#Example_1:_File_Export_of_multiple_files|Export_Data_To_ASCII_File#Example_1:_File_Export_of_multiple_files]]
-[[visual3d:documentation:pipeline:file_commands:export_data_to_ascii_file#example_2:_file_export_of_multiple_files|export_data_to_ascii_file#example_2:_file_export_of_multiple_files]]
+[[Visual3D:Documentation:Pipeline:File_Commands:Export_Data_To_ASCII_File#Example_2:_File_Export_of_multiple_files|Export_Data_To_ASCII_File#Example_2:_File_Export_of_multiple_files]]