HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » metric_commands » Metric Compute Temporal Distance
visual3d:documentation:pipeline:metric_commands:metric_compute_temporal_distance

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
visual3d:documentation:pipeline:metric_commands:metric_compute_temporal_distance [2024/11/04 19:57] – [Temporal Distance Control Data] wikisysopvisual3d:documentation:pipeline:metric_commands:metric_compute_temporal_distance [2024/11/15 18:52] (current) – [Subject computation using subject name/prefix parameters] wikisysop
Line 3: Line 3:
 Compute the [[Visual3D:Documentation:Pipeline:Metric_Commands:Temporal_Distance_Calculations_for_Gait|Gait Temporal Distance]] values consistent with the Visual3D report item Compute the [[Visual3D:Documentation:Pipeline:Metric_Commands:Temporal_Distance_Calculations_for_Gait|Gait Temporal Distance]] values consistent with the Visual3D report item
  
-Note that the results consist of data from multiple files, so the results are stored in the [[Visual3D:Documentation:Definitions:Global_Workspace|Global_Workspace]]+Note that the results consist of data from multiple files, so the results are stored in the [[Visual3D:Documentation:Definitions:Global_Workspace|Global_Workspace]].
  
 The command acts on the [[Visual3D:Documentation:Definitions:Active_Files|Active_Files]]. The command acts on the [[Visual3D:Documentation:Definitions:Active_Files|Active_Files]].
  
 If, for example, you have two groups of files (e.g. 2 TAGS) and you want to compute temporal distance metrics independently for each group. If, for example, you have two groups of files (e.g. 2 TAGS) and you want to compute temporal distance metrics independently for each group.
- 
   * First, make one TAG active and set the output folder (GLOBAL_RESULT_METRIC_FOLDER) with a name reflecting the TAG.   * First, make one TAG active and set the output folder (GLOBAL_RESULT_METRIC_FOLDER) with a name reflecting the TAG.
   * Second, make the other TAG active and set a unique output folder.   * Second, make the other TAG active and set a unique output folder.
  
-\\ +===== Pipeline Command =====
- +
- +
-==== Pipeline Command ====+
  
 Command including default values. Command including default values.
Line 23: Line 19:
 ! /GLOBAL_RESULT_METRIC_FOLDER=TEMPORAL_DISTANCE ! /GLOBAL_RESULT_METRIC_FOLDER=TEMPORAL_DISTANCE
 ! /CALCULATE_PER_FILE=FALSE ! /CALCULATE_PER_FILE=FALSE
 +! /CALCULATE_PER_ALL_CMO_GLOBALS=FALSE
 ! /CREATE_ALL_INSTANCES=FALSE ! /CREATE_ALL_INSTANCES=FALSE
-! /REPORT_TIMES_AS_PERCENT_CYCLE=FALSE+! /CREATE_EMPTY_VALUES=TRUE
 ! /RIGHT_FOOT_LOCATION=KINETIC_KINEMATIC::RFT::ProxEndPos ! /RIGHT_FOOT_LOCATION=KINETIC_KINEMATIC::RFT::ProxEndPos
 ! /LEFT_FOOT_LOCATION=KINETIC_KINEMATIC::LFT::ProxEndPos ! /LEFT_FOOT_LOCATION=KINETIC_KINEMATIC::LFT::ProxEndPos
Line 33: Line 30:
 /LTO_EVENT=LTO /LTO_EVENT=LTO
 ! /STRICT_EVENT_SEQUENCE_VALIDATION=FALSE ! /STRICT_EVENT_SEQUENCE_VALIDATION=FALSE
 +! /RSTRIDE_EXCLUDE=
 +! /LSTRIDE_EXCLUDE=
 ! /INCLUDE_EVENTS= ! /INCLUDE_EVENTS=
 ! /EXCLUDE_EVENTS= ! /EXCLUDE_EVENTS=
Line 50: Line 49:
 ! /COMPUTE_RIGHT_INITIAL_DOUBLE_LIMB_SUPPORT_TIME=TRUE ! /COMPUTE_RIGHT_INITIAL_DOUBLE_LIMB_SUPPORT_TIME=TRUE
 ! /COMPUTE_RIGHT_TERMINAL_DOUBLE_LIMB_SUPPORT_TIME=TRUE ! /COMPUTE_RIGHT_TERMINAL_DOUBLE_LIMB_SUPPORT_TIME=TRUE
 +! /COMPUTE_FLIGHT_TIME=FALSE
 ! /TREADMILL_SPEED= ! /TREADMILL_SPEED=
 ! /LEFT_TREADMILL_SPEED= ! /LEFT_TREADMILL_SPEED=
