Differences

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

--- visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter [2026/02/04 20:48] (current) – wikisysop
@@ Line 1: / Line 1: @@
-pipeline parameters can be created in the pipeline and used as variables in other commands in the same pipeline.
+====== Set Pipeline Parameter ======
+This command can be used to set the value of a pipeline parameter to a specified value as defined by the user. Also see [[visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter_to_data_value|Set Pipeline Parameter to Data Value]] and [[visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter_from_expression|Set Pipeline Parameter from Expression]] for other options to define pipeline parameter values.
-|**set_pipeline_parameter**        |                                                                                                                                                                                                                                                                                                                                                           | | |
+====Pipeline command====
-|**/parameter_name=**              |the name of the pipeline parameter. the parameter is referred to by other commands using two colons (::) in front of the parameter name                                                                                                                                                                                                                    | | |
+This command can be found in the Pipeline Workshop within the Pipeline Control folder as shown below:
-|**/parameter_value=**             |the value of the parameter. if a "+" delimeter is used in the value, the text string is maintained so that the pipeline parameter is interpreted as multiple values when used in a command. if a "+" delimeter is used in the value, the entries in the line are concatenated, and will be treated as a single value when they are used in another command.| | |
+<code>
-|**/parameter_value_search_for=**  |                                                                                                                                                                                                                                                                                                                                                           | | |
+Set_Pipeline_Parameter
-|**/parameter_value_replace_with=**|a string of characters that will replace the "search for" string. this can be useful if you want to replace some of the terms within an existing global parameter value                                                                                                                                                                                    | | |
+/PARAMETER_NAME=
-|**/multi_pass=**                  |false                                                                                                                                                                                                                                                                                                                                                      |-|;|
+/PARAMETER_VALUE=
+! /PARAMETER_VALUE_SEARCH_FOR=
+! /PARAMETER_VALUE_REPLACE_WITH=
+! /PARAMETER_VALUE_PREFIX=
+! /PARAMETER_VALUE_APPEND=
+! /MULTI_PASS=FALSE
+;
+</code>
+====Command Parameters====
+The following table shows the command parameters that can be used to define the command and their descriptions:
+|**Parameter**   |**Description**|
+|**Parameter Name**|The name of the Pipeline Parameter. The parameter is referred to by other commands using two colons (::) in front of the parameter name|
+|**Parameter Value**|The value of the parameter. If a "+" delimeter is used in the value, the text string is maintained so that the Pipeline parameter is interpreted as multiple values when used in a command. If a "+" delimeter is used in the value, the entries in the line are concatenated, and will be treated as a single value when they are used in another command.|
+|**Parameter Value Search For**|Search for parameters with this value|
+|**Parameter Value Replace With**|Replace the searched for value with this value|
+|**Multi Pass**|True or False: |
-===== example: set pipeline values via search and replace =====
+==== Example: Set Pipeline Values via Search and Replace ====
-this example sets pipeline parameters and new values via search and replace. the pipeline parameter **original** and the string value **replacethexxxx**, is set to the pipeline parameter **newparameter** and replaced with the string **replacethezzzz**.
+This example sets pipeline parameters and new values via search and replace. The pipeline parameter **original** and the string value **replacethexxxx**, is set to the pipeline parameter **newparameter** and replaced with the string **replacethezzzz**.
 <code>
-!set the pipeline parameter original to the value replacethexxxx
+!Set the Pipeline parameter original to the value replacethexxxx
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=original
+/PARAMETER_NAME=original
-/parameter_value=replacethexxxx
+/PARAMETER_VALUE=replacethexxxx
 ;
-! set the pipeline parameter newparameter to a new value replacethezzzz by replacing
+! Set the Pipeline parameter newparameter to a new value replacethezzzz by replacing
 ! part of the string zzzz for xxxx
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=newparameter
+/PARAMETER_NAME=newparameter
-/parameter_value=replacethexxxx
+/PARAMETER_VALUE=replacethexxxx
-/parameter_value_search_for=xxxx
+/PARAMETER_VALUE_SEARCH_FOR=xxxx
-/parameter_value_replace_with=zzzz
+/PARAMETER_VALUE_REPLACE_WITH=zzzz
 ;
 </code>
-===== example: set pipeline parameter value to a string =====
+==== Example: Set Pipeline Parameter Value to a String ====
-for example, the following command creates a global parameter **signals** which contains the string **rightfoot1+rightfoot2+rightfoot3**. a low pass filter is run on the pipeline parameter **signals**.
+For example, the following command creates a global parameter **SIGNALS** which contains the string **RightFoot1+RightFoot2+RightFoot3**. A low pass filter is run on the pipeline parameter **SIGNALS**.
 <code>
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=signals
+/Parameter_Name=SIGNALS
-/parameter_value=rightfoot1+rightfoot2+rightfoot3
+/Parameter_Value=RightFoot1+RightFoot2+RightFoot3
 ;
-! all three signals will be processed with low pass filter
+! All three signals will be processed with low pass filter
-lowpass_filter
+Lowpass_Filter
-/signal_types=original+original+original
+/Signal_Types=ORIGINAL+ORIGINAL+ORIGINAL
-/signal_names=::signals
+/Signal_Names=::SIGNALS
 ;
 </code>
