Differences

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

--- visual3d:documentation:pipeline:signal_commands:cross_correlation [2024/06/19 14:03] – created sgranger
+++ visual3d:documentation:pipeline:signal_commands:cross_correlation [2024/11/15 19:00] (current) – [RESULT] wikisysop
@@ Line 1: / Line 1: @@
-\\
+====== Cross Correlation ======
+The Cross_Correlation command can be used to determine if there is a relationship between two signals when one is shifted relative to the other. This command can also be used to calculate the self-similarity of a signal with a time-delayed version of itself. In this case the command calculates the signal's autocorrelation.
-The Cross_Correlation command can be used to determine if there is a relationship between two signals when one is shifted relative to the other.
+More about calculating cross-correlations can be found on [[https://en.wikipedia.org/wiki/Cross-correlation|Wikipedia]] and on [[http://paulbourke.net/miscellaneous/correlate/|Paul Bourke's website]].
-More about calculating cross correlations can be found [[http://en.wikipedia.org/wiki/Cross-correlation|here]] and [[http://paulbourke.net/miscellaneous/correlate/|here]].
+===== Cross_Correlation =====
-====== Cross_Correlation ======
+The **Cross_Correlation** command calculates the cross-correlation between two signals.
-The **Cross_Correlation** command may be used to calculate the cross correlation between two signals.
+<code>
+Cross_Correlation
-**Cross_Correlation**
 ! /SIGNAL_OWNER1=
 /SIGNAL_TYPE1=
@@ Line 26: / Line 26: @@
 ! /MAX_DELAY=10
 ! /DATA_WRAP=FALSE
-**;**
+;
-{{Cross_Correlation_Dialog.png}}
+</code>
+{{:Cross_Correlation_Dialog.png}}
+===== Parameters =====
-====== Parameters ======
+Understand the parameters of the Cross_Correlation command.
-===== MAX_DELAY =====
+==== SIGNAL1 ====
-The **MAX_DELAY** indicates the number of frames the signal will be shifted to determine the correlation.
+The /SIGNAL_OWNER1, /SIGNAL_TYPE1, /SIGNAL_FOLDER1, and /SIGNAL_NAME1 parameters allow the user to specify which signal (by [[visual3d:documentation:pipeline:file_commands:file_names|file]], [[visual3d:documentation:visual3d_signal_types:data_tree|data type]], [[visual3d:documentation:visual3d_signal_types:data_tree|folder]], and name) should be used as the first signal for the cross-correlation calculation.
-The number of frames in the resulting signal = 2*MAX_DELAY +1
+==== SIGNAL2 ====
-MAX_DELAY may also be considered as the "Window" of Frames to be compared across the signal.
+Similarly, the /SIGNAL_OWNER2, /SIGNAL_TYPE2, /SIGNAL_FOLDER2, and /SIGNAL_NAME2 parameters allow the user to specify the second signal for the cross-correlation calculation.
-A delay of 10 will result in 21 values (-10 to 10). A result at -10 will indicate that Signal ONE was shifted -10 frames relative to Signal TWO. A result at 10 will indicate that Signal ONE was shifted +10 frames relative to Signal TWO.
+==== RESULT ====
-A MAX_DELAY that is small will likely be inadequate to display the correlation of two signals. Selecting MAX_DELAY to have have the length of the two signals will cover all possible correlations.
+The /RESULT_OWNER, /RESULT_FOLDER, and /RESULT_NAME parameters allow the user to specify where the result of the cross-correlation calculation should be saved.
+  * The result's data type the DERIVED folder.
+  * The result's folder defaults to being the PROCESSED folder.
-To further review the shift between the two signals, an example script and power point can be downloaded [[https://www.has-motion.com/download/examples/Cross_Correlation/2015_05_06.zip|here]].
+==== MAX_DELAY ====
-===== DATA_WRAP =====
+The /MAX_DELAY parameter indicates the number of frames the signal will be shifted to determine the correlation. This parameter can be considered as the "window" of frames to be compared across the signal.
-Data Wrapping indicates that the siganl is consider to loop.
+The size of the resulting signal is determined as twice the value of the /MAX_DELAY plus one, e.g., a delay of 10 will result in 21 values (-10 to 10). A result at -10 will indicate that Signal ONE was shifted -10 frames relative to Signal TWO. A result at 10 will indicate that Signal ONE was shifted +10 frames relative to Signal TWO.
-With no Data Wrap and a MAX_DELAY of half the length of the signal, the first and last frames of the resulting signal will only be comparing half the signal.
+Setting the /MAX_DELAY parameter to a value that is too small will likely be inadequate to capture the correlation of two signals. Setting the /MAX_DELAY parameter to be the length of the two signals will cover all possible correlations. To further review the shift between the two signals, an example script and power point can be downloaded [[https://www.has-motion.com/download/examples/Cross_Correlation/2015_05_06.zip|here]].
-With Data Wrap, all frames of the resulting signal will be a correlation resulting from comparing all frames of the two signals.
+==== DATA_WRAP ====
-\\
+The /DATA_WRAP parameter is a binary flag indicating whether the signal should be considered to loop.
+With no Data Wrap and a MAX_DELAY of half the length of the signal, the first and last frames of the resulting signal will only be comparing half the signal. With Data Wrap, all frames of the resulting signal will be a correlation resulting from comparing all frames of the two signals.
-====== Example: Using the Cross Correlation Result ======
+===== Example: Find the Frame Offset with Highest Correlation =====
-If you want just the frame offset with the highest correlation, you could use the sample script below:
+If you want just the frame offset with the highest correlation, you could use the sample script below to calculate the cross-correlation between the two signals, sort these cross-correlation values, and extract the shift responsible for the largest cross-correlation.
 <code>