User Tools

Site Tools


visual3d:documentation:pipeline:signal_commands:global_normalized_signal_mean

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:signal_commands:global_normalized_signal_mean [2024/11/15 20:57] – Major strides towards pipeline command format. wikisysopvisual3d:documentation:pipeline:signal_commands:global_normalized_signal_mean [2025/05/05 14:32] (current) – Minor revisions wikisysop
Line 1: Line 1:
-===== Global Normalized Signal Mean =====+====== Global Normalized Signal Mean ======
  
-This command computes the mean signal from a collection of signal traces, with each trace time-normalized to the specified [[visual3d:documentation:c3d_signal_types:event_label_data_type#event_sequence|event sequence]]. Note that the output signal is a [[Visual3D:Documentation:Definitions:File_Formats:P2D_Format|P2D Signal]] and is therefore stored in the Global Workspace.+This command computes the mean signal from a collection of signal traces, with each trace time-normalized to the specified [[visual3d:documentation:c3d_signal_types:event_label_data_type#event_sequence|event sequence]]. Note that the output signal is a [[Visual3D:Documentation:Definitions:File_Formats:P2D_Format|P2D Signal]] and is therefore stored in the [[visual3d:documentation:definitions:global_workspace|Global Workspace]].
  
 There are options within this command for calculating means: There are options within this command for calculating means:
Line 26: Line 26:
 </code> </code>
  
- +===== Parameters =====
- +
- +
-==== Parameters ====+
  
 If **CALCULATE_PER_FILE=false** All signal traces from all active files are used to compute the mean If **CALCULATE_PER_FILE=false** All signal traces from all active files are used to compute the mean
Line 37: Line 34:
 If the **CMO Library** is active, it is important to highlight the distinction, albeit subtle, between how this command functions when used within a single workspace and when used within the CMO library. For instance, within a single workspace the command will compute the mean for all instances in each trial and a global mean of all instances in the workspace. However, within the CMO library each CMZ file contributes one mean value regardless of the number of instances within the file, and the command computes the mean of these mean values. If the **CMO Library** is active, it is important to highlight the distinction, albeit subtle, between how this command functions when used within a single workspace and when used within the CMO library. For instance, within a single workspace the command will compute the mean for all instances in each trial and a global mean of all instances in the workspace. However, within the CMO library each CMZ file contributes one mean value regardless of the number of instances within the file, and the command computes the mean of these mean values.
  
-==== Output ==== +===== Output =====
- +
-The resulting signal is a [[Visual3D:Documentation:Definitions:File_Formats:P2D_Format|P2D]] signal and is stored in the Global Workspace.+
  
-If **CALCULATE_PER_FILE=true** then a P2D signal is also stored with each C3D file.+The resulting signal is a [[Visual3D:Documentation:Definitions:File_Formats:P2D_Format|P2D]] signal and is stored in the [[visual3d:documentation:definitions:global_workspace|Global Workspace]]. If **CALCULATE_PER_FILE=true** then a P2D signal is also stored with each C3D file.
  
-==== Dialog ====+===== Dialog =====
  
 The Global_Normalized_Signal_Mean command can also be edited interactively using the following dialog The Global_Normalized_Signal_Mean command can also be edited interactively using the following dialog
Line 49: Line 44:
 {{:GMSM_1.jpg}} {{:GMSM_1.jpg}}
  
-==== Multisubject support ====+===== Multisubject support =====
  
-Visual3D 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.+Visual3D supports [[visual3d:documentation:definitions:multisubject|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 [[visual3d:getting_started:visual3d_release_notes#major_v2022081_release|prior to v2022.08.1]], Visual3D treats each CMO/Z file as a single subject. In this way, the normalized signal mean curve is generated in the CMO/Z Global Workspace for the subject processed within that file. In the same manner, when computing the normalized signal mean curve across a library of subjects, each CMO/Z is treated as a single subject and then the normalized signal mean is computed across CMO/Z files and placed into the workspace GLOBAL for the overall mean curve across subjects. When using a version of Visual3D [[visual3d:getting_started:visual3d_release_notes#major_v2022081_release|prior to v2022.08.1]], Visual3D treats each CMO/Z file as a single subject. In this way, the normalized signal mean curve is generated in the CMO/Z Global Workspace for the subject processed within that file. In the same manner, when computing the normalized signal mean curve across a library of subjects, each CMO/Z is treated as a single subject and then the normalized signal mean is computed across CMO/Z files and placed into the workspace GLOBAL for the overall mean curve across subjects.
Line 57: Line 52:
 After v2022.08.1, Visual3D extends these normalized signal mean 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 normalized mean curve for each subject within the CMO/Z file, prefixed with the subject's prefix identifier contained in the .C3D parameters. The Global Workspace of the CMO/Z file will also contain an unprefixed global normalized signal mean curve across all 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 in each CMO/Z file as separate subject to be separately included for calculating the normalized signal mean curve across all the subjects in the CMO/Z library. After v2022.08.1, Visual3D extends these normalized signal mean 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 normalized mean curve for each subject within the CMO/Z file, prefixed with the subject's prefix identifier contained in the .C3D parameters. The Global Workspace of the CMO/Z file will also contain an unprefixed global normalized signal mean curve across all 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 in each CMO/Z file as separate subject to be separately included for calculating the normalized signal mean curve across all the subjects in the CMO/Z library.
  
-==== Examples ====+===== Examples =====
  
 This command is incredibly useful for summarizing data in your CMZ files and there are a number of ways in which it can be used. This command is incredibly useful for summarizing data in your CMZ files and there are a number of ways in which it can be used.
  
-=== Example 1: Global Normalized Means for 2 Signals ===+==== Example 1: Global Normalized Means for 2 Signals ====
  
 This example will time-normalize a signal (in this case Knee Flexion Angle) between events (RHS to RHS) for right knee angles and (LHS to LHS) for left knee angles, and compute the Global mean and standard deviation. This example will time-normalize a signal (in this case Knee Flexion Angle) between events (RHS to RHS) for right knee angles and (LHS to LHS) for left knee angles, and compute the Global mean and standard deviation.
Line 85: Line 80:
 Click **OK** to close the dialog. The text representation of the command is similar to the example seen in the next section. Click **OK** to close the dialog. The text representation of the command is similar to the example seen in the next section.
  
-=== Example 2: Global Normalized Means for more than two signals ===+==== Example 2: Global Normalized Means for more than two signals ====
  
 This example will time-normalize several signals at the Hip, Knee, and Ankle for both left and right sides using a meta-command. The means for all 3 components of the each signal will be calculated. This example will time-normalize several signals at the Hip, Knee, and Ankle for both left and right sides using a meta-command. The means for all 3 components of the each signal will be calculated.
Line 159: Line 154:
 </code> </code>
  
-==== Exporting the Global Normalized Signal Mean ====+==== Example 3: Exporting the Global Normalized Signal Mean ===
  
 The signal is stored in the [[visual3d:documentation:definitions:global_workspace|Global Workspace]], so it is necessary to make **GLOBAL** the active file before the export command. In addition, the resulting signal is in the [[visual3d:documentation:definitions:file_formats:p2d_format|P2D format]] which means that the components are different. Below is an example script that will export the resulting P2D file to ASCII. The signal is stored in the [[visual3d:documentation:definitions:global_workspace|Global Workspace]], so it is necessary to make **GLOBAL** the active file before the export command. In addition, the resulting signal is in the [[visual3d:documentation:definitions:file_formats:p2d_format|P2D format]] which means that the components are different. Below is an example script that will export the resulting P2D file to ASCII.
Line 190: Line 185:
 ; ;
 </code> </code>
- 
- 
  
visual3d/documentation/pipeline/signal_commands/global_normalized_signal_mean.txt · Last modified: 2025/05/05 14:32 by wikisysop