HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » file_commands » Select Active File
visual3d:documentation:pipeline:file_commands:select_active_file

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
visual3d:documentation:pipeline:file_commands:select_active_file [2024/06/19 12:50] – sgrangervisual3d:documentation:pipeline:file_commands:select_active_file [2024/07/17 15:45] (current) – created sgranger
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+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.
  
-===== pipeline command =====+{{:Tutorial4_5.jpg}}
  
-the pipeline command below is used to select the [[visual3d:documentation:definitions:active_files|active_files]]+==== Pipeline Command ==== 
 + 
 +The pipeline command below is used to select the [[Visual3D:Documentation:Definitions:Active_Files|Active_Files]]
  
 <code> <code>
-select_active_file +Select_Active_File 
-! /file_name= +! /FILE_NAME= 
-! /query= +! /QUERY= 
-! /subject_tags=no_subject+! /SUBJECT_TAGS=NO_SUBJECT
 ; ;
 </code> </code>
  
-==== file_name ====+=== File_Name ===
  
-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.+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.
  
-**note:** visual3d defines files by their full pathname. for example, the following command will not be recognized+**Note:** Visual3D defines files by their full pathname. For example, the following command will not be recognized
  
 <code> <code>
-select_active_file +Select_Active_File 
-/file_name= file1.c3d+/FILE_NAME= file1.c3d
 ; ;
 </code> </code>
  
-to fix the example above, you define the full pathname:+To fix the example above, you define the full pathname:
  
 <code> <code>
-select_active_file +Select_Active_File 
-/file_name= c:\data\session1\file1.c3d+/FILE_NAME= c:\data\session1\file1.c3d
 ; ;
 </code> </code>
Line 38: Line 40:
  
 <code> <code>
-select_active_file +Select_Active_File 
-/file_name= *file1.c3d+/FILE_NAME= *file1.c3d
 ; ;
 </code> </code>
  
-or you can specify a tag:+or you can specify a TAG:
  
 <code> <code>
-select_active_file +Select_Active_File 
-/file_name= tag1+/FILE_NAME= TAG1
 ; ;
 </code> </code>
  
-==== query ====+=== Query ===
  
-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]]:+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:Expressions_Overview|expressions]]:
  
-/query=metric::processed::mass > 75+/QUERY=METRIC::PROCESSED::MASS > 75
  
-==== subject_tags ====+=== Subject_Tags ===
  
-set the active subject tag - for multisubject only!+Set the active subject tag - FOR MULTISUBJECT ONLY!
  
-===== example 1: global_workspace =====+==== Example 1: Global_Workspace ====
  
-this example shows how to make the [[visual3d:documentation:definitions:global_workspace|global workspace]] active+This example shows how to make the [[Visual3D:Documentation:Definitions:Global_Workspace|Global Workspace]] active
  
 <code> <code>
-select_active_file +Select_Active_File 
-/file_name=global +/FILE_NAME=GLOBAL 
-! /query=+! /QUERY=
 ; ;
 </code> </code>
  
-===== example 2 - all_files and or query =====+==== Example 2 - ALL_FILES and OR Query ====
  
-from all_files select files that are tagged tag1 or tag2. note there are multiple syntaxes for the "or". two are shown below:+From ALL_FILES select files that are tagged TAG1 or TAG2. Note there are multiple syntaxes for the "or". Two are shown below:
  
-using the "+" as the "or" operator+Using the "+" as the "OR" operator
  
 <code> <code>
-select_active_file +Select_Active_File 
-/file_name=all_files +/FILE_NAME=ALL_FILES 
-/query=tag1 + tag2+/QUERY=TAG1 + TAG2
 ; ;
 </code> </code>
  
-using "|" as the "or" operator+Using "|" as the "OR" operator
  
 <code> <code>
-select_active_file +Select_Active_File 
-/file_name=all_files +/FILE_NAME=ALL_FILES 
-/query=tag1 | tag2+/QUERY=TAG1 | TAG2
 ; ;
 </code> </code>
  
-===== example 3 - all_files and and not query =====+==== Example 3 - ALL_FILES AND and NOT Query ====
  
-from all_files select files that are tag1 and not tag2 using the operators "&" and "not"+From ALL_FILES select files that are TAG1 AND NOT TAG2 using the operators "&" and "NOT"
  
 <code> <code>
-select_active_file +Select_Active_File 
-/file_name=all_files +/FILE_NAME=ALL_FILES 
-/query=tag1 & not(tag2)+/QUERY=TAG1 & NOT(TAG2)
 ; ;
 </code> </code>
  
-===== example 4 - all_files and a wildcard =====+==== Example 4 - ALL_FILES and a wildcard ====
  
-from all_files select files that do not contain the wildcard *run*.c3d+From ALL_FILES select files that do not contain the wildcard *run*.c3d
  
-this cannot be done in one step. command will be used to tag the files prior to using the select_active command.+This cannot be done in one step. Command will be used to tag the files prior to using the Select_Active command.
  
 <code> <code>
-! assign tag run to files with "run" in the pathname +! Assign tag RUN to files with "run" in the pathname 
-assign_tags_to_files +Assign_Tags_To_Files 
-/motion_file_names=*run*.c3d +/MOTION_FILE_NAMES=*run*.c3d 
-! /query= +! /QUERY= 
-/tags=run+/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> </code>
  
-[[visual3d:documentation:pipeline:general_information:pipeline_commands_reference|back to pipeline commands reference]]+[[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]] 
  
  
-}} 
visual3d/documentation/pipeline/file_commands/select_active_file.1718801438.txt.gz · Last modified: 2024/06/19 12:50 by sgranger