====== Remove Signals ======

The Remove_Signals pipeline command allows the user to remove a signal from the [[visual3d:documentation:visual3d_signal_types:data_tree|data tree]].

===== Pipeline Command =====

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 =====

^ 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. |

===== Example: Remove Signals of Different Types =====

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
;
</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.

<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.