HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » model_based_data_commands » Compute Model Based Data
visual3d:documentation:pipeline:model_based_data_commands:compute_model_based_data

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
visual3d:documentation:pipeline:model_based_data_commands:compute_model_based_data [2024/07/17 15:46] – created sgrangervisual3d:documentation:pipeline:model_based_data_commands:compute_model_based_data [2025/05/15 13:58] (current) – Cleaned up page for a customer, notably adding subject tag information. Still needs to be put into Pipeline project format. wikisysop
Line 1: Line 1:
 ====== Compute Model Based Data ====== ====== Compute Model Based Data ======
  
-=== Compute_Model_Based_Data === +The **Compute_Model_Based_Data** command computes a [[Visual3D:Documentation:Visual3D_Signal_Types:LINK_MODEL_BASED_Data_Type#Link_Model_Based_Items|link-model based]] signal using a model's [[visual3d:documentation:modeling:segments:segment_overview|segments]] and [[visual3d:documentation:visual3d_signal_types:kinetic_kinematic_data_type|Kinetic_Kinematic]] data. This replicates the functionality of the model-based items dialog and can be thought of as encoding a particular model-based item's definition.
- +
-The command **Compute_Model_Based_Data** will compute a signal using a model's segment, Kinetic_Kinematic data. This is the same functionality as the interactive dialog for model based items. For a detailed description of the types of available functions see the [[Visual3D:Documentation:Visual3D_Signal_Types:LINK_MODEL_BASED_Data_Type#Link_Model_Based_Items|Link Model Based Items List]]. The order of rotation for the Cardan angles can be specified by the axes X, Y, or Z, or it can be specified by the Anatomical Axes ML, AP, or AXIAL.+
  
 <code> <code>
 Compute_Model_Based_Data Compute_Model_Based_Data
 /RESULT_NAME= /RESULT_NAME=
 +/SUBJECT_TAG=
 /FUNCTION= /FUNCTION=
 /SEGMENT= /SEGMENT=
Line 22: Line 21:
 ! /AXIS2=Y ! /AXIS2=Y
 ! /AXIS3=Z ! /AXIS3=Z
 +! /TREADMILL_DATA=FALSE
 +! /TREADMILL_DIRECTION=UNIT_VECTOR(0,1,0)
 +! /TREADMILL_SPEED=0.0
 ; ;
 </code> </code>
  
-This command structure is the same regardless of whether the command is in the Pipeline or RECALC Pipeline. When this signal is created, the definition of the model based item is stored automatically in the RECALC pipeline.+{{:visual3d_pipeline_workshop_compute_model_based_data.png}}
  
-{{:Compute_Model_Based_Data.jpg}}+===== Parameters ===== 
 + 
 +^ Parameter ^ Description ^ Default Value ^ 
 +| /RESULT_NAME | The name of the Link_Model_Based item. | | 
 +| /SUBJECT_TAG | The subject tag for the Link_Model_Based item. | The active Subject_Tag in the workspace. | 
 +| /FUNCTION | The [[[[Visual3D:Documentation:Visual3D_Signal_Types:LINK_MODEL_BASED_Data_Type#Link_Model_Based_Items|"type" of Link_Model_Based item]] to compute. | | 
 +| /SEGMENT | The Link_Model_Based item's segment in question. | | 
 +| /REFERENCE_SEGMENT | The Link_Model_Based item's reference segment. | The [[visual3d:documentation:definitions:laboratory_coordinate_system|LAB]] segment. | 
 +| /RESOLUTION_COORDINATE_SYSTEM | The coordinate system into which the Link_Model_Based item is resolved. | The LAB segment. | 
 +| /USE_CARDAN_SEQUENCE | Whether or not to use a [[visual3d:tutorials:kinematics_and_kinetics:model_based_computations#computing_joint_angles|Cardan sequence]]. | FALSE | 
 +| /NORMALIZATION | Whether or not to normalize the Link_Model_Based item. | FALSE | 
 +| /NORMALIZATION_METHOD | Which normalization method, if any, to use. | | 
 +| /NORMALIZATION_METRIC | Which metric, if any, to use as a normalization baseline. | | 
 +| /NEGATEX | Whether or not to negate the Link_Model_Based item's X-component. | FALSE | 
 +| /NEGATEY | Whether or not to negate the Link_Model_Based item's Y-component. | FALSE | 
 +| /NEGATEZ | Whether or not to negate the Link_Model_Based item's Z-component. | FALSE | 
 +| /AXIS1 | The first rotation axis for a Cardan sequence. | X | 
 +| /AXIS2 | The second rotation axis for a Cardan sequence. | Y | 
 +| /AXIS3 | The third rotation axis for a Cardan sequence. | Z | 
 +| /TREADMILL_DATA | Whether or not treadmill data is being used to calculate this Link_Model_Based item. | FALSE | 
 +| /TREADMILL_DIRECTION | If treadmill data is being used, the treadmill's direction of travel. | UNIT_VECTOR(0,1,0) | 
 +| /TREADMILL_SPEED | If treadmill data is being used, the treadmill's speed in m/s. | 0.0 | 
 + 
 + 
 +If Cardan angles are being used, then the order of rotation can be specified by the axes X, Y, and Z, or it can be specified by the anatomical axes ML, AP, and AXIAL. 
 + 
 +===== Model-based Items and the RECALC Pipeline ===== 
 + 
 +This command structure is the same regardless of whether the command is in the Pipeline or RECALC Pipeline. When this signal is created, the definition of the model-based item is stored automatically in the [[visual3d:documentation:pipeline:general_information:recalc_pipeline|RECALC pipeline]]. 
 + 
 +**Note that the command can be executed from the pipeline, but it isn't possible to execute the RECALC pipeline. This is a quirk of the default structure. The RECALC pipeline is executed by selected the RECALC button on the toolbar or executing the [[visual3d:documentation:pipeline:file_commands:recalc|Recalc]] command in the pipeline.** 
 + 
 +===== Example: Right Knee Angle =====
  
 For example, the Right Knee Angle signal could be represented as: For example, the Right Knee Angle signal could be represented as:
Line 63: Line 97:
 This is because the lower level representations are stored with the standard Visual3D acronyms (e.g. those names that are used under the covers), whereas the interface to Visual3D uses the names that are mapped by the config files. This is because the lower level representations are stored with the standard Visual3D acronyms (e.g. those names that are used under the covers), whereas the interface to Visual3D uses the names that are mapped by the config files.
  
-**Note that the command can be executed from the pipeline, but it isn't possible to execute the RECALC pipeline. This is a quirk of the default structure. The RECALC pipeline is executed by selected the RECALC button on the toolbar or executing the Recalc command in the pipeline.**+
  
  
  
visual3d/documentation/pipeline/model_based_data_commands/compute_model_based_data.txt · Last modified: 2025/05/15 13:58 by wikisysop