User Tools

Site Tools


visual3d:documentation:pipeline:metric_commands:metric_explicit

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:metric_commands:metric_explicit [2024/07/03 17:29] – removed sgrangervisual3d:documentation:pipeline:metric_commands:metric_explicit [2024/09/20 14:10] (current) – [Expressions] wikisysop
Line 1: Line 1:
 +====== Metric Explicit ======
 +
 +This command creates a metric signal explicitly.
 +
 +<code>
 +Metric_Explicit
 +/RESULT_METRIC_NAME=              Name of the resulting signal
 +! /RESULT_METRIC_FOLDER=PROCESSED Name of the resulting folder
 +/METRIC_VALUE=                    Component Value(s);
 +</code>  
 +
 +{{:Event_Explicit.jpg}}
 +
 +Previous versions of Visual3D labeled this command Explicit_Metric
 +
 +===== Example =====
 +
 +This example will create a metric signal with 3 component values of 1, 2, 3. The resulting signal will be named **NEW_SIGNAL** and be located in the **OFFSET** folder.
 +
 +<code>
 +Metric_Explicit
 +/RESULT_METRIC_NAME= NEW_SIGNAL
 +/RESULT_METRIC_FOLDER= OFFSET
 +/METRIC_VALUE= 1+2+3;
 +</code> 
 +
 + {{:Event_Explicit_example.jpg}}
 +
 +==== Result ====
 +
 +{{:Event_Explicit_exampleresult.jpg}}
 +
 +==== Expressions ====
 +
 +In early implementations of this command the values in Metric_Value were a list of components you wanted the metric explicitly set to (see example above), and expressions were not allowed.
 +
 +In version 6 Metric_Value can be an expression, but this may lead to some confusion.
 +
 +For example,
 +
 +<code>
 +Metric_Explicit
 +! /RESULT_METRIC_FOLDER=PROCESSED
 +/RESULT_METRIC_NAME=X
 +/METRIC_VALUE=1
 +;
 +</code>
 +
 +<code>
 +Metric_Explicit
 +! /RESULT_METRIC_FOLDER=PROCESSED
 +/RESULT_METRIC_NAME=TEST
 +/METRIC_VALUE=METRIC::PROCESSED::X+1
 +;
 +</code>
 +
 +The processing results for the second command are:
 +
 +Metric Name : METRIC::PROCESSED::TEST\\
 +Metric Expression : VECTOR(METRIC::PROCESSED::X,1)\\
 +Metric Value : 1.000000 , 1.000000 ;\\
 +The second command be re-written as follows:
 +
 +Metric_Explicit\\
 +! /RESULT_METRIC_FOLDER=PROCESSED\\
 +/RESULT_METRIC_NAME=TEST\\
 +/METRIC_VALUE=[[Visual3D:Documentation:Pipeline:Expressions:Expressions_Overview#Pipeline_parameters_using_.2B_as_delimiter|Add]](METRIC::PROCESSED::X,1)\\
 +;\\
 +
 +The processing results for the third command are:
 +
 +Metric Name : METRIC::PROCESSED::TEST\\
 +Metric Expression : Add(METRIC::PROCESSED::X,1)\\
 +Metric Value : 2.000000 ;\\
 +
  
visual3d/documentation/pipeline/metric_commands/metric_explicit.1720027740.txt.gz · Last modified: 2024/07/03 17:29 by sgranger