Differences

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

--- visual3d:tutorials:pipeline:basic_pipeline_for_processing_a_session [2024/07/12 14:09] – created sgranger
+++ visual3d:tutorials:pipeline:basic_pipeline_for_processing_a_session [2026/02/06 18:55] (current) – [Tag Assignment] wikisysop
@@ Line 1: / Line 1: @@
-Under Construction...
+====== Basic Pipeline for Processing a Session ======
+This brief example demonstrates a [[visual3d:documentation:pipeline:pipeline_overview|pipeline script]] that steps through a standard set of basic processing steps. No assumptions are made about file or template names, so the user is prompted for each file in sequence.
+===== Pipeline =====
+This pipeline is similar to the examples from the Typical Processing Session's tutorials, but the user is also prompted for subject-specific information that can be used by the hybrid model to customize to the subject. The result is a very general pipeline that can be applied in many situations at the cost of added human input.
+<code>
+! Starting Fresh - Clear Workspace
+File_New
+;
+! Create a Hybrid model.
+! Prompt for the Standing Trial to use
+Create_Hybrid_Model
+! /CALIBRATION_FILE=
+;
+! Load the Model Template (Segment Definitions)
+Apply_Model_Template
+! /MODEL_TEMPLATE=
+! /CALIBRATION_FILE=
+;
+! Prompt for a set of Pipeline parameters that get assigned to the model metrics
+! in following commands:
+Prompt_For_Multiple_Pipeline_Parameter_Values
+/GLOBAL_PARAMETER_NAME=MASS+HEIGHT+THIGH_RADIUS+KNEE_RADIUS+ANKLE_RADIUS+FOOT_RADIUS
+/DATATYPE=float+float+float+float+float+float
+/DEFAULT_VALUE=1.0+1.0+0.089+0.075+0.05+0.08
+/MASS=1.0
+/HEIGHT=1.0
+/THIGH_RADIUS=0.089
+/KNEE_RADIUS=0.075
+/ANKLE_RADIUS=0.05
+/MET_RADIUS=0.08
+;
+! Model Metric Values These values use the pipeline parameters entered by the user
+! and modify the subject data
+Set_Model_Metric
+! /CALIBRATION_FILE=
+/METRIC_NAME=Mass
+/METRIC_VALUE=::MASS
+;
+Set_Model_Metric
+! /CALIBRATION_FILE=
+/METRIC_NAME=Height
+/METRIC_VALUE=::HEIGHT
+;
+Set_Model_Metric
+! /CALIBRATION_FILE=
+/METRIC_NAME=RTH_Distal_Radius
+/METRIC_VALUE=::KNEE_RADIUS
+;
+Set_Model_Metric
+! /CALIBRATION_FILE=
+/METRIC_NAME=RTH_Proximal_Radius
+/METRIC_VALUE=::THIGH_RADIUS
+;
+Set_Model_Metric
+! /CALIBRATION_FILE=
+/METRIC_NAME=LTH_Distal_Radius
+/METRIC_VALUE=::KNEE_RADIUS
+;
+Set_Model_Metric
+! /CALIBRATION_FILE=
+/METRIC_NAME=LTH_Proximal_Radius
+/METRIC_VALUE=::THIGH_RADIUS
+;
+Set_Model_Metric
+! /CALIBRATION_FILE=
+/METRIC_NAME=RSK_Distal_Radius
+/METRIC_VALUE=::ANKLE_RADIUS
+;
+Set_Model_Metric
+! /CALIBRATION_FILE=
+/METRIC_NAME=LSK_Distal_Radius
+/METRIC_VALUE=::ANKLE_RADIUS
+;
+Set_Model_Metric
+! /CALIBRATION_FILE=
+/METRIC_NAME=RFT_Distal_Radius
+/METRIC_VALUE=::FOOT_RADIUS
+;
+Set_Model_Metric
+! /CALIBRATION_FILE=
+/METRIC_NAME=LFT_Distal_Radius
+/METRIC_VALUE=::FOOT_RADIUS
+;
+! Update the model
+Build_Model
+! /CALIBRATION_FILE=
+! /REBUILD_ALL_MODELS=FALSE
+;
+! Prompt for the Movement data files.
+! Multiple files can be selected in the dialog file listing using CTRL-Click
+File_Open
+! /FILE_NAME=
+;
+! Assigning the Movement files to the model
+! Pop up the dialog box...
+Assign_Model_File
+! /CALIBRATION_FILE=
+! /MOTION_FILE_NAMES=
+;
+! Prompt the user for a TAG and assign the TAG to all files in the Workspace
+Prompt_For_Pipeline_Parameter_Value
+/GLOBAL_PARAMETER_NAME=TAG
+/PROMPT=Enter The Name of the Tag for this Workspace
+! /DATA_TYPE=
+! /DEFAULT_VALUE=
+;
+Assign_Tags_To_File
+/MOTION_FILE_NAMES=ALL_FILES
+/TAGS=::TAG
+;
+! Prompts the user for the report template
+Open_Report_Template
+! /REPORT_FILE_NAME=
+;
+</code>
+===== Execution Results =====
+When this pipeline is executed the user is prompted for all of the files and templates. The interaction will appear as follows:
+==== Static Trial Selection ====
+A dialog will pop-up so the user can select the [[visual3d:documentation:definitions:static_trial|standing trial]] for the model.
+{{:basic1.jpg}}
+==== Model Template Selection ====
+The user will select the [[visual3d:documentation:modeling:modeling_overview#assign_model_to_motion_file|model template]].
+{{:basic2.jpg}}
+==== Subject-Specific Metrics ====
+A dialog will pop-up so the user can enter [[visual3d:documentation:modeling:modeling_overview#model_subject_metrics|subject-specific model metrics]].
+{{:basic3.jpg}}
+==== Dynamic Trial Selection ====
+The user will then select the [[visual3d:documentation:definitions:static_trial#dynamic_motion_trial|movement trials]]. Multiple files can be selected in the dialog file listing using CTRL-Click
+{{:basic4.jpg}}
+==== Model Assignment ====
+The user will assign the model to the movement trials.
+{{:basic5.jpg}}
+==== Tag Assignment ====
+The user will be prompted for a [[visual3d:documentation:definitions:tag|TAG]] and assign the TAG to all files in the [[visual3d:getting_started:workspace|workspace]].
+{{:basic6.jpg}}
+==== Report Template Selection ====
+The user will select the [[visual3d:documentation:reports:reports_overview#report_template|report template]].
+{{:basic7.jpg }}