Differences

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

--- visual3d:documentation:pipeline:signal_commands:create_target [2024/06/19 12:53] – sgranger
+++ visual3d:documentation:pipeline:signal_commands:create_target [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-in visual3d version 5.02.07 we introduced a command to add a new original target to the workspace.
+====== Create Target ======
-**create_target**
+In Visual3D Version 5.02.07 we introduced a command to add a new ORIGINAL TARGET to the workspace.
-/signal_names=
-! /signal_description=
+**Create_Target**
-/expression=
+/SIGNAL_NAMES=
+! /SIGNAL_DESCRIPTION=
+/EXPRESSION=
 **;**
-the expression can be any expression that produces a signal that has at least 3 components. the first 3 components will be used for the target.
+The Expression can be any expression that produces a signal that has at least 3 components. The first 3 components will be used for the TARGET.
-if the signal has one frame of data, all mocap frames will be populated with this value.
+If the signal has one frame of data, all MoCap frames will be populated with this value.
-**create_target**
+**Create_Target**
-/signal_names=test1
+/SIGNAL_NAMES=TEST1
-! /signal_description=
+! /SIGNAL_DESCRIPTION=
-/expression=0.2*metric::normal::pedal
+/EXPRESSION=0.2*METRIC::NORMAL::PEDAL
 **;**
-if the signal has multiple frames, all frames will be populated up to the number of mocap frames.
+If the signal has multiple frames, all frames will be populated up to the number of MoCap frames.
-if there are fewer frames than mocap frames, the target will be buffered with unreliable data.
+If there are fewer frames than MoCap frames, the target will be buffered with unreliable data.
-**create_target**
+**Create_Target**
-/signal_names=test2
+/SIGNAL_NAMES=TEST2
-! /signal_description=
+! /SIGNAL_DESCRIPTION=
-/expression=0.5*(target::original::rft1+target::original::rft2)
+/EXPRESSION=0.5*(TARGET::ORIGINAL::RFT1+TARGET::ORIGINAL::RFT2)
 **;**
 \\
-====== example: virtual lab ======
+===== Example: Virtual Lab =====
-===== background =====
+==== Background ====
-the following example creates a virtual lab that can have **4 principal directions** depending on the walking direction in the movement trial. unlike the method for two directions, this method will only work for one direct per movement trial (e.g. the subject cannot walk back and forth in the same trial). it will, however, allow a virtual lab to have different orientations for each movement trial.
+The following example creates a virtual lab that can have **4 principal directions** depending on the walking direction in the movement trial. Unlike the method for two directions, this method will only work for one direct per movement trial (e.g. the subject cannot walk back and forth in the same trial). It will, however, allow a virtual lab to have different orientations for each movement trial.
-for the [[visual3d:tutorials:modeling:virtual_laboratory_#example:_creating_a_virtual_laboratory_that_changes_with_the_direction_of_walking|dynamic virtual lab]], the subject may walk in the positive/negative direction of one of the principal axes of the lab (example: y). this example, allows the user to walk along the positive/negative direction of two of the principal axes of the lab (example: x or y)
+For the [[Visual3D:Tutorials:Modeling:Virtual_Laboratory_#Example:_Creating_a_virtual_laboratory_that_changes_with_the_direction_of_walking|Dynamic Virtual Lab]], the subject may walk in the positive/negative direction of one of the principal axes of the lab (example: Y). This example, allows the user to walk along the positive/negative direction of two of the principal axes of the lab (example: X or Y)
-to complete this tutorial, a static trial with the typical [[visual3d:tutorials:modeling:virtual_laboratory_#example:_creating_a_virtual_laboratory_that_changes_with_the_direction_of_walking|dynamic lab]] should be created. you can download an example of this [[http://c-motion.com/download/examples/virtuallab/dynamicvirtuallab.cmo|here]]. you will notice that the virtual lab rotates in the dynamic trial and is created correctly when the subject is facing along the +y/-y axis, but is created incorrectly when the subject is facing the +x/-x. if the following script is run, the virtual lab will be created correctly regardless of the subject's direction. a completed cmo file can be downloaded [[http://c-motion.com/download/examples/virtuallab/dynamicvirtuallab_complete.cmo|here]].
+To complete this tutorial, a static trial with the typical [[Visual3D:Tutorials:Modeling:Virtual_Laboratory_#Example:_Creating_a_virtual_laboratory_that_changes_with_the_direction_of_walking|Dynamic Lab]] should be created. You can download an example of this [[http://c-motion.com/download/examples/VirtualLab/DynamicVirtualLab.cmo|here]]. You will notice that the virtual lab rotates in the dynamic trial and is created correctly when the subject is facing along the +Y/-Y axis, but is created incorrectly when the subject is facing the +X/-X. If the following script is run, the virtual lab will be created correctly regardless of the subject's direction. A completed CMO file can be downloaded [[http://c-motion.com/download/examples/VirtualLab/DynamicVirtualLab_Complete.cmo|here]].
-===== script =====
+==== Script ====
-this pipeline should be run immediately after the model_template has been applied (at least in this example).
+This pipeline should be run immediately after the model_template has been applied (at least in this example).
-the script below can also be downloaded as a v3s file [[http://c-motion.com/download/examples/virtuallab/createlateral.v3s|here]].
+The script below can also be downloaded as a v3s file [[http://c-motion.com/download/examples/VirtualLab/CreateLateral.v3s|here]].
-a virtual lab was created with a landmark named lab_lateral
+A virtual lab was created with a LANDMARK named LAB_LATERAL
 <code>
-! a unit vector is defined between the right and left hip landmarks,
+! A unit vector is defined between the right and left hip landmarks,
-!   then rounded to yield 4 possible solutions ( +/- x-axis and +/- y-axis)
+!   then rounded to yield 4 possible solutions ( +/- X-axis and +/- y-axis)
-! a target is created that contains that unit_vector at every frame of data.
+! A target is created that contains that unit_vector at every frame of data.
-!!the virtual_lab will be tracked by the new target.
+!!The virtual_lab will be tracked by the new TARGET.
- ! create a unit vector between left and right hips
+ ! Create a unit vector between left and right hips
-evaluate_expression
+Evaluate_Expression
-/expression=unit_vector(
+/EXPRESSION=UNIT_VECTOR(
-(landmark::original::right_hip::x-landmark::original::left_hip::x),
+(LANDMARK::ORIGINAL::RIGHT_HIP::X-LANDMARK::ORIGINAL::LEFT_HIP::X),
-(landmark::original::right_hip::y-landmark::original::left_hip::y),
+(LANDMARK::ORIGINAL::RIGHT_HIP::Y-LANDMARK::ORIGINAL::LEFT_HIP::Y),
-(landmark::original::right_hip::z-landmark::original::left_hip::z))
+(LANDMARK::ORIGINAL::RIGHT_HIP::Z-LANDMARK::ORIGINAL::LEFT_HIP::Z))
-! /signal_types=
+! /SIGNAL_TYPES=
-! /signal_folder=original
+! /SIGNAL_FOLDER=ORIGINAL
-! /signal_names=
+! /SIGNAL_NAMES=
-! /result_types=derived
+! /RESULT_TYPES=DERIVED
-/result_folders=virtual_lab
+/RESULT_FOLDERS=VIRTUAL_LAB
-/result_name=hip_vector
+/RESULT_NAME=HIP_VECTOR
-! /apply_as_suffix_to_signal_name=false
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
 ;
 ! compute the median value of the unit vector
-metric_median
+Metric_Median
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/result_metric_name=_med
+/RESULT_METRIC_NAME=_MED
-! /apply_as_suffix_to_signal_name=false
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
-/signal_types=derived
+/SIGNAL_TYPES=DERIVED
-/signal_folder=virtual_lab
+/SIGNAL_FOLDER=VIRTUAL_LAB
-/signal_names=hip_vector
+/SIGNAL_NAMES=HIP_VECTOR
-/component_sequence=all
+/COMPONENT_SEQUENCE=ALL
-/event_sequence=
+/EVENT_SEQUENCE=
-/exclude_events=
+/EXCLUDE_EVENTS=
-/sequence_percent_start=
+/SEQUENCE_PERCENT_START=
-/sequence_percent_end=
+/SEQUENCE_PERCENT_END=
-/generate_mean_and_stddev=false
+/GENERATE_MEAN_AND_STDDEV=FALSE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
 ;
 ! round the floats to an integer
-evaluate_expression
+Evaluate_Expression
-/expression=round(metric::virtual_lab::hip_vector_med)
+/EXPRESSION=ROUND(METRIC::VIRTUAL_LAB::HIP_VECTOR_MED)
-! /signal_types=
+! /SIGNAL_TYPES=
-! /signal_folder=original
+! /SIGNAL_FOLDER=ORIGINAL
-! /signal_names=
+! /SIGNAL_NAMES=
-/result_types=metric
+/RESULT_TYPES=METRIC
-/result_folders=virtual_lab
+/RESULT_FOLDERS=VIRTUAL_LAB
-/result_name=lab_lateral
+/RESULT_NAME=LAB_LATERAL
-! /apply_as_suffix_to_signal_name=false
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
 ;
-! create a new target that has the rounded unit vector at every frame.
+! create a new TARGET that has the rounded unit vector at every frame.
-create_target
+Create_Target
-/signal_names=lab_lateral
+/SIGNAL_NAMES=LAB_LATERAL
-! /signal_description=
+! /SIGNAL_DESCRIPTION=
-/expression=metric::virtual_lab::lab_lateral
+/EXPRESSION=METRIC::VIRTUAL_LAB::LAB_LATERAL
 ;
  ! if you are testing, you will need to recalc to update the virtual lab.
-recalc
+Recalc
 ;
 </code>