====== Model Commands Overview ======

===== Model_Management =====

====Apply_Model_Template===

[[Visual3D:Documentation:Pipeline:Model_Commands:Apply_Model_Template|Apply_Model_Template]] to a Model (Calibration File).

Wildcards (*) can be used for FILE_NAME and MODEL_NAME.

<code>
Apply_Model_Template
/MODEL_TEMPLATE=
/CALIBRATION_FILE=
;
</code>

**NOTE:** In early versions of Visual3D, this command was called **OPEN_MODEL_FILE**. 
Even though this name no longer appears in the pipeline dialog, if it appears in the Pipeline Script, it will still be recognized and processed correctly by Visual3D.

Example:

<code>
! New Workspace
File_New
;

! Set a path for the location of the data
Set_Pipeline_Parameter
/PARAMETER_NAME=FOLDER
/PARAMETER_VALUE=c:\demo files\
;

! Set the parameter for the static file
Set_Pipeline_Parameter
/PARAMETER_NAME=STATIC
/PARAMETER_VALUE=::FOLDER&static.c3d
;

! Apply the model template using the static trial. 
! Leaving the **MODEL_TEMPLATE** parameter blank will bring up a dialog that allows the user to browse and select the model template
Apply_Model_Template
/MODEL_TEMPLATE=
/CALIBRATION_FILE=::STATIC
;

! Set Weight
Set_Subject_Weight
/CALIBRATION_FILE=::STATIC
/WEIGHT=1.0
;

! Set Height
Set_Subject_Height
/CALIBRATION_FILE=::STATIC
/HEIGHT=1
;

! Open the movement file
Open_File
/FILE_NAME=::FOLDER&movement.c3d
;

! Assign the model file to the movement file
Assign_Model_File
/CALIBRATION_FILE=::STATIC
/MOTION_FILE_NAMES=::FOLDER&movement.c3d
;
</code>

====Append_Model_Template====
[[visual3d:documentation:pipeline:model_commands:Append_Model_Template]]

<code>
Append_Model_Template
! /CALIBRATION_FILE=
! /MODEL_TEMPLATE=
! /VIEW_BUILDMODEL_RESULTS=2
;
</code>

====Close_Model_File====

[[visual3d:documentation:pipeline:model_commands:close_calibration_file|Close_Model_File]]
                                                                                                                                                                                                                                                                                                                                                            |
Close the specified Model and Static File(s).\\ 
File_Name can be ALL_FILES, a TAG, or a Filename(Wildcards are acceptable)

<code>
Close_Model_File
/Close_Calibration_File=
;
</code>

For example, to close all movement trials containing the string "standing"
<code>
Close_Model_File
/Close_Calibration_File= *standing*.c3d
;
</code>

====Assign_Model_File====
[[Visual3D:Documentation:Pipeline:Model_Commands:Assign_Model_File|Assign a Model to a Movement File]]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

<code>
Assign_Model_File
/Calibration_File=Name of the standing trial associated with the model.
/Motion_File_Names=Names of the motion files to be assigned to the model.
;
</code>

**Note: Wildcards (*) can be used for the Calibration_File**\\
**Note: TAGS or Wildcards (*) can be used for the Motion_File Names**

Here is an example using pipeline parameters:
<code>
Set_Pipeline_Parameter_To_Folder_Path
/PARAMETER_NAME=FOLDER
/PARAMETER_VALUE=c:\exampleData\
;

Set_Pipeline_Parameter
/PARAMETER_NAME=STANDING
/PARAMETER_VALUE=::FOLDER&*static.c3d
;

Set_Pipeline_Parameter
/PARAMETER_NAME=WALKING
/PARAMETER_VALUE=::FOLDER&*walk*.c3d
;

Assign_Model_File
/CALIBRATION_FILE=::STANDING
/MOTION_FILE_NAMES=::WALKING
;
</code>

Here is the same example, using wild cards in the Assign Model File command:
<code>
Assign_Model_File
/CALIBRATION_FILE=*static.c3d
/MOTION_FILE_NAMES=*walk*.c3d
;
</code>

Another example can be found on [[Visual3D:Documentation:Pipeline:Model_Commands:Assign_Model_File_Example|Pipeline Example using Assign Model File]]

====Create_Hybrid_Model====

[[Visual3D:Documentation:Pipeline:Model_Commands:Create_Hybrid_Model|Create a Hybrid Model]] is the extension to the Visual3D 6 degree of freedom model which was developed in collaboration with the 
National Institutes of Health, Physical Disabilities Branch.\\
The main extension to the model is that the pose (Position and Orientation) of a segment can depend on data from other segments. 
If data from other segments is used, the segment no longer has 6 degrees of freedom. 
For example, a thigh segment could be created using a hip joint landmark, which was defined relative to the pelvis segment.

<code>
Create_Hybrid_Model
/CALIBRATION_FILE= the name of the c3d file for the static trial
/SUFFIX= a suffix that is added to the Calibration_File if and only if the c3d file for the static trial already exists
/RANGE=ALL_FRAMES
;
</code>

**Note: Wildcards (*) can be used for the Calibration_File name**\\ 
**Note:** If the Calibration_File is specified and the file does not exist in the Workspace, the Suffix is ignored.\\ 
**Note:** If the Calibration_File is specified and the file exists in the Workspace, the suffix is automatically added to the model name.\\
**Note:** If the Calibration_File is specified and the suffix is specified, but the Filename and the Filenam+Suffix exists in the Workspace, the user is prompted for a new name.

The example below creates a model using frames 10 to 15 of the static trial:

<code>
Create_Hybrid_Model
/CALIBRATION_FILE= *static.c3d
/SUFFIX= a suffix that is added to the Calibration_File if and only if the c3d file for the static trial already exists.
/RANGE=10+15
;

Set_Pipeline_Parameter_To_Folder_Path
/PARAMETER_NAME=FOLDER
/PARAMETER_VALUE=c:\exampleData
;

Set_Pipeline_Parameter
/PARAMETER_NAME=STANDING
/PARAMETER_VALUE=::FOLDER&*static.c3d
;

Create_Hybrid_Model
/CALIBRATION_FILE=::STANDING
;
</code>

Another example can be found on [[Visual3D:Documentation:Pipeline:Model_Commands:Create_Hybrid_Model_Example|Pipeline Example using Create Hybrid Model]]

===== Modeling =====

==== Add_Landmark ====

[[visual3d:documentation:pipeline:model_commands:add_landmark]]

== Add_Landmark_from_Event ==

[[visual3d:documentation:pipeline:model_commands:add_landmark_from_event]]

== Add_Functional_Joint_Landmark ==

[[visual3d:documentation:pipeline:model_commands:add_functional_joint_landmark]]

== Modify_Landmark ==

[[visual3d:documentation:pipeline:model_commands:modify_landmark]]

== Associate_Functional_Joints_With_Files ==

[[visual3d:documentation:pipeline:model_commands:Associate_Functional_Joints_With_Files]]

Associate a movement trial with a Functional Landmark

== Associate_Digitizing_Landmarks_With_Files ==

[[visual3d:documentation:pipeline:model_commands:Associate_Digitizing_Landmarks_With_Files]]

Associate a movement trial with a Digitizing Landmark
===== Model Building =====

[[visual3d:documentation:pipeline:model_commands:Create_V3D_Model]]

[[visual3d:documentation:pipeline:model_commands:Build_Model]]

[[visual3d:documentation:pipeline:model_commands:Save_Model_Template]]

[[visual3d:documentation:pipeline:model_commands:Close_Calibration_File]]

[[visual3d:documentation:pipeline:model_commands:Set_Segment_Properties]]

[[visual3d:documentation:pipeline:model_commands:Set_Subject_Weight]]

[[visual3d:documentation:pipeline:model_commands:Set_Subject_Height]]

[[visual3d:documentation:pipeline:model_commands:Set_Model_Metric]]

[[visual3d:documentation:pipeline:model_commands:Pipeline Example using Create_Hybrid_Model]]

[[visual3d:documentation:pipeline:model_commands:Pipeline Example using Assign_Model_File]]

==== Get_Vicon_Model_Metric ====

===== Model Based Data Computation =====

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:SEGMENT_RESIDUAL|SEGMENT_RESIDUAL]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:SEG_CGPOSITION|SEG_CGPOSITION]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:SEG_PROXIMAL_JOINT|SEG_PROXIMAL_JOINT]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:SEG_DISTAL_JOINT|SEG_DISTAL_JOINT]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:COP_Path|COP_Path]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:GRF_DATA|GRF_Data]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:COP_MODEL_COG|COP_MODEL_COG]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:Joint_Angle|JOINT_ANGLE]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:Helical_Angle|HELICAL_ANGLE]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:Joint_Rotation|JOINT_ROTATION]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:JOINT_ACCELERATION_and_JOINT_ANGULAR_ACCELERATION|JOINT_ACCELERATION]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:JOINT_VELOCITY_and_JOINT_ANGULAR_VELOCITY|JOINT_VELOCITY]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:TARGET_PATH|TARGET_PATH]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:SEG_VELOCITY|SEG_VELOCITY]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:MODEL_COG|MODEL_COG]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:MODEL_COG_VELOCITY|MODEL_COG_VELOCITY]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:MUSCLE_LENGTH|MUSCLE_LENGTH]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:SEG_PROGRESSION_ANGLE|SEG_PROGRESSION_ANGLE]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:JOINT_FORCE|JOINT_FORCE]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:JOINT_MOMENT|JOINT_MOMENT]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:JOINT_POWER|JOINT_POWER]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:JOINT_POWER_SCALAR|JOINT_POWER_SCALAR]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:ROTATIONAL_ENERGY_SCALAR|ROTATIONAL_ENERGY_SCALAR]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:TRANSLATIONAL_ENERGY_SCALAR|TRANSLATIONAL_ENERGY_SCALAR]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:POTENTIAL_ENERGY|POTENTIAL_ENERGY]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:SEGMENT_ENERGY_TOTAL|SEGMENT_ENERGY_TOTAL]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:MODEL_ENERGY_SCALAR|MODEL_ENERGY_SCALAR]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:LINEAR_MOMENTUM|LINEAR_MOMENTUM]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:ANGULAR_MOMENTUM|ANGULAR_MOMENTUM]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:MODEL_ANGULAR_MOMENTUM|MODEL_ANGULAR_MOMENTUM]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:MODEL_MOMENT_OF_INERTIA|MODEL_MOMENT_OF_INERTIA]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:UD_POWER|UD_POWER]]

[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:Joint_Work|Joint_Work]]