Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_explicit [2024/06/26 20:26] – created sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_explicit [2025/09/18 17:13] (current) – wikisysop
@@ Line 1: / Line 1: @@
-====== Metric_Explicit ======
+====== Metric Explicit ======
-This command creates a metric signal explicitly.
+====Overview====
-|<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}}|
+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.
-Previous versions of Visual3D labeled this command Explicit_Metric
+====Pipeline Command====
+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=
+! /RESULT_METRIC_FOLDER=
+/METRIC_VALUE=
+</code>
+====Command Parameters====
+The following table shows the command parameters seen above and their descriptions:
+|**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**|
+====Dialog====
+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.
+{{:Event_Explicit.jpg}}
+The dialog box allows you to assign values to the command parameters outlined above.
 ===== Example =====
@@ Line 11: / Line 37: @@
 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}}|
+<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}}
+{{:Event_Explicit_exampleresult.jpg}}
 ==== Expressions ====
@@ Line 25: / Line 58: @@
 For example,
-**Metric_Explicit**
+<code>
+Metric_Explicit
 ! /RESULT_METRIC_FOLDER=PROCESSED
 /RESULT_METRIC_NAME=X
 /METRIC_VALUE=1
-**;**
+;
-**Metric_Explicit**
+</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 Name : METRIC::PROCESSED::TEST\\
-Metric Expression : VECTOR(METRIC::PROCESSED::X,1)
+Metric Expression : VECTOR(METRIC::PROCESSED::X,1)\\
-Metric Value : 1.000000 , 1.000000 ;
+Metric Value : 1.000000 , 1.000000 ;\\
 The second command be re-written as follows:
-**Metric_Explicit**
+Metric_Explicit\\
-! /RESULT_METRIC_FOLDER=PROCESSED
+! /RESULT_METRIC_FOLDER=PROCESSED\\
-/RESULT_METRIC_NAME=TEST
+/RESULT_METRIC_NAME=TEST\\
-/METRIC_VALUE=[[Visual3D:Documentation:Pipeline:Expressions:Overview#Pipeline_parameters_using_.2B_as_delimiter|Add]](METRIC::PROCESSED::X,1)
+/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 Name : METRIC::PROCESSED::TEST\\
-Metric Expression : Add(METRIC::PROCESSED::X,1)
+Metric Expression : Add(METRIC::PROCESSED::X,1)\\
-Metric Value : 2.000000 ;
+Metric Value : 2.000000 ;\\