Differences

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

--- visual3d:documentation:pipeline:model_based_data_commands:compute_model_based_data [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:model_based_data_commands:compute_model_based_data [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{{{{{==== compute_model_based_data ====
+====== Compute Model Based Data ======
-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.
+=== Compute_Model_Based_Data ===
+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>
-compute_model_based_data
+Compute_Model_Based_Data
-/result_name=
+/RESULT_NAME=
-/function=
+/FUNCTION=
-/segment=
+/SEGMENT=
-! /reference_segment=lab
+! /REFERENCE_SEGMENT=LAB
-! /resolution_coordinate_system=lab
+! /RESOLUTION_COORDINATE_SYSTEM=LAB
-! /use_cardan_sequence=false
+! /USE_CARDAN_SEQUENCE=FALSE
-! /normalization=false
+! /NORMALIZATION=FALSE
-! /normalization_method=
+! /NORMALIZATION_METHOD=
-! /normalization_metric=
+! /NORMALIZATION_METRIC=
-! /negatex=false
+! /NEGATEX=FALSE
-! /negatey=false
+! /NEGATEY=FALSE
-! /negatez=false
+! /NEGATEZ=FALSE
-! /axis1=x
+! /AXIS1=X
-! /axis2=y
+! /AXIS2=Y
-! /axis3=z
+! /AXIS3=Z
 ;
 </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.
+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.
-compute_model_based_data.jpg
+{{:Compute_Model_Based_Data.jpg}}
-for example, the right knee angle signal could be represented as:
+For example, the Right Knee Angle signal could be represented as:
-rightkneeangle2.jpg
+{{:RightKneeAngle2.jpg}}
-if the text representation of this signal is opened, the following information will be stored
+If the text representation of this signal is opened, the following information will be stored
 <code>
-compute_model_based_data
+Compute_Model_Based_Data
-/result_name=right knee angle
+/RESULT_NAME=Right Knee Angle
-/function=joint_angle
+/FUNCTION=JOINT_ANGLE
-/segment=rsk
+/SEGMENT=RSK
-/reference_segment=rth
+/REFERENCE_SEGMENT=RTH
-/resolution_coordinate_system=
+/RESOLUTION_COORDINATE_SYSTEM=
-! /use_cardan_sequence=false
+! /USE_CARDAN_SEQUENCE=FALSE
-! /normalization=false
+! /NORMALIZATION=FALSE
-! /normalization_method=false
+! /NORMALIZATION_METHOD=FALSE
-! /normalization_metric=
+! /NORMALIZATION_METRIC=
-! /negatex=false
+! /NEGATEX=FALSE
-! /negatey=false
+! /NEGATEY=FALSE
-! /negatez=false
+! /NEGATEZ=FALSE
-! /axis1=x
+! /AXIS1=X
-! /axis2=y
+! /AXIS2=Y
-! /axis3=z
+! /AXIS3=Z
 ;
 </code>
-what is notable is that the segments are identified as **rsk** and **rth**, not **right shank** and **right thigh** as seen in the dialog.
+What is notable is that the segments are identified as **RSK** and **RTH**, not **Right Shank** and **Right Thigh** as seen in the dialog.
+In other words, it appears that the dialog was created as follows:
-in other words, it appears that the dialog was created as follows:
+{{:RightKneeAngle1.jpg}}
-rightkneeangle1.jpg
+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.**
-**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.**
-}}}}}}