User Tools

Site Tools


visual3d:documentation:pipeline:metric_commands:metric_minimum

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:metric_commands:metric_minimum [2025/10/02 18:18] – [Example] wikisysopvisual3d:documentation:pipeline:metric_commands:metric_minimum [2025/10/03 17:11] (current) wikisysop
Line 31: Line 31:
 The Parameters for the function is as follows: The Parameters for the function is as follows:
  
-|**Metric_Minimum**                                                                                              |                                                                                             | +|**Metric_Minimum**                                                                                       |                                                                                             | 
-|/RESULT_METRIC_NAME=                                                                                         |The name of the metric signal created                                                        | +|**/RESULT_METRIC_FOLDER=**                                                                               |**Name of results folder**                                                       | 
-|!/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE                                                                       |Add a suffix to the signal name                                                              | +|**/RESULT_METRIC_NAME=**                                                                                 |**The name of the metric signal created**                                                        | 
-|!/RESULT_METRIC_FOLDER=PROCESSED                                                                             |Name of results folder                                                                       | +|**/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=**                                                                     |**True or False: Add a suffix to the signal name**                                                              | 
-|/SIGNAL_TYPES=TARGET                                                                                                                                                                                     +|**/SIGNAL_TYPES=**                                                                                       |**Types of signals to be processed**                                                                         
-|/SIGNAL_NAMES=                                                                                               |Signal                                                                                       | +|**/SIGNAL_NAMES=**                                                                                       |**Names of signals to be processed**                                                              
-|/SIGNAL_FOLDER=ORIGINAL                                                                                                                                                                                  +|**/SIGNAL_FOLDER=**                                                                                      |**Origin folder of signals for processing**                                                   
-|/COMPONENT_SEQUENCE                                                                         |Which component of the signal will be used for statistical analysis of the sequence                         | +|**/COMPONENT_SEQUENCE=**                                                                         |**Which component of the signal will be used for statistical analysis of the sequence**                          | 
-|/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Sequence|EVENT_SEQUENCE]]=            |Specify the sequence of Events. Any number of Events can be entered (separated by +)       +|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Sequence|EVENT_SEQUENCE]]=**            |**Specify the sequence of Events. Any number of Events can be entered (separated by +)**        | 
-|                                                                                                             |This specific sequence of events must be true for a metric to be computed.                   | +|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Exclude_Events|EXCLUDE_EVENTS]]=**        |**If this event occurs between the first and last event, do not computed a metric**              | 
-|                                                                                                             |The metric is computed from the first event in the sequence to the last event in the sequence+|**/[[Visual3D:Documentation:Pipeline:Signal_Commands:GENERATE_MEAN_AND_STDDEV|Generate_Mean_and_Stddev]]=**|**Generate the mean and standard deviation of this metric across ranges and files**             | 
-|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Exclude_Events|EXCLUDE_EVENTS]]=**        |If this event occurs between the first and last event, do not computed a metric              | +|**/Generate_Mean_and_Stddev_Across_Subjects=**                                                            |**Generate the mean and standard deviation of this metric across all subjects**                 | 
-|/[[Visual3D:Documentation:Pipeline:Signal_Commands:GENERATE_MEAN_AND_STDDEV|Generate_Mean_and_Stddev]]=TRUE| Generate the mean and standard deviation of this metric across ranges and files             | +|**/APPEND_TO_EXISTING_VALUES=**                                                                           |**Metrics can replace an existing signal or be appended to it.**                                 | 
-|/Generate_Mean_and_Stddev_Across_Subjects                                                                    | Generate the mean and standard deviation of this metric across all subjects                 | +|**/CREATE_GLOBAL_MINIMUM=**                                                                               |**Create minimum value across all trials**                                                       | 
-|/APPEND_TO_EXISTING_VALUES=FALSE                                                                           |Metrics can replace an existing signal or be appended to it.                                 | +|**/CREATE_TRIAL_MINIMUM=**                                                                                |**Create minimum value for this trial**                                                          |
-|/CREATE_GLOBAL_MINIMUM=FALSE                                                                               |Create minimum value across all trials                                                       | +
-|/CREATE_TRIAL_MINIMUM=FALSE                                                                                |Create minimum value for this trial                                                          |+
  
 ====Dialog==== ====Dialog====
visual3d/documentation/pipeline/metric_commands/metric_minimum.txt · Last modified: 2025/10/03 17:11 by wikisysop