-===== example: search and replace + sign =====
+==== Example: Search and Replace + Sign ====
-the plus sign typically indicates different a list of values, but sometimes a user may want to search and replace a plus sign. this is allowed if the user types \+. an example is below:
+The plus sign typically indicates different a list of values, but sometimes a user may want to search and replace a plus sign. This is allowed if the user types \+. An example is below:
 <code>
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=test
+/PARAMETER_NAME=TEST
-/parameter_value=a + b
+/PARAMETER_VALUE=A + B
-/parameter_value_search_for=\+
+/PARAMETER_VALUE_SEARCH_FOR=\+
-/parameter_value_replace_with=-
+/PARAMETER_VALUE_REPLACE_WITH=-
 ;
 </code>
-**result: ::test = a - b**
+**Result: ::TEST = A - B**
 <code>
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=test
+/PARAMETER_NAME=TEST
-/parameter_value= a - b
+/PARAMETER_VALUE= A - B
-/parameter_value_search_for=-
+/PARAMETER_VALUE_SEARCH_FOR=-
-/parameter_value_replace_with=\+
+/PARAMETER_VALUE_REPLACE_WITH=\+
 ;
 </code>
-**result: ::test = a + b**
+**Result: ::TEST = A + B**
-===== example: set pipeline parameter multi-pass =====
+==== Example: Set Pipeline Parameter Multi-Pass ====
-multipass was introduced january 21, 2014
+MultiPass was introduced january 21, 2014
-the resulting parameter could be a new pipeline parameter
+The resulting parameter could be a new pipeline parameter
-for example, the resulting string could be ::value
+for example, the resulting string could be ::VALUE
-if multipass were true, this should return the value of the parameter value not the string ::value
+If MultiPass were true, this should return the value of the parameter VALUE not the string ::VALUE
 example:
 <code>
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=test
+/PARAMETER_NAME=TEST
-/parameter_value=scott
+/PARAMETER_VALUE=SCOTT
-! /parameter_value_search_for=
+! /PARAMETER_VALUE_SEARCH_FOR=
-! /parameter_value_replace_with=
+! /PARAMETER_VALUE_REPLACE_WITH=
-! /parameter_value_prefix=
+! /PARAMETER_VALUE_PREFIX=
-! /parameter_value_append=
+! /PARAMETER_VALUE_APPEND=
 ;
 </code>
-pipeline parameter : ::test = scott
+Pipeline Parameter : ::TEST = SCOTT
 <code>
@@ Line 100: / Line 118: @@
 <code>
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=one
+/PARAMETER_NAME=ONE
-/parameter_value=keith
+/PARAMETER_VALUE=KEITH
-! /parameter_value_search_for=
+! /PARAMETER_VALUE_SEARCH_FOR=
-! /parameter_value_replace_with=
+! /PARAMETER_VALUE_REPLACE_WITH=
-! /parameter_value_prefix=
+! /PARAMETER_VALUE_PREFIX=
-! /parameter_value_append=
+! /PARAMETER_VALUE_APPEND=
 ;
 </code>
-pipeline parameter : ::one = keith
+Pipeline Parameter : ::ONE = KEITH
 <code>
@@ Line 117: / Line 135: @@
 <code>
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=scottkeith
+/PARAMETER_NAME=SCOTTKEITH
-/parameter_value=7
+/PARAMETER_VALUE=7
-! /parameter_value_search_for=
+! /PARAMETER_VALUE_SEARCH_FOR=
-! /parameter_value_replace_with=
+! /PARAMETER_VALUE_REPLACE_WITH=
-! /parameter_value_prefix=
+! /PARAMETER_VALUE_PREFIX=
-! /parameter_value_append=
+! /PARAMETER_VALUE_APPEND=
 ;
 </code>
-pipeline parameter : ::scottkeith = 7
+Pipeline Parameter : ::SCOTTKEITH = 7
 <code>
@@ Line 133: / Line 151: @@
 </code>
-if we set multi_pass= false
+if we set MULTI_PASS= FALSE
 <code>
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=final
+/PARAMETER_NAME=FINAL
-/parameter_value=::scottkeith
+/PARAMETER_VALUE=::SCOTTKEITH
-! /parameter_value_search_for=
+! /PARAMETER_VALUE_SEARCH_FOR=
-! /parameter_value_replace_with=
+! /PARAMETER_VALUE_REPLACE_WITH=
-! /parameter_value_prefix=
+! /PARAMETER_VALUE_PREFIX=
-! /parameter_value_append=
+! /PARAMETER_VALUE_APPEND=
-! /multi_pass=false
+! /MULTI_PASS=FALSE
 ;
 </code>
-pipeline parameter : ::final = ::scottkeith
+Pipeline Parameter : ::FINAL = ::SCOTTKEITH
-if we set multi_pass= true
+if we set MULTI_PASS= TRUE
 <code>
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=final
+/PARAMETER_NAME=FINAL
-/parameter_value=::scottkeith
+/PARAMETER_VALUE=::SCOTTKEITH
-! /parameter_value_search_for=
+! /PARAMETER_VALUE_SEARCH_FOR=
-! /parameter_value_replace_with=
+! /PARAMETER_VALUE_REPLACE_WITH=
-! /parameter_value_prefix=
+! /PARAMETER_VALUE_PREFIX=
-! /parameter_value_append=
+! /PARAMETER_VALUE_APPEND=
-/multi_pass=true
+/MULTI_PASS=true
 ;
 </code>
-pipeline parameter : ::final = 7
+Pipeline Parameter : ::FINAL = 7
-**note:** if the above does not work (if final is not set to 7, and multi_pass is set to true), instead of writing "::scottkeith", use ":&:&::scottkeith".
+**NOTE:** If the above does not work (if FINAL is not set to 7, and MULTI_PASS is set to TRUE), instead of writing "::SCOTTKEITH", use ":&:&::SCOTTKEITH".