HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » expressions » Reserved Names
visual3d:documentation:pipeline:expressions:reserved_names

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:expressions:reserved_names [2024/06/19 12:50] – sgrangervisual3d:documentation:pipeline:expressions:reserved_names [2025/03/10 11:40] (current) – wikisysop
Line 1: Line 1:
-visual3d reserved names+====== Reserved Names ======
  
-===== contents =====+Visual3D Reserved Names
  
 +==== Contents ====
  
  
-  * [[#current_signal|1 current_signal]] 
-    * [[#used_to_allow_multiple_signals_to_be_specified_in_an_expression|1.1 used to allow multiple signals to be specified in an expression]] 
-    * [[#used_to_specifying_all_signals_of_a_given_type|1.2 used to specifying all signals of a given type]] 
-    * [[#apply_as_suffix_to_signal_name|1.3 apply_as_suffix_to_signal_name]] 
-  * [[#nan|2 nan]] 
-  * [[#isnan|3 isnan]] 
  
 +  * [[#CURRENT_SIGNAL|1 CURRENT_SIGNAL]]
 +    * [[#Used_to_allow_multiple_signals_to_be_specified_in_an_expression|1.1 Used to allow multiple signals to be specified in an expression]]
 +    * [[#Used_to_Specifying_all_signals_of_a_given_TYPE|1.2 Used to Specifying all signals of a given TYPE]]
 +    * [[#APPLY_AS_SUFFIX_TO_SIGNAL_NAME|1.3 APPLY_AS_SUFFIX_TO_SIGNAL_NAME]]
 +  * [[#NAN|2 NAN]]
 +  * [[#isNAN|3 isNAN]]
 +  * [[#ORIGIN|ORIGIN]]
  
-===== current_signal ===== 
  
-used to refer to a specific signal with a simple syntax +==== CURRENT_SIGNAL ====
-compute the length of one signal.+
  
-the legacy syntax is:+Used to refer to a specific signal with a simple syntax 
 +Compute the length of one signal.
  
-**evaluate_expression** +The legacy syntax is: 
-/expression=length(target::original::rft1) + 
-/result_types=derived +**Evaluate_Expression** 
-/result_folders=processed +/EXPRESSION=LENGTH(TARGET::ORIGINAL::RFT1) 
-/result_name=_length +/RESULT_TYPES=DERIVED 
-/apply_as_suffix_to_signal_name=true+/RESULT_FOLDERS=PROCESSED 
 +/RESULT_NAME=_LENGTH 
 +/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
 **;** **;**
-the legacy syntax can get complicated if [[visual3d:documentation:pipeline:general_information:pipeline_parameters|pipeline_parameters]] are used in the signal name because of the order in which equations are parsed.+The legacy syntax can get complicated if [[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Parameters|Pipeline_Parameters]] are used in the signal name because of the order in which equations are parsed.
  
-! create a pipeline parameter containing the marker name +! Create a pipeline parameter containing the marker name 
-**set_pipeline_parameter** +**Set_Pipeline_Parameter** 
-/parameter_name=marker +/PARAMETER_NAME=MARKER 
-/parameter_value=rft1+/PARAMETER_VALUE=RFT1
 **;** **;**
-**evaluate_expression** +**Evaluate_Expression** 
-/expression=length(target::original&:&:&::marker&) +/EXPRESSION=LENGTH(TARGET::ORIGINAL&:&:&::MARKER&) 
-/result_types=derived +/RESULT_TYPES=DERIVED 
-/result_folders=processed +/RESULT_FOLDERS=PROCESSED 
-/result_name=_length+/RESULT_NAME=_LENGTH
 **;** **;**
-this gets even more complicate if the folder is also a pipeline parameter.+This gets even more complicate if the folder is also a pipeline parameter.
  
-an alternative is the following+An alternative is the following
  
-**evaluate_expression** +**Evaluate_Expression** 
-/expression=length(current_signal) +/EXPRESSION=LENGTH(CURRENT_SIGNAL) 
-/signal_types=target +/SIGNAL_TYPES=TARGET 
-/signal_folder=original +/SIGNAL_FOLDER=ORIGINAL 
-/signal_names=::marker +/SIGNAL_NAMES=::MARKER 
-/result_types=derived +/RESULT_TYPES=DERIVED 
-/result_folders=processed +/RESULT_FOLDERS=PROCESSED 
-/result_name=_length +/RESULT_NAME=_LENGTH 
-/apply_as_suffix_to_signal_name=true+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
 **;** **;**
 \\ \\
  
  
-=== used to allow multiple signals to be specified in an expression ===+== Used to allow multiple signals to be specified in an expression ==
  
-compute the length of targets rft1, rft2, and rft3 in the original folder+Compute the length of TARGETS RFT1, RFT2, and RFT3 in the ORIGINAL folder
  
-the legacy implementation requires a [[visual3d:documentation:pipeline:pipeline_commands:for_each_and_end_for_each|for_each]] statement+The legacy implementation requires a [[Visual3D:Documentation:Pipeline:Pipeline_Commands:For_Each_and_End_For_Each|For_Each]] statement
  
-[[visual3d:documentation:pipeline:pipeline_commands:for_each_and_end_for_each|for_each]] +[[Visual3D:Documentation:Pipeline:Pipeline_Commands:For_Each_and_End_For_Each|For_Each]] 
-/iteration_parameter_name= markers +/Iteration_Parameter_Name= MARKERS 
-/items= rft1+rft2+rft3+/Items= RFT1+RFT2+RFT3
 **;** **;**
-**evaluate_expression** +**Evaluate_Expression** 
-/expression=length(target::original&:&:&::markers&) +/EXPRESSION=LENGTH(TARGET::ORIGINAL&:&:&::MARKERS&) 
-/signal_types=target +/SIGNAL_TYPES=TARGET 
-/signal_folder=original +/SIGNAL_FOLDER=ORIGINAL 
-/signal_names= +/SIGNAL_NAMES= 
-/result_types=derived +/RESULT_TYPES=DERIVED 
-/result_folders=processed +/RESULT_FOLDERS=PROCESSED 
-/result_name=::markers +/RESULT_NAME=::MARKERS 
-/apply_as_suffix_to_signal_name=true+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
 **;** **;**
-end_for_each +End_For_Each 
-/iteration_parameter_name=markers+/Iteration_Parameter_Name=MARKERS
 **;** **;**
-using current_signal+Using CURRENT_SIGNAL
  
-**evaluate_expression** +**Evaluate_Expression** 
-/expression=length(current_signal) +/EXPRESSION=LENGTH(CURRENT_SIGNAL) 
-/signal_types=target +/SIGNAL_TYPES=TARGET 
-/signal_folder=original +/SIGNAL_FOLDER=ORIGINAL 
-/signal_names=rft1+rft2+rft3 +/SIGNAL_NAMES=RFT1+RFT2+RFT3 
-/result_types=derived +/RESULT_TYPES=DERIVED 
-/result_folders=processed +/RESULT_FOLDERS=PROCESSED 
-/result_name=_length +/RESULT_NAME=_LENGTH 
-/apply_as_suffix_to_signal_name=true+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
 **;** **;**
 \\ \\
  
  
-=== used to specifying all signals of a given type ===+== Used to Specifying all signals of a given TYPE ==
  
-compute the length of all targets in the original folder+Compute the length of all TARGETS in the ORIGINAL folder
  
-the legacy implementation requires a [[visual3d:documentation:pipeline:pipeline_commands:for_each_and_end_for_each|for_each]] command and a command to get the names of all of the targets+The legacy implementation requires a [[Visual3D:Documentation:Pipeline:Pipeline_Commands:For_Each_and_End_For_Each|For_Each]] command and a command to get the names of all of the TARGETS
  
-[[visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter_to_list_of_signal_names|set_pipeline_parameter_to_list_of_signal_names]] +[[Visual3D:Documentation:Pipeline:Pipeline_Commands:Set_Pipeline_Parameter_To_List_Of_Signal_Names|Set_Pipeline_Parameter_To_List_Of_Signal_Names]] 
-/parameter_name=all_targets +/PARAMETER_NAME=ALL_TARGETS 
-/signal_type=target +/SIGNAL_TYPE=TARGET 
-/signal_folder=original+/SIGNAL_FOLDER=ORIGINAL
 **;** **;**
-[[visual3d:documentation:pipeline:pipeline_commands:for_each_and_end_for_each|for_each]] +[[Visual3D:Documentation:Pipeline:Pipeline_Commands:For_Each_and_End_For_Each|For_Each]] 
-/iteration_parameter_name= markers +/Iteration_Parameter_Name= MARKERS 
-/items= ::all_targets+/Items= ::ALL_TARGETS
 **;** **;**
-**evaluate_expression** +**Evaluate_Expression** 
-/expression=length(target::original&:&:&::markers&) +/EXPRESSION=LENGTH(TARGET::ORIGINAL&:&:&::MARKERS&) 
-/signal_types=target +/SIGNAL_TYPES=TARGET 
-/signal_folder=original +/SIGNAL_FOLDER=ORIGINAL 
-/signal_names= +/SIGNAL_NAMES= 
-/result_types=derived +/RESULT_TYPES=DERIVED 
-/result_folders=processed +/RESULT_FOLDERS=PROCESSED 
-/result_name=::markers +/RESULT_NAME=::MARKERS 
-/apply_as_suffix_to_signal_name=true+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
 **;** **;**
-end_for_each +End_For_Each 
-/iteration_parameter_name=markers+/Iteration_Parameter_Name=MARKERS
 **;** **;**
-using current_signal+Using CURRENT_SIGNAL
  
-**evaluate_expression** +**Evaluate_Expression** 
-/expression=length(current_signal) +/EXPRESSION=LENGTH(CURRENT_SIGNAL) 
-/signal_types=target +/SIGNAL_TYPES=TARGET 
-/signal_folder=original +/SIGNAL_FOLDER=ORIGINAL 
-/signal_names= +/SIGNAL_NAMES= 
-/result_types=derived +/RESULT_TYPES=DERIVED 
-/result_folders=processed +/RESULT_FOLDERS=PROCESSED 
-/result_name=_length +/RESULT_NAME=_LENGTH 
-/apply_as_suffix_to_signal_name=true+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
 **;** **;**
 \\ \\
  
  
-=== apply_as_suffix_to_signal_name ===+== APPLY_AS_SUFFIX_TO_SIGNAL_NAME ==
  
-if **apply_as_suffix_to_signal_name** is **true**, or result_names.size() == signal_names.size()+If **APPLY_AS_SUFFIX_TO_SIGNAL_NAME** is **true**, OR RESULT_NAMES.size() == SIGNAL_NAMES.size()
  
-compute the length of all targets in the original folder+Compute the length of all TARGETS in the ORIGINAL folder
  
-**evaluate_expression** +**Evaluate_Expression** 
-/expression=length(current_signal) +/EXPRESSION=LENGTH(CURRENT_SIGNAL) 
-/signal_types=target +/SIGNAL_TYPES=TARGET 
-/signal_folder=original +/SIGNAL_FOLDER=ORIGINAL 
-/signal_names= +/SIGNAL_NAMES= 
-/result_types=derived +/RESULT_TYPES=DERIVED 
-/result_folders=processed +/RESULT_FOLDERS=PROCESSED 
-/result_name=_length +/RESULT_NAME=_LENGTH 
-/apply_as_suffix_to_signal_name=true+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
 **;** **;**
-compute the length of two targets (rft1 and rft2) in the original folder+Compute the length of Two TARGETS (RFT1 and RFT2) in the ORIGINAL folder
  
-**evaluate_expression** +**Evaluate_Expression** 
-/expression=length(current_signal) +/EXPRESSION=LENGTH(CURRENT_SIGNAL) 
-/signal_types=target +/SIGNAL_TYPES=TARGET 
-/signal_folder=original +/SIGNAL_FOLDER=ORIGINAL 
-/signal_names=rft1+rft2 +/SIGNAL_NAMES=RFT1+RFT2 
-/result_types=derived +/RESULT_TYPES=DERIVED 
-/result_folders=processed +/RESULT_FOLDERS=PROCESSED 
-/result_name=_length +/RESULT_NAME=_LENGTH 
-/apply_as_suffix_to_signal_name=true+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
 **;** **;**
-compute a best_plane_fit for multiple signals at each frame of data+Compute a Best_Plane_Fit for multiple signals at each frame of data
  
-**evaluate_expression** +**Evaluate_Expression** 
-/expression=best_fit_plane(current_signal) +/EXPRESSION=Best_Fit_Plane(CURRENT_SIGNAL) 
-/signal_types=target +/SIGNAL_TYPES=TARGET 
-/signal_folder=original +/SIGNAL_FOLDER=ORIGINAL 
-/signal_names=lsk_1+lsk_2+lsk_3 +/SIGNAL_NAMES=LSK_1+LSK_2+LSK_3 
-/result_types=derived +/RESULT_TYPES=DERIVED 
-/result_folders=processed +/RESULT_FOLDERS=PROCESSED 
-/result_name=lsk_plane +/RESULT_NAME=LSK_PLANE 
-/apply_as_suffix_to_signal_name=true+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
 **;** **;**
 \\ \\
-if **apply_as_suffix_to_signal_name** is **false**, and result_names.size() == 1+If **APPLY_AS_SUFFIX_TO_SIGNAL_NAME** is **false**, AND RESULT_NAMES.size() == 1
  
-compute the length of one target (target::original::rft1)+Compute the length of one TARGET (TARGET::ORIGINAL::RFT1)
  
-**evaluate_expression** +**Evaluate_Expression** 
-/expression=length(target::original::rft1) +/EXPRESSION=LENGTH(TARGET::ORIGINAL::RFT1) 
-/result_types=derived +/RESULT_TYPES=DERIVED 
-/result_folders=processed +/RESULT_FOLDERS=PROCESSED 
-/result_name=rft1_length+/RESULT_NAME=RFT1_LENGTH
 **;** **;**
-===== nan =====+==== NAN ====
  
-nan is a reserved string used to designate "not a number".+NAN is a reserved string used to designate "Not a Number".
  
-visual3d commands refer to [[visual3d:documentation:c3d_signal_types:data_not_found|no_data or data_not_found]] as nan+Visual3D commands refer to [[Visual3D:Documentation:C3D_Signal_Types:DATA_NOT_FOUND|NO_DATA or DATA_NOT_FOUND]] as NAN
  
-for example, the expression 1/0 results in nan +For example, the expression 1/0 results in NAN 
-===== isnan =====+==== isNAN ====
  
-isnan(expression) tests values against nan - if the number is nan the result is 1, otherwise the result is 0+isNAN(expression) tests values against NAN - If the number is NAN the result is 1, otherwise the result is 0
  
-[set_pipeline_parameter_from_expression] +[Set_Pipeline_Parameter_From_Expression] 
-/parameter_name= nan_test +/PARAMETER_NAME= NAN_TEST 
-/expression=isnan(1/0) +/EXPRESSION=ISNAN(1/0) 
-/as_integer=true+/AS_INTEGER=TRUE
 **;** **;**
-::nan_test = 1 +::NAN_TEST = 1 
-[set_pipeline_parameter_from_expression] +[Set_Pipeline_Parameter_From_Expression] 
-/parameter_name= nan_test +/PARAMETER_NAME= NAN_TEST 
-/expression=isnan(-999999.000000) +/EXPRESSION=ISNAN(-999999.000000) 
-/as_integer=true+/AS_INTEGER=TRUE
 **;** **;**
-::nan_test = 1 +::NAN_TEST = 1 
-returns "1" because -999999 is equal to data not found in visual3d.+Returns "1" because -999999 is equal to Data Not Found in Visual3D.
  
-[set_pipeline_parameter_from_expression] +[Set_Pipeline_Parameter_From_Expression] 
-/parameter_name= nan_test +/PARAMETER_NAME= NAN_TEST 
-/expression=isnan(15) +/EXPRESSION=ISNAN(15) 
-/as_integer=true+/AS_INTEGER=TRUE
 **;** **;**
-::nan_test = 0 +::NAN_TEST = 0 
-example: set negative values to no_data+Example: Set negative values to NO_DATA
  
-if the z-component of the lelb signal is below 0 set the frame to no_data+If the z-component of the LELB signal is below 0 set the frame to NO_DATA
  
-**evaluate_expression** +**Evaluate_Expression** 
-/expression=(target::original::lelb::z>0)/(target::original::lelb::z>0)*target::original::lelb +/EXPRESSION=(TARGET::ORIGINAL::LELB::Z>0)/(TARGET::ORIGINAL::LELB::Z>0)*TARGET::ORIGINAL::LELB 
-/result_name=lelb +/RESULT_NAME=LELB 
-/result_type=target +/RESULT_TYPE=TARGET 
-/result_folder=processed+/RESULT_FOLDER=PROCESSED
 **;** **;**
 +
 +==== ORIGIN ====
 +
 +Internally Visual3D specifies the location ORIGIN and the string cannot be used for a TARGET or a LANDMARK
  
  
visual3d/documentation/pipeline/expressions/reserved_names.1718801400.txt.gz · Last modified: 2024/06/19 12:50 by sgranger