HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » general_information » Pipeline Parameters
visual3d:documentation:pipeline:general_information:pipeline_parameters

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:general_information:pipeline_parameters [2024/10/09 18:36] – Updated links for Expression syntax. wikisysopvisual3d:documentation:pipeline:general_information:pipeline_parameters [2024/11/15 16:56] (current) – wikisysop
Line 1: Line 1:
-===== Pipeline Parameters =====+====== Pipeline Parameters ======
  
 An important feature of the pipeline is the ability to create and use Pipeline Parameters, which allows users to store a text string for use in later Pipeline commands. In one sense it is similar to specifying a global variable, such as body weight, that could be used in computations. In practice, however, Pipeline Parameters are actually much more flexible than that: since pipeline commands permit multiple entries on a single line for a given parameter, and since the entire line can be represented as a string, a single Pipeline Parameter can represent multiple entries. An important feature of the pipeline is the ability to create and use Pipeline Parameters, which allows users to store a text string for use in later Pipeline commands. In one sense it is similar to specifying a global variable, such as body weight, that could be used in computations. In practice, however, Pipeline Parameters are actually much more flexible than that: since pipeline commands permit multiple entries on a single line for a given parameter, and since the entire line can be represented as a string, a single Pipeline Parameter can represent multiple entries.
  
-==== Using a Pipeline Parameter ====+===== Using a Pipeline Parameter =====
  
 Pipeline parameters are designated for Visual3D's parser by two colons before the parameter name. For example, Visual3D recognizes the pipeline parameter named TEST as ::TEST Pipeline parameters are designated for Visual3D's parser by two colons before the parameter name. For example, Visual3D recognizes the pipeline parameter named TEST as ::TEST
Line 21: Line 21:
 An example pipeline using pipeline parameters can be found in the sample files for the [[visual3d:tutorials:knowledge_discovery:typical_processing_session|Typical Processing Session]] tutorial. An example pipeline using pipeline parameters can be found in the sample files for the [[visual3d:tutorials:knowledge_discovery:typical_processing_session|Typical Processing Session]] tutorial.
  
-==== Automatic Creation of Pipeline Parameters ====+===== Automatic Creation of Pipeline Parameters =====
  
 Several of the pipeline commands are capable of prompting the user for input. The value of the variable is automatically saved as a pipeline parameter so that it can be used elsewhere in the pipeline. For example, Several of the pipeline commands are capable of prompting the user for input. The value of the variable is automatically saved as a pipeline parameter so that it can be used elsewhere in the pipeline. For example,
Line 42: Line 42:
 The PARAMETER_VALUE is assigned the variable name (e.g. FILE_NAME) from the previous command. For subsequent commands the user can use ::C3D_FILE to refer to the files that were selected by the user. This pipeline parameter will not be modified unless the user explicitly overwrites it. The PARAMETER_VALUE is assigned the variable name (e.g. FILE_NAME) from the previous command. For subsequent commands the user can use ::C3D_FILE to refer to the files that were selected by the user. This pipeline parameter will not be modified unless the user explicitly overwrites it.
  
-==== Pipeline Parameters Syntax =====+===== Pipeline Parameters Syntax =====
  
 Concatenating pipeline parameters is tricky because of the rules used for parsing the parameters in Visual3D. For example, given a pipeline parameter representing a signal name ::NAME, to use this parameter in the following command is straightforward. Concatenating pipeline parameters is tricky because of the rules used for parsing the parameters in Visual3D. For example, given a pipeline parameter representing a signal name ::NAME, to use this parameter in the following command is straightforward.
Line 70: Line 70:
 </code> </code>
  
-=== Pipeline Parameters in Expressions ===+==== Pipeline Parameters in Expressions ====
 As another example, the following command is a valid expression: As another example, the following command is a valid expression:
  
Line 104: Line 104:
 </code> </code>
  
-=== Syntax Specification ===+==== Syntax Specification ====
  
 Visual3D's command pre-processor replaces all global pipeline parameters before parsing the command. Visual3D's command pre-processor replaces all global pipeline parameters before parsing the command.
Line 116: Line 116:
     - It's kind of a kludge, but it makes sense when you understand it first looks for all &:: to do a replacement. In the case of the expression &::something&::MASS the term ::MASS becomes a null string because it doesn't exist as a global pipeline parameter.     - It's kind of a kludge, but it makes sense when you understand it first looks for all &:: to do a replacement. In the case of the expression &::something&::MASS the term ::MASS becomes a null string because it doesn't exist as a global pipeline parameter.
  
-==== Default Pipeline Parameters ====+===== Default Pipeline Parameters =====
  
 Visual3D pipeline commands automatically creates pipeline parameters whenever a command is executed. The general syntax of a Visual3D command is: Visual3D pipeline commands automatically creates pipeline parameters whenever a command is executed. The general syntax of a Visual3D command is:
Line 155: Line 155:
 The consequence is that users must be very conscious of the pipeline parameters that they create explicitly. If common names like FOLDER are defined by the user, they may actually change their value over a series of commands that include a parameter named FOLDER. The consequence is that users must be very conscious of the pipeline parameters that they create explicitly. If common names like FOLDER are defined by the user, they may actually change their value over a series of commands that include a parameter named FOLDER.
  
-==== Example ====+===== Example =====
  
 An [[visual3d:documentation:pipeline:pipeline_commands:pipeline_parameters_example|example]] is given that adds a TAG to an individual file based on a C3D parameter. In this case, the file will be tagged from the motion system manufacturer according to the information found in the [[visual3d:documentation:c3d_signal_types:c3d_format|C3D file]]'s corresponding parameter.  An [[visual3d:documentation:pipeline:pipeline_commands:pipeline_parameters_example|example]] is given that adds a TAG to an individual file based on a C3D parameter. In this case, the file will be tagged from the motion system manufacturer according to the information found in the [[visual3d:documentation:c3d_signal_types:c3d_format|C3D file]]'s corresponding parameter. 
visual3d/documentation/pipeline/general_information/pipeline_parameters.1728498974.txt.gz · Last modified: 2024/10/09 18:36 by wikisysop