Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_explicit [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_explicit [2025/09/18 17:13] (current) – wikisysop
@@ Line 1: / Line 1: @@
-{{{{{{this command creates a metric signal explicitly.
+====== Metric Explicit ======
-|<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|
+====Overview====
-previous versions of visual3d labeled this command explicit_metric
+The **Metric Explicit** command creates a metric signal explicitly. This allows for the creation of a new signal without input or reference data, unlike other metric commands. Previous versions of Visual3D labeled this command Explicit_Metric.
-====== example ======
+====Pipeline Command====
-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.
+The pipeline code for this command is as follows, it can be found in the **Pipeline Workshop** under **Metric**.
-|<code>\\ metric_explicit\\ /result_metric_name= new_signal\\ /result_metric_folder= offset\\ /metric_value= 1+2+3\\ ;\\ </code>  |  event_explicit_example.jpg|
+<code>
+Metric_Explicit
+/RESULT_METRIC_NAME=
+! /RESULT_METRIC_FOLDER=
+/METRIC_VALUE=
+</code>
-===== result =====
+====Command Parameters====
-event_explicit_exampleresult.jpg
+The following table shows the command parameters seen above and their descriptions:
-===== expressions =====
+|**RESULT_METRIC_NAME**|**The name of the result signal**|
+|**RESULT_METRIC_FOLDER**|**The name of the result signal folder**|
+|**METRIC_VALUE**|**Value of signal components**|
-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.
+====Dialog====
-in version 6 metric_value can be an expression, but this may lead to some confusion.
+The command can be edited in a text editor or in a dialog form. To edit in the dialog pop up form either click on the **Edit** button in the pipeline workshop or double-click on the pipeline command. The dialog is shown below.
-for example,
+{{:Event_Explicit.jpg}}
-**metric_explicit**
-! /result_metric_folder=processed
-/result_metric_name=x
-/metric_value=1
-**;**
-**metric_explicit**
-! /result_metric_folder=processed
-/result_metric_name=test
-/metric_value=metric::processed::x+1
-**;**
-the processing results for the second command are:
-metric name : metric::processed::test
+The dialog box allows you to assign values to the command parameters outlined above.
-metric expression : vector(metric::processed::x,1)
-metric value : 1.000000 , 1.000000 ;
-the second command be re-written as follows:
-**metric_explicit**
+===== Example =====
-! /result_metric_folder=processed
-/result_metric_name=test
+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.
-/metric_value=[[visual3d:documentation:pipeline:expressions:overview#pipeline_parameters_using_.2b_as_delimiter|add]](metric::processed::x,1)
-**;**
+<code>
-the processing results for the third command are:
+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 ;\\
-metric name : metric::processed::test
-metric expression : add(metric::processed::x,1)
-metric value : 2.000000 ;
-}}}}}}