Wiki Documentation Site

This is an old revision of the document!

Set Pipeline Parameter To Data Value

Overview

This command can be used to set the value of a pipeline parameter to a specified value as defined by the user. This value can be any type of signal in that given workspace. This command can be found under Pipeline Control in the pipeline workshop.

Pipeline Command

The command below is as seen on the Visual3D application.

Set_Pipeline_Parameter_To_Data_Value
/SIGNAL_TYPES=
! /SIGNAL_FOLDER=ORIGINAL
! /SIGNAL_NAMES=
! /SIGNAL_COMPONENTS=ALL_COMPONENTS
/PARAMETER_NAME=
;

Command Parameters

The following table shows the command parameters and descriptions:

SIGNAL_TYPES	The type of signal you wish to set as the parameter value, e.g. LINK_MODEL_BASED
SIGNAL_FOLDER	Corresponding Folder e.g. PROCESSED
SIGNAL_NAMES	Name of the Desired signal
SIGNAL_COMPONENTS	Components of the desired Signal, default is all components
PARAMATER_NAME	Name for new parameter

Examples

Simple example

Get the Participant ID from PARAMETERS:SUBJECT:NAMES

Set_Pipeline_Parameter_To_Data_Value
/SIGNAL_TYPES=PARAMETERS
/SIGNAL_FOLDER=SUBJECTS
/SIGNAL_NAMES=NAMES
! /SIGNAL_COMPONENTS=ALL_COMPONENTS
/PARAMETER_NAME=SUBJECT_ID
;

Complex example

Combine with other commands and show step-by-step process for frequent use case

Notes

- Important considerations (anything included in the page before the reformat)

Table of Contents