visual3d:documentation:pipeline:model_commands:modeling_commands
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| visual3d:documentation:pipeline:model_commands:modeling_commands [2024/06/19 14:02] – created sgranger | visual3d:documentation:pipeline:model_commands:modeling_commands [2024/07/17 15:46] (current) – created sgranger | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== Modeling Commands ====== | ||
| + | |||
| This page lists several pipeline commands related to modeling. In addition, two examples are presented. | This page lists several pipeline commands related to modeling. In addition, two examples are presented. | ||
| - | ===== Commands | + | ==== Commands ==== |
| The commands related to modeling are listed here along with a description of their parameters. The list is not all inclusive. | The commands related to modeling are listed here along with a description of their parameters. The list is not all inclusive. | ||
| - | ==== Add_Landmark | + | === Add_Landmark === |
| Landmarks (Virtual Markers) are typically added to the model template, but all model commands are also available as pipeline commands. | Landmarks (Virtual Markers) are typically added to the model template, but all model commands are also available as pipeline commands. | ||
| - | ==== 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, | This command is based on: **Schwartz MH, Rozumalski A** (2005) A new method for estimating joint parameters from motion data. Journal of Biomechanics, | ||
| Line 37: | Line 39: | ||
| * 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. | * 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 | + | === 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. | 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. | ||
| Line 49: | Line 51: | ||
| **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. | ||
| Line 61: | Line 63: | ||
| </ | </ | ||
| - | ==== Apply_Model_Template | + | === Apply_Model_Template === |
| Apply a Model Template to a Model (Calibration File). | Apply a Model Template to a Model (Calibration File). | ||
| Line 76: | Line 78: | ||
| **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. | ||
| Line 98: | Line 100: | ||
| </ | </ | ||
| - | ==== Close_Calibration_File | + | === Close_Calibration_File === |
| Close an open model and calibration file. | Close an open model and calibration file. | ||
| Line 108: | Line 110: | ||
| </ | </ | ||
| - | ==== 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: | ||
| Line 135: | Line 137: | ||
| </ | </ | ||
| - | ==== 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. | ||
| Line 164: | Line 166: | ||
| </ | </ | ||
| - | ==== 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. | ||
| Line 193: | Line 195: | ||
| </ | </ | ||
| - | ==== 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. | ||
| Line 207: | Line 209: | ||
| </ | </ | ||
| - | ===== 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 === |
| < | < | ||
| Line 233: | Line 235: | ||
| </ | </ | ||
| - | ==== Pipeline Example using Assign_Model_File | + | === Pipeline Example using Assign_Model_File === |
| < | < | ||
visual3d/documentation/pipeline/model_commands/modeling_commands.1718805734.txt.gz · Last modified: 2024/06/19 14:02 by sgranger