Differences

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

--- visual3d:documentation:pipeline:signal_commands:remove_signals [2024/07/03 17:43] – created sgranger
+++ visual3d:documentation:pipeline:signal_commands:remove_signals [2026/09/09 18:43] (current) – Added link for Recalc pipeline. richard
@@ Line 1: / Line 1: @@
-====== Remove_Signals ======
+====== Remove Signals ======
-Remove a signal from the data tree.
+The Remove_Signals pipeline command allows the user to remove a signal from the [[visual3d:documentation:visual3d_signal_types:data_tree|data tree]].
-The details on the command are found below:
+===== Pipeline Command =====
-|<code>\\ Remove_Signals\\ /Signal_Types=The type of signal to be evaluated\\ /SIGNAL_FOLDER==The signal folder\\ /INCLUDE_MODELS= TRUE or FALSE Assigning TRUE will remove signals from MODELS assigned to ACTIVE files\\ </code>  |
+The Remove_Signals command can be found in the pipeline workshop's Signal/Data Management folder:
+<code>
+Remove_Signals
+/SIGNAL_TYPES=
+! /SIGNAL_FOLDER=ORIGINAL
+! /SIGNAL_NAMES=
+! /INCLUDE_MODELS=FALSE
+! /REMOVE_FROM_RECALC_PIPELINE=FALSE
+;
+</code>
-----
+===== Command Parameters =====
-==== Examples ====
+^ Parameter ^ Description ^
+| Signal Types | The [[visual3d:documentation:pipeline:general_information:signal_types|type of signal]] specified. |
+| Signal Folder | The [[visual3d:documentation:pipeline:general_information:signal_folder|data tree folder]] specified. Default value is [[visual3d:documentation:visual3d_signal_types:data_tree#data_folders|ORIGINAL]]. |
+| Signal Names | The signal names specified. Default value is empty, meaning all signals within Type > Folder. |
+| Include Models | If true, then will remove signals from models assigned to the [[visual3d:documentation:definitions:active_files|active files]]. Default value is false. |
+| Remove from Recalc Pipeline | If true, then the specified signals are also removed from the [[visual3d:documentation:pipeline:general_information:recalc_pipeline|Recalc pipeline]]. Default value is false. |
-For example, remove one Derived signal and one Metric
+===== Example: Remove Signals of Different Types =====
-**Remove_Signals**
+For example, remove one [[visual3d:documentation:visual3d_signal_types:derived_data_type|DERIVED]] signal and one [[visual3d:documentation:visual3d_signal_types:metric_data_type|METRIC]] from the data tree.
+<code>
+Remove_Signals
 /SIGNAL_TYPES=DERIVED+METRIC
 /SIGNAL_NAMES= DERIVED1+METRIC1
-! /SIGNAL_FOLDER=PROCESSED+PROCESSED
+/SIGNAL_FOLDER=PROCESSED+PROCESSED
-**;**
+;
-Signals can also be removed manually from the data tree
+</code>
+This command will have the effect of removing DERIVED::PROCESSED::DERIVED1 and METRIC::PROCESSED::METRIC1 from the data tree.
+===== Example: Remove Link_Model_Based Items from Recalc =====
+For example, remove all [[visual3d:documentation:visual3d_signal_types:link_model_based_data_type|LINK_MODEL_BASED]] items from the Recalc pipeline as well as from the workspace.
-[[Visual3D:Documentation:Visual3D_Signal_Types:Data_Tree#Deleting_a_Signal|Data_Tree#Deleting_a_Signal]]
+<code>
+Remove_Signals
+/SIGNAL_TYPES=LINK_MODEL_BASED
+! /SIGNAL_FOLDER=ORIGINAL
+! /SIGNAL_NAMES=
+! /INCLUDE_MODELS=FALSE
+/REMOVE_FROM_RECALC_PIPELINE=TRUE
+;
+</code>
+===== Notes =====
+Signals can also be [[Visual3D:Documentation:Visual3D_Signal_Types:Data_Tree#Deleting_a_Signal|removed manually from the data tree]] via the graphical interface.