Differences

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

--- visual3d:documentation:pipeline:model_commands:modeling_commands [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:model_commands:modeling_commands [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-this page lists several pipeline commands related to modeling. in addition, two examples are presented.
+====== Modeling Commands ======
-===== commands =====
+This page lists several pipeline commands related to modeling. In addition, two examples are presented.
-the commands related to modeling are listed here along with a description of their parameters. the list is not all inclusive.
+==== Commands ====
-==== add_landmark ====
+The commands related to modeling are listed here along with a description of their parameters. The list is not all inclusive.
-landmarks (virtual markers) are typically added to the model template, but all model commands are also available as pipeline commands.
+=== Add_Landmark ===
-==== add_functional_joint_landmark ====
+Landmarks (Virtual Markers) are typically added to the model template, but all model commands are also available as pipeline commands.
-this command is based on: **schwartz mh, rozumalski a** (2005) a new method for estimating joint parameters from motion data. journal of biomechanics, 38, 107-116
+=== Add_Functional_Joint_Landmark ===
-|**add_functional_joint_landmark**            |                                                                                                                                                                                                                                        |
+This command is based on: **Schwartz MH, Rozumalski A** (2005) A new method for estimating joint parameters from motion data. Journal of Biomechanics, 38, 107-116
-|**/landmark_name=**                          |the name of the landmark to be created.                                                                                                                                                                                                 |
-|**/calibration_file=**                       |the name of the hybrid model. use the full pathname.                                                                                                                                                                                    |
-|**/reference_segment=**                      |the joint landmark is created relative to an existing segment. for example, for the hip joint center, the pelvis is used.                                                                                                               |
-|**/reference_types=**                        |the types of reference markers used for defining the landmark.                                                                                                                                                                          |
-|**/reference_names=**                        |the names of reference markers used for defining the landmark                                                                                                                                                                           |
-|**/signal_types=**                           |the types of signals used for the tracking markers.                                                                                                                                                                                     |
-|**/signal_names=**                           |the names of signals used for the tracking markers. any number of tracking markers may be used.                                                                                                                                         |
-|**/signal_folder=**                          |the folders for signals used for the tracking markers.                                                                                                                                                                                  |
-|**/motion_file=**                            |the full pathname of the motion file used. this command allows only one movement file to be used. the user should make sure that a full range of motion about all axes is contained in one file.                                        |
-|**/event_start=**                            |the start frame for the range of data to be used.                                                                                                                                                                                       |
-|**/event_stop=**                             |the stop frame for the range of frames of data to use.                                                                                                                                                                                  |
-|**/minimum_helical_rotation_accepted=**      |any combination of three frames for which the helical rotation angle is less than 5 degrees are rejected                                                                                                                                |
-|**/create_100_representative_landmarks=**    |a random selection of the intermediate centers of rotation will be saved as landmarks.                                                                                                                                                  |
-|**/approximate_number_of_combinations_used=**|if there are a large number of frames of data, the possible combinations of 3 frames becomes very big. the can specify an estimate of the number of combination used (these are selected randomly from the total number of combinations)|
-|**/search_radius=**                          |only centers of rotation within the search radius are used for the mean value.                                                                                                                                                          |
-|**/rate_of_volume_reduction=**               |the rate at which the domain of possible solutions is reduced.                                                                                                                                                                          |
-|**/number_of_iterations_reducing_radius=**   |the number of times the radius is reduced. at each iteration the cell containing the most crossings is used as the center for the next iteration.                                                                                       |
-this command was changed for visual3d version 3.83 to allow the specification of **reference markers** instead of **reference segment**.
+|**Add_Functional_Joint_Landmark**            |                                                                                                                                                                                                                                        |
+|**/LANDMARK_NAME=**                          |The name of the landmark to be created.                                                                                                                                                                                                 |
+|**/CALIBRATION_FILE=**                       |The name of the hybrid model. Use the full pathname.                                                                                                                                                                                    |
+|**/REFERENCE_SEGMENT=**                      |The joint landmark is created relative to an existing segment. For example, for the hip joint center, the pelvis is used.                                                                                                               |
+|**/REFERENCE_TYPES=**                        |The types of reference markers used for defining the landmark.                                                                                                                                                                          |
+|**/REFERENCE_NAMES=**                        |The names of reference markers used for defining the landmark                                                                                                                                                                           |
+|**/SIGNAL_TYPES=**                           |The types of signals used for the tracking markers.                                                                                                                                                                                     |
+|**/SIGNAL_NAMES=**                           |The names of signals used for the tracking markers. Any number of tracking markers may be used.                                                                                                                                         |
+|**/SIGNAL_FOLDER=**                          |The folders for signals used for the tracking markers.                                                                                                                                                                                  |
+|**/MOTION_FILE=**                            |The full pathname of the motion file used. This command allows only one movement file to be used. The user should make sure that a full range of motion about all axes is contained in one file.                                        |
+|**/EVENT_START=**                            |The start frame for the range of data to be used.                                                                                                                                                                                       |
+|**/EVENT_STOP=**                             |The stop frame for the range of frames of data to use.                                                                                                                                                                                  |
+|**/MINIMUM_HELICAL_ROTATION_ACCEPTED=**      |Any combination of three frames for which the helical rotation angle is less than 5 degrees are rejected                                                                                                                                |
+|**/CREATE_100_REPRESENTATIVE_LANDMARKS=**    |A random selection of the intermediate Centers of Rotation will be saved as Landmarks.                                                                                                                                                  |
+|**/APPROXIMATE_NUMBER_OF_COMBINATIONS_USED=**|If there are a large number of frames of data, the possible combinations of 3 frames becomes very big. The can specify an estimate of the number of combination used (these are selected randomly from the total number of combinations)|
+|**/SEARCH_RADIUS=**                          |Only Centers of Rotation within the search radius are used for the mean value.                                                                                                                                                          |
+|**/RATE_OF_VOLUME_REDUCTION=**               |The rate at which the domain of possible solutions is reduced.                                                                                                                                                                          |
+|**/NUMBER_OF_ITERATIONS_REDUCING_RADIUS=**   |The number of times the radius is reduced. At each iteration the cell containing the most crossings is used as the center for the next iteration.                                                                                       |
-  * if a reference segment is specified, the landmark will be created relative to that segment.
+This command was changed for Visual3D Version 3.83 to allow the specification of **REFERENCE MARKERS** instead of **REFERENCE SEGMENT**.
-  * if no reference segment is specified, the landmark will be created relative to the first three reference markers (e.g. a technical coordinate system will be created from these markers). if more than 3 reference markers are specified, visual3d will use all reference markers to track the technical coordinate system.
-==== create_v3d_model ====
+  * If a Reference Segment is specified, the landmark will be created relative to that segment.
+  * If no Reference Segment is specified, the landmark will be created relative to the first three REFERENCE MARKERS (e.g. a Technical Coordinate System will be created from these markers). If more than 3 REFERENCE MARKERS are specified, Visual3D will use all REFERENCE MARKERS to track the Technical Coordinate System.
-create a visual3d 6 degree of freedom model. this is the legacy visual3d model which was developed in collaboration with the national institutes of health, physical disabilities branch. it is currently considered a legacy model because all of the features of this model are incorporated in the visual3d hybrid model.
+=== Create_V3D_Model ===
+Create a Visual3D 6 degree of freedom model. This is the legacy Visual3D model which was developed in collaboration with the National Institutes of Health, Physical Disabilities Branch. It is currently considered a legacy model because all of the features of this model are incorporated in the Visual3D hybrid model.
 <code>
-create_v3d_model
+Create_V3D_Model
-! /calibration_file= the name of the c3d file for the static trial
+! /CALIBRATION_FILE= the name of the c3d file for the static trial
 ;
 </code>
-**note: wildcards (*) can be used for the calibration_file name**
+**Note: Wildcards (*) can be used for the Calibration_File name**
-==== build_model ====
+=== Build_Model ===
-in some circumstances visual3d does not automatically rebuild the model. for example, landmarks that have been added by a script command do not automatically rebuild the model because sometimes there may be several landmark commands in sequence and rebuilding the model would slow done the processing of the pipeline. the command **build_model** will build the model.
+In some circumstances Visual3D does not automatically rebuild the model. For example, landmarks that have been added by a script command do not automatically rebuild the model because sometimes there may be several landmark commands in sequence and rebuilding the model would slow done the processing of the pipeline. The command **Build_Model** will build the model.
 <code>
-build_model
+Build_Model
-! /calibration_file=  the name of the standing trial associated with the model
+! /CALIBRATION_FILE=  The name of the standing trial associated with the model
-! /rebuild_all_models= true or false to rebuild all models
+! /REBUILD_ALL_MODELS= TRUE or FALSE to rebuild all models
-! /display_results=  true or false to display results
+! /DISPLAY_RESULTS=  TRUE or FALSE to display results
 ;
 </code>
-==== apply_model_template ====
+=== Apply_Model_Template ===
-apply a model template to a model (calibration file).
+Apply a Model Template to a Model (Calibration File).
 <code>
-apply_model_template
+Apply_Model_Template
-/model_template=  the name of the model template
+/MODEL_TEMPLATE=  The name of the model template
-/calibration_file=  the name of the standing trial associated with the model
+/CALIBRATION_FILE=  The name of the standing trial associated with the model
 ;
 </code>
-**note:** wildcards (*) can be used for file_name and model_name.
+**NOTE:** Wildcards (*) can be used for FILE_NAME and MODEL_NAME.
-**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.
+**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.
-==== save_model_template ====
+=== Save_Model_Template ===
-this command saves the specified link model to a template.
+This command saves the specified link model to a template.
 <code>
-save_model_template
+Save_Model_Template
-/calibration_file=  the name of the standing trial associated with the model
+/CALIBRATION_FILE=  The name of the standing trial associated with the model
-/model_template= the name of the model template
+/MODEL_TEMPLATE= The name of the model template
 ;
 </code>
-**note:** you can use a wildcard for the calibration_file but you must specify the full model template name.
+**NOTE:** You can use a wildcard for the calibration_file but you must specify the full model template name.
-an example,
+An example,
 <code>
-save_model_template
+Save_Model_Template
-/calibration_file=*1.c3d
+/CALIBRATION_FILE=*1.c3d
-/model_template=c:\visual3d\data\template.mdh
+/MODEL_TEMPLATE=C:\Visual3D\Data\template.mdh
 ;
 </code>
-==== close_calibration_file ====
+=== Close_Calibration_File ===
-close an open model and calibration file.
+Close an open model and calibration file.
 <code>
-close_calibration_file
+Close_Calibration_File
-/calibration_file= the name of the standing trial associated with the model
+/Calibration_File= The name of the standing trial associated with the model
 ;
 </code>
-==== set_segment_properties ====
+=== Set_Segment_Properties ===
-sets the inertial properties of a segment. the command allows the user to set the variable value as an expression. for example, the mass could be represented as:
+Sets the inertial properties of a segment. The command allows the user to set the variable value as an expression. For example, the mass could be represented as:
-/mass=0.12*mass
+/MASS=0.12*Mass
-where mass is a subject property that has already been defined. the user can set one or all of the properties with this command (a blank entry is ignored).
+where Mass is a subject property that has already been defined. The user can set one or all of the properties with this command (a blank entry is ignored).
 <code>
-set_segment_properties
+Set_Segment_Properties
-/calibration_file=
+/CALIBRATION_FILE=
-/segment_name=
+/SEGMENT_NAME=
-! /kinematic_only=
+! /KINEMATIC_ONLY=
-! /mass=
+! /MASS=
-! /cg_from_prox_axial=
+! /CG_FROM_PROX_AXIAL=
-! /cg_from_prox_ml=
+! /CG_FROM_PROX_ML=
-! /cg_from_prox_ap=
+! /CG_FROM_PROX_AP=
-! /inertia_xx=
+! /INERTIA_XX=
-! /inertia_yy=
+! /INERTIA_YY=
-! /inertia_zz=
+! /INERTIA_ZZ=
-! /ap_direction=
+! /AP_DIRECTION=
-! /axial_direction=
+! /AXIAL_DIRECTION=
-! /model_file=
+! /MODEL_FILE=
-! /material_file=
+! /MATERIAL_FILE=
 ;
 </code>
-==== set_subject_weight ====
+=== Set_Subject_Weight ===
-set the weight of the subject (kgs). if no link_model (calibration file) is specified, the current model is used. if no weight is specified, a dialog pops up.
+Set the weight of the subject (kgs). If no LINK_MODEL (Calibration File) is specified, the current model is used. If no Weight is specified, a dialog pops up.
 <code>
-set_subject_weight
+Set_Subject_Weight
-/calibration_file= the name of the link model (standing trial)
+/Calibration_File= The name of the link model (standing trial)
-/weight= weight
+/Weight= Weight
 ;
 </code>
-**note:** if the model is a hybrid model, the weight parameter can be an expression (e.g. a model metric).
+**NOTE:** If the model is a hybrid model, the Weight parameter can be an expression (e.g. a Model Metric).
-for example, the user enters the weight of the subject in pounds using a pipeline parameter. this can be converted to newtons for the model.
+For example, the user enters the Weight of the subject in pounds using a pipeline parameter. This can be converted to Newtons for the model.
 <code>
-prompt_for_pipeline_parameter_value
+Prompt_For_Pipeline_Parameter_Value
-/pipeline_parameter_name= weight
+/PIPELINE_PARAMETER_NAME= WEIGHT
-/prompt= enter the weight of the subject in pounds
+/PROMPT= Enter the Weight of the Subject in Pounds
-/data_type=string
+/DATA_TYPE=STRING
-/default_value=1
+/DEFAULT_VALUE=1
 ;
-set_subject_weight
+Set_Subject_Weight
-/calibration_file=
+/Calibration_File=
-/weight= ::weight/2.2
+/Weight= ::WEIGHT/2.2
 ;
 </code>
-==== set_subject_height ====
+=== Set_Subject_Height ===
-set the height of the subject (m). if no link_model (calibration file) is specified, the current model is used. if no height is specified, a dialog pops up.
+Set the height of the subject (m). If no LINK_MODEL (Calibration File) is specified, the current model is used. If no Height is specified, a dialog pops up.
 <code>
-set_subject_height
+Set_Subject_Height
-/calibration_file= the name of the link model (standing trial)
+/Calibration_File= The name of the link model (standing trial)
-/height= height
+/Height= Height
 ;
 </code>
-**note:** if the model is a hybrid model, the height parameter can be an expression (e.g. a model metric).
+**NOTE:** If the model is a hybrid model, the Height parameter can be an expression (e.g. a Model Metric).
-for example, the user enters the height of the subject in inches using a pipeline parameter. this can be converted to meters for the model.
+For example, the user enters the Height of the subject in inches using a pipeline parameter. This can be converted to meters for the model.
 <code>
-prompt_for_pipeline_parameter_value
+Prompt_For_Pipeline_Parameter_Value
-/pipeline_parameter_name= height
+/PIPELINE_PARAMETER_NAME= HEIGHT
-/prompt= enter the height of the subject in inches
+/PROMPT= Enter the Height of the Subject in Inches
-/data_type=string
+/DATA_TYPE=STRING
-/default_value=60
+/DEFAULT_VALUE=60
 ;
-set_subject_height
+Set_Subject_Height
-/calibration_file=
+/Calibration_File=
-/height= ::height/39.4
+/Height= ::HEIGHT/39.4
 ;
 </code>
-==== set_model_metric ====
+=== Set_Model_Metric ===
-this command was originally part of the model template in visual3d. in version 4.0 this command will be expanded for general use. this is a convenient way for the user to interact with the model by entering values in a popup dialog rather than by editing the model in model builder mode. this command is a good way to add in a metric that is used in your model.
+This command was originally part of the model template in Visual3D. In version 4.0 this command will be expanded for general use. This is a convenient way for the user to interact with the model by entering values in a popup dialog rather than by editing the model in model builder mode. This command is a good way to add in a metric that is used in your model.
-the following example will set the proximal radius for the right thigh segment to 0.1
+The following example will set the proximal radius for the right thigh segment to 0.1
 <code>
-set_model_metric
+Set_Model_Metric
-! /calibration_file=
+! /CALIBRATION_FILE=
-/metric_name=rth_distal_radius
+/METRIC_NAME=RTH_Distal_Radius
-/metric_value=0.1
+/METRIC_VALUE=0.1
 ;
 </code>
-===== examples =====
+==== Examples ====
-here are two examples utilizing pipeline modeling commands.
+Here are two examples utilizing pipeline modeling commands.
-==== pipeline example using create_hybrid_model ====
+=== Pipeline Example using Create_Hybrid_Model ===
 <code>
 !***********************************************
-! create hybrid model example script
+! Create Hybrid model example script
 !***********************************************
-set_pipeline_parameter_to_folder_path
+Set_Pipeline_Parameter_To_Folder_Path
-/parameter_name=folder
+/PARAMETER_NAME=FOLDER
-/parameter_value=c:\visual3d\data\
+/PARAMETER_VALUE=c:\Visual3D\Data\
 ;
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=standing
+/PARAMETER_NAME=STANDING
-/parameter_value=::folder&*static.c3d
+/PARAMETER_VALUE=::FOLDER&*static.c3d
 ;
-create_hybrid_model
+Create_Hybrid_Model
-/calibration_file=::standing
+/CALIBRATION_FILE=::STANDING
 ;
 </code>
-==== pipeline example using assign_model_file ====
+=== Pipeline Example using Assign_Model_File ===
 <code>
 !***********************************************
-! assign model example script
+! Assign model example script
 !***********************************************
-set_pipeline_parameter_to_folder_path
+Set_Pipeline_Parameter_To_Folder_Path
-/parameter_name=folder
+/PARAMETER_NAME=FOLDER
-/parameter_value=c:\visual3d\data\
+/PARAMETER_VALUE=c:\Visual3D\Data\
 ;
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=standing
+/PARAMETER_NAME=STANDING
-/parameter_value=::folder&*static.c3d
+/PARAMETER_VALUE=::FOLDER&*static.c3d
 ;
-create_hybrid_model
+Create_Hybrid_Model
-/calibration_file=::standing
+/CALIBRATION_FILE=::STANDING
 ;
-set_pipeline_parameter
+Set_Pipeline_Parameter
-/parameter_name=walking
+/PARAMETER_NAME=WALKING
-/parameter_value=::folder&*walk*.c3d
+/PARAMETER_VALUE=::FOLDER&*walk*.c3d
 ;
-! prompt for the movement data files.
+! Prompt for the Movement data files.
-! multiple files can be selected in the dialog file listing using ctrl-click
+! Multiple files can be selected in the dialog file listing using CTRL-Click
-open_file
+Open_File
-! /file_name=
+! /FILE_NAME=
 ;
-assign_model_file
+Assign_Model_File
-/calibration_file=::standing
+/CALIBRATION_FILE=::STANDING
-/motion_file_names=::walking
+/MOTION_FILE_NAMES=::WALKING
 ;
 </code>