User Tools

Site Tools


visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter_to_list_of_signal_names

Set Pipeline Parameter To List Of Signal Names

This command is used to create a pipeline parameter that contains a list of the signal names of a given type. For a movement trial, all signal types in the data tree are eligible.

Commonly, this lists are used for a For_Each command.

Pipeline Command

The command can be found in the Pipeline Workshop within the Pipeline Control folder as so:

Set_Pipeline_Parameter_To_List_Of_Signal_Names /PARAMETER_NAME= ! /SIGNAL_TYPES= ! /SIGNAL_FOLDER=ORIGINAL ! /SIGNAL_MASK=* ;

Command Parameters

The following table shows the command parameters that can be used to define the command and their descriptions:

Parameter Description
Parameter NameThe name of the parameter to be set
Signal TypesThe type of signal containing the list of files
Signal FolderThe folder containing the signals to be listed
Signal MaskThe file type to search for

Example: Get all TARGET names

The following code shows how the command could be used to produce a list of all of the files in the TARGET folder:

Set_Pipeline_Parameter_To_List_Of_Signal_Names
/PARAMETER_NAME=SCOTT
/SIGNAL_TYPE=TARGET
/SIGNAL_FOLDER=ORIGINAL
;

The result from one example file:

SCOTT=
LFT1
LFT2
LFT3
LSK1
LSK2
LSK3
LSK4
LTH1
LTH2
LTH3
LTH4
PV1
PV2
PV3
PV4
RFT1
RFT2
RFT3
RSK1
RSK2
RSK3
RSK4
RTH1
RTH2
RTH3
RTH4

Example: Working with Kinetic_Kinematic Signals

Kinetic_Kinematic signals are a special case because it is the folder that is of interest because all folders contain the same signals.

For example:

Set_Pipeline_Parameter_To_List_Of_Signal_Names
/PARAMETER_NAME=SCOTT
/SIGNAL_TYPE=KINETIC_KINEMATIC
/SIGNAL_FOLDER=
;

Result:

SCOTT=
LFT
LMF
LSK
LTH
Virtual Lab
RFT
RMF
RPV
RSK
RTH
Model

Example: Model Signals

For a standing trial (e.g. model), the following signal types are available.

Note that the signal_type for model items must have the prefix MODEL:: to distinguish it from a movement trial.

/SIGNAL_TYPE=MODEL::TARGET
/SIGNAL_TYPE=MODEL::ANALOG
/SIGNAL_TYPE=MODEL::SEGMENT
/SIGNAL_TYPE=MODEL::LANDMARK
/SIGNAL_TYPE=MODEL::FORCE
/SIGNAL_TYPE=MODEL::METRIC

For example, get all model TARGETS:

Set_Pipeline_Parameter_To_List_Of_Signal_Names**
/PARAMETER_NAME=SCOTT
/SIGNAL_TYPE=MODEL::TARGET
/SIGNAL_FOLDER=ORIGINAL
;

Results:

SCOTT=
LFT1
LFT2
LFT3
LSK1
LSK2
LSK3
LSK4
LTH1
LTH2
LTH3
LTH4
PV1
PV2
PV3
PV4
RFT1
RFT2
RFT3
RSK1
RSK2
RSK3
RSK4
RTH1
RTH2
RTH3
RTH4
RA
LA
RK
LK
RH
LH
RPP

Example: Get All Model Segment Names

Set_Pipeline_Parameter_To_List_Of_Signal_Names**
/PARAMETER_NAME=SCOTT
/SIGNAL_TYPE=MODEL::SEGMENT
/SIGNAL_FOLDER=ORIGINAL
;

Result:

SCOTT=
LAB
Virtual Lab
RPV
RTH
LTH
RSK
LSK
RFT
LFT
RMF
LMF
visual3d/documentation/pipeline/pipeline_commands/set_pipeline_parameter_to_list_of_signal_names.txt · Last modified: by wikisysop