Line 56: Line 56:
 </code> </code>
  
-Note that the treadmill direction is new specified as a unit vector.+Note that the treadmill direction is new, and is specified as a unit vector.
  
-=== Legacy Treadmill Parameters ===+==== Legacy Treadmill Parameters ====
  
 If the subject is walking in the y-direction of the laboratory the unit vector would be: If the subject is walking in the y-direction of the laboratory the unit vector would be:
Line 69: Line 69:
 /TREADMILL_DIRECTION_Z=0 /TREADMILL_DIRECTION_Z=0
 </code> </code>
-The new parameter is+ 
 +The new parameter is:
  
 /TREADMILL_DIRECTION=UNIT_VECTOR(0,1,0) /TREADMILL_DIRECTION=UNIT_VECTOR(0,1,0)
-==== Temporal Distance Dialog ====+===== Temporal Distance Dialog =====
  
-|**Version 4 & Earlier:**\\ {{:GaitTemporalDistancePropertiesDlg.gif}}  |**Version 5:**\\ {{:EditTemporalDistancev5.jpg}}  |+|**Version 4 & Earlier:**\\ {{:GaitTemporalDistancePropertiesDlg.gif}}  |**Version 5:**\\ {{:EditTemporalDistancev5.png}}  |
  
-=== Files for computing temporal distances === +==== Files for computing temporal distances ====
- +
-|{{:EditTemporalDistancev5_FILES2.jpg}}  |- The default command will create average temporal distance values for the ACTIVE files and results can be found in the GLOBAL workspace\\ - **Calculate For Each File:** Calculate average values across entire trial\\ - **Create All Instances:** value for each sequence (multiple values per trial)\\ \\ **NOTE:** To use the Calculate For Each File option, Calculate for Each Trial must be selected as well.  | +
- +
-\\ +
-\\+
  
 +|{{:EditTemporalDistancev5_FILES2.png}}  |- The default command will create average temporal distance values for the ACTIVE files and results can be found in the GLOBAL workspace\\ - **Calculate For Each File:** Calculate average values across entire trial\\- **Calculate For All Cmo Globals:** Calculate global average \\ - **Create All Instances:** value for each sequence (multiple values per trial)\\ \\ **NOTE:** To use the Calculate For Each File option, Calculate for Each Trial must be selected as well.  |
  
 |{{:EditTemporalDistancev5_Signal.jpg}}  |- If the user would like to define temporal distance metrics using a signal other than the default signal (such as the proximal end of the foot), the user can select a different signal (such as the heel target).\\ \\ - The height is used to calculate [[Visual3D:Documentation:Pipeline:Metric_Commands:Temporal_Distance_Calculations_for_Gait#Statures.2FSecond|statures/second]]  | |{{:EditTemporalDistancev5_Signal.jpg}}  |- If the user would like to define temporal distance metrics using a signal other than the default signal (such as the proximal end of the foot), the user can select a different signal (such as the heel target).\\ \\ - The height is used to calculate [[Visual3D:Documentation:Pipeline:Metric_Commands:Temporal_Distance_Calculations_for_Gait#Statures.2FSecond|statures/second]]  |
  
-\\ +|{{:EditTemporalDistancev5_PROPERTIES.png}}  |- The event labels may be changed to any events desired.\\ \\ - Selecting **Strict Event Label Sequence** will create temporal distance measures for events that occur within a gait cycle. For example Swing Time which occurs between RTO and RHS will only be calculated if the event sequence is RHS+RTO+RHS.\\- **[SIDE} String Exclude** will exclude event sequences with that event.\\ \\ - Explanations of the calculations of the temporal distance items can be found [[Visual3D:Documentation:Pipeline:Metric_Commands:Temporal_Distance_Calculations_for_Gait|here]].  |
-\\ +
- +
- +
-|{{:EditTemporalDistancev5_PROPERTIES.jpg}}  |- The event labels may be changed to any events desired.\\ \\ - Selecting **Strict Event Label Sequence** will create temporal distance measures for events that occur within a gait cycle. For example Swing Time which occurs between RTO and RHS will only be calculated if the event sequence is RHS+RTO+RHS.\\ \\ - Explanations of the calculations of the temporal distance items can be found [[Visual3D:Documentation:Pipeline:Metric_Commands:Temporal_Distance_Calculations_for_Gait|here]].  | +
- +
-\\ +
-\\ +
  
 |{{:EditTemporalDistancev5_RANGE.jpg}}  |- **Event Instance:** 0 indicates all instances, 1 indicates the first event sequence\\ \\ - **Exclude Sequence:** Creating an event BAD would exclude the trial during which the event occurred  | |{{:EditTemporalDistancev5_RANGE.jpg}}  |- **Event Instance:** 0 indicates all instances, 1 indicates the first event sequence\\ \\ - **Exclude Sequence:** Creating an event BAD would exclude the trial during which the event occurred  |
- 
-\\ 
-\\ 
- 
  
 |{{:EditTemporalDistancev5_TREADMILL.jpg}}  |- The treadmill unit vector refers to the Anterior Direction of walking\\ - Speed, (left/right/average) stride and step length, and statures/second are dependent on belt speed  | |{{:EditTemporalDistancev5_TREADMILL.jpg}}  |- The treadmill unit vector refers to the Anterior Direction of walking\\ - Speed, (left/right/average) stride and step length, and statures/second are dependent on belt speed  |
  
-\\ +|{{:EditTemporalDistancev5_FOLDER.jpg}}  |- The result folder may have any name and will be a subfolder of the METRIC folder.  |
-\\+
  
 +===== Subject computation using subject name/prefix parameters =====
  
-|{{:EditTemporalDistancev5_FOLDER.jpg}}  |- The result folder may have any name and will be a subfolder of the METRIC folder.  |+Visual3D now supports multiple subjects within the same workspace, and across CMO/Z library workspaces. Older versions of Visual3D will not support the subject prefix extensions of this command.
  
-\\ +When using a version of Visual3D prior to implementing multisubject support, Visual3D treats each CMO/Z file as a single subject. In this way, the temporal and distance metrics are computed in the CMO/Z GLOBAL for the subject processed within that CMO. In the same manner, when computing the temporal and distance metrics across a library of subjects, each CMO/Z is treated as a single subject and then the subject averages are computed across CMO/Z files and placed into the workspace GLOBAL for the overall mean values across subjects.
-\\+
  
 +Visual3D with multisubject support extends these metric calculations to be computed for each subject that is identified in the .C3D parameters SUBJECT section. In this way, the a single CMO/Z GLOBAL will contain the computed metrics for each subject within the CMO/Z file, prefixed with the subject's prefix identifier contained in the .C3D parameters. The GLOBAL of the CMO/Z will also contain an unprefixed set of metrics for the average across the subjects contained inside the CMO/Z file.
  
-==== Subject computation using subject name/prefix parameters ==== 
- 
-Visual3D is in the process of supporting multiple subjects within the same workspace, and across CMO/Z library workspaces. Older versions of Visual3D will not support the subject prefix extensions of this command.\\ 
-\\ 
-When using a version of Visual3D prior to implementing multisubject support, Visual3D treats each CMO/Z file as a single subject. In this way, the temporal and distance metrics are computed in the CMO/Z GLOBAL for the subject processed within that CMO. In the same manner, when computing the temporal and distance metrics across a library of subjects, each CMO/Z is treated as a single subject and then the subject averages are computed across CMO/Z files and placed into the workspace GLOBAL for the overall mean values across subjects.\\ 
-\\ 
-Visual3D with multisubject support extends these metric calculations to be computed for each subject that is identified in the .C3D parameters SUBJECT section. In this way, the a single CMO/Z GLOBAL will contain the computed metrics for each subject within the CMO/Z file, prefixed with the subject's prefix identifier contained in the .C3D parameters. The GLOBAL of the CMO/Z will also contain an unprefixed set of metrics for the average across the subjects contained inside the CMO/Z file.\\ 
-\\ 
 When working across CMO/Z files in the CMO/Z library, multisubject support for this command will treat each subject mean in each CMO/Z file as separate subject averages to be included for calculating the temporal and distance metric averages across all the subjects in the CMO/Z library. When working across CMO/Z files in the CMO/Z library, multisubject support for this command will treat each subject mean in each CMO/Z file as separate subject averages to be included for calculating the temporal and distance metric averages across all the subjects in the CMO/Z library.
  
-\\ +===== Temporal Distance Control Data =====
-\\ +
- +
- +
-==== Temporal Distance Control Data ====+
  
 The following are useful resources for temporal data metrics for Control Data Sets. The following are useful resources for temporal data metrics for Control Data Sets.
visual3d/documentation/pipeline/metric_commands/metric_compute_temporal_distance.1730750265.txt.gz · Last modified: 2024/11/04 19:57 by wikisysop