Differences

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

--- visual3d:documentation:pipeline:file_commands:select_active_file [2024/06/19 12:50] – sgranger
+++ visual3d:documentation:pipeline:file_commands:select_active_file [2025/07/22 15:05] (current) – wikisysop
@@ Line 1: / Line 1: @@
-{{many of the pipeline commands in visual3d act on the active files only. using this command the user can determine what files are active and therefore will be processed.
+====== Select Active File ======
-tutorial4_5.jpg
+===== Overview =====
+The **Select_Active_File** command is used to define which file(s) are active in the Visual3D workspace. This is important because most pipeline commands operate only on the currently active file(s). If multiple files are open or batch processing is used, this command gives you precise control over which trial a command affects.
-===== pipeline command =====
+You can select files using three different mechanisms:
+  - FILE_NAME- Target a file or files using full name or wildcard patterns
+  - QUERY- Select based on logical tag conditions (e.g., 'TAG1' & 'NOT(TAG2)')
+  - SUBJECT_TAGS- Select based on subject-level tags (metadata applied to trials)
-the pipeline command below is used to select the [[visual3d:documentation:definitions:active_files|active_files]]
-<code>
+==== Understanding the File Selection Methods ====
-select_active_file
-! /file_name=
-! /query=
-! /subject_tags=no_subject
-;
-</code>
-==== file_name ====
+**/FILE_NAME=**: Lets you specify the actual filename or use wildcards:
+  * "Trial01.c3d" - selects only one file exactly.
+  * "*.c3d" - wildcard, selects all C3D files
-the parameter **/file_name=** can be a single file, a tag referring to all files with that tag, or the keyword all_files, which makes all of the files in the visual3d workspace active.
+**/QUERY=**: Lets you use logic expressions to select based on file-level tags
+  * If you have tagged trials like "Walk" and "Run", you can use the following syntax in order to manipulate which files are selected as active.
+  * '/QUERY= Walk + Run'- select all walking or running files.
+  * '/QUERY= Run + NOT(Fatigue) - only running files that are not tagged fatigued
-**note:** visual3d defines files by their full pathname. for example, the following command will not be recognized
+|Symbol|Meaning (Syntax)|Example|
+|**+**|OR|'TAG1' + 'TAG2'|
+|**|**|OR (Alternative)|'TAG1' **|** 'TAG2'|
+|**&**|AND|'TAG1' &  'TAG2'|
+|**NOT**|Negation|'TAG1' & NOT('TAG2')|
-<code>
+**'/SUBJECT_TAGS='**- similar to /QUERY, but works at the subject level. Use this if you've applied subject-wide tags like 'ELITE' or 'CONTROL'
-select_active_file
-/file_name= file1.c3d
+===== Pipeline Command =====
-;
-</code>
-to fix the example above, you define the full pathname:
+The command below is as seen on the Visual3D application, the parameters within act as options to manipulate the command.
 <code>
-select_active_file
+Select_Active_File
-/file_name= c:\data\session1\file1.c3d
+! /FILE_NAME=
-;
+! /QUERY=
+! /SUBJECT_TAGS=NO_SUBJECT
 </code>
-or you can use a wildcard:
+===== Command Parameters =====
-<code>
+The following table shows the command parameters and descriptions.
-select_active_file
-/file_name= *file1.c3d
-;
-</code>
-or you can specify a tag:
+|**Parameter**|**Description**|
+|**! /FILE_NAME=**|Specifies the file(s) to activate using exact name or wildcard.|
+|**! /QUERY=**|Selects files by tag logic.|
+|**! /SUBJECT_TAGS=**|Filters files by subject-level tags. Defaults to NO_SUBJECT|
-<code>
+===== Dialog =====
-select_active_file
-/file_name= tag1
-;
-</code>
-==== query ====
+There is no dedicated dialog box for this command. The GUI equivalent is manually selecting the active file using the file selector dropdown in the toolbar:
-the query option (**visual3d professional only**) allows you to select a subset of the files referred by to file_name. you can query using [[visual3d:documentation:pipeline:expressions:overview|expressions]]:
+{{:visual3d:documentation:pipeline:file_commands:activefile_ui_dropdown.png?900|}}
-/query=metric::processed::mass > 75
+This command is primarily used in pipeline scripts and batch processing workflows to automate file selection.
-==== subject_tags ====
+===== Examples =====
-set the active subject tag - for multisubject only!
+The following examples will go through the use of the Select_Active_File command in the Visual3D application.
-===== example 1: global_workspace =====
+=== Example 1: Select the Global Workspace ===
-this example shows how to make the [[visual3d:documentation:definitions:global_workspace|global workspace]] active
+Use this when working with signals that were computed across multiple trials. These signals are not associated with a specific file, and so they live in the Global Workspace.
 <code>
-select_active_file
+Select_Active_File
-/file_name=global
+/FILE_NAME=GLOBAL
-! /query=
+! /QUERY=
+! /SUBJECT_TAGS=NO_SUBJECT
 ;
 </code>
-===== example 2 - all_files and or query =====
+=== Example 2: Select trials based on tags (OR condition) ===
-from all_files select files that are tagged tag1 or tag2. note there are multiple syntaxes for the "or". two are shown below:
+Say that you've tagged trials using WALK and RUN and you want to activate all trials that are either walking OR running:
-using the "+" as the "or" operator
+<code>
+Select_Active_File
+/FILE_NAME=ALL_FILES
+/QUERY=WALK + RUN
+! /SUBJECT_TAGS=NO_SUBJECT
+;
+</code>
+Or equivalently:
 <code>
-select_active_file
+Select_Active_File
-/file_name=all_files
+/FILE_NAME=ALL_FILES
-/query=tag1 + tag2
+/QUERY=WALK | RUN
+! /SUBJECT_TAGS=NO_SUBJECT
 ;
 </code>
-using "|" as the "or" operator
+=== Example 3: Select trials with one tag AND NOT another ===
+Suppose you want to select all running trials that are not tagged as "Fatigue":
 <code>
-select_active_file
+Select_Active_File
-/file_name=all_files
+/FILE_NAME=ALL_FILES
-/query=tag1 | tag2
+/QUERY=RUN & NOT(FATIGUE)
+! /SUBJECT_TAGS=NO_SUBJECT
 ;
 </code>
-===== example 3 - all_files and and not query =====
+=== Example 4: Select trials based on subject-level tags ===
-from all_files select files that are tag1 and not tag2 using the operators "&" and "not"
+Assuming you've tagged subjects as 'ELITE', and some are also tagged 'INJURED'. You can activate only the non-injured elite subjects:
 <code>
-select_active_file
+Select_Active_File
-/file_name=all_files
+/FILE_NAME=ALL_FILES
-/query=tag1 & not(tag2)
+! /QUERY=
+/SUBJECT_TAGS=ELITE & NOT(INJURED)
 ;
 </code>
-===== example 4 - all_files and a wildcard =====
-from all_files select files that do not contain the wildcard *run*.c3d
+=== Example 5: Exclude specific filename patterns using tagging ===
-this cannot be done in one step. command will be used to tag the files prior to using the select_active command.
+If you want to exclude trials with "run" in the name, you must first tag the files that should be kept, since wildcards cannot do negative matching directly.
 <code>
-! assign tag run to files with "run" in the pathname
+! Tag only the files NOT containing "run"
-assign_tags_to_files
+! Assign tag RUN to files with "run" in the pathname
-/motion_file_names=*run*.c3d
+Assign_Tags_To_Files
-! /query=
+/MOTION_FILE_NAMES=*run*.c3d
-/tags=run
+! /QUERY=
+/TAGS=RUN
 ;
-! assign tag not_run to files that are not tagged run
+! Assign tag NOT_RUN to files that are not tagged RUN
-assign_tags_to_files
+Assign_Tags_To_Files
-/motion_file_names=all_files
+/MOTION_FILE_NAMES=ALL_FILES
-/query=not(run)
+/QUERY=NOT(RUN)
-/tags=not_run
+/TAGS=NOT_RUN
 ;
-! select not_run as the active files
+! Select NOT_RUN as the active files
-select_active_file
+Select_Active_File
-/file_name=not_run
+/FILE_NAME=NOT_RUN
-! /query=
+! /QUERY=
-;
 </code>
-[[visual3d:documentation:pipeline:general_information:pipeline_commands_reference|back to pipeline commands reference]]
+===== Notes =====
+  * Use this command any time your pipeline depends on file-specific operations in a multi-file workspace.
+  * Tags are assigned using the Assign_Tags_To_Files command and must be added before using '/QUERY='
+  * Use '/SUBJECT_TAGS=' only if your workspace includes subject-level metadata
+  * To select files by exclusion (e.g. "everything except..."), you must use tagging- direct wildcard exclusion is not supported.
+----
+[[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]]
-}}