Wiki Documentation Site

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » pipeline_commands » Set Pipeline Parameter
visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter [2024/06/17 18:22] – created sgrangervisual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter [2026/02/04 20:48] (current) – wikisysop
Line 1: Line 1:
 +====== 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. 
  
 +====Pipeline command====
 +This command can be found in the Pipeline Workshop within the Pipeline Control folder as shown below:
 +<code>
 +Set_Pipeline_Parameter
 +/PARAMETER_NAME=
 +/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: |
  
-Pipeline parameters can be created in the pipeline and used as variables in other commands in the same pipeline. +==== Example: Set Pipeline Values via Search and Replace ====
- +
-|**Set_Pipeline_Parameter**        |                                                                                                                                                                                                                                                                                                                                                           | | | +
-|**/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=**  |                                                                                                                                                                                                                                                                                                                                                           | | | +
-|**/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                                                                                                                                                                                    | | | +
-|**/Multi_Pass=**                  |FALSE                                                                                                                                                                                                                                                                                                                                                      |-|;| +
- +
-===== 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**.
Line 33: Line 47:
 </code> </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**.
Line 50: Line 64:
 </code> </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:
Line 76: Line 90:
 **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
Line 170: Line 184:
  
 **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".
- 
- 
  
  
  
visual3d/documentation/pipeline/pipeline_commands/set_pipeline_parameter.1718648535.txt.gz · Last modified: by sgranger