This is an old revision of the document!

Model Commands Overview

Model_Management

Apply_Model_Template - Apply a Model Template to a Model

Apply a Model Template to a Model (Calibration File).

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

Apply_Model_Template

/MODEL_TEMPLATE=

/CALIBRATION_FILE=

;

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.

An example of a script is found below:

!**********************************************

! Apply Model Template

!**********************************************

! 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

;

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)

\\ Close_Model_File \\ /Close_Calibration_File= \\ ;\\

For example, to close all movement trials containing the string “standing”

\\ Close_Model_File \\ /Close_Calibration_File= *standing*.c3d\\ ;\\

Assign_Model_File - Assign a Model to a Movement File

This command assigns a model to specified movement files.

\\ 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.\\ ;\\

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:

\\ 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\\ ;\\

Here is the same example, using wild cards in the Assign Model File command:

\\ Assign_Model_File\\ /CALIBRATION_FILE=*static.c3d\\ /MOTION_FILE_NAMES=*walk*.c3d\\ ;\\

Another example can be found on Pipeline Example using Assign Model File

Create_Hybrid_Model - Create a Visual3D Hybrid Model

Create a Visual3D 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.

\\ 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

\\ ;\\

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:

\\ 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\\ ;\\

Another example can be found on Pipeline Example using Create Hybrid Model

Append Model Template

Append a template to an existing model.

Append_Model_Template ! /CALIBRATION_FILE= ! /MODEL_TEMPLATE= ! /VIEW_BUILDMODEL_RESULTS=2 ;

HAS-Motion Software Documentation

Table of Contents

Model Commands Overview

Model_Management

Modeling

Add_Landmark

Add_Landmark_from_Event

Add_Functional_Joint_Landmark

Modify_Landmark

Associate_Functional_Joints_With_Files

Associate_Digitizing_Landmarks_With_Files

Model Building

Create_V3D_Model

Build_Model

Save_Model_Template

Close_Calibration_File

Set_Segment_Properties

Set_Subject_Weight

Set_Subject_Height

Set_Model_Metric

Pipeline Example using Create_Hybrid_Model

Pipeline Example using Assign_Model_File

Get_Vicon_Model_Metric

Model Based Data Computation