4.97 sddsshiftcor

• description: sddsshiftcor computes correlation coefficients and correlation significance between column data as a function of shifting of the data columns relative to each other. The correlation coefficient between columns i and j is defined as

  If C_ij = 1, then the variables are perfectly correlated, whereas if C_ij = -1, they are perfectly anticorrelated. In some cases, signals are correlated but with a time-lag. Hence, computing

  

  as a function of the shifting of one of the signals may reveal relationships that are not apparent in a simple correlation, such as might be done with sddscorrelate.

• examples:
      sddsshiftcor data.sdds result.sdds -with=Signal -columns=Response  
      

• synopsis:
      sddsshiftcor [-pipe=[input][,output]] [inputFile] [outputFile]  
        -with=columnName  
        [-scan[=start=startShift][,end=endShift][,delta=deltaShift]]  
        [-columns=columnNames] [-excludeColumns=columnNames]  
        [-rankOrder] [-stDevOutlier[=limit=factor][,passes=integer]]  
        [-verbose]  
      

• switches:
  • -pipe=[input][,output] — The standard SDDS Toolkit pipe option.
  • -with=columnName — Specifies the column to be shifted, which is correlated with the other columns.
  • -scan[=start=startShift][,end=endShift][,delta=deltaShift] — Specifies the amount to shift and the step size. The values are all integers. By default startShift = -10, endShift = 10, and deltaShift = 1.
  • -columns=columnNames — Specifies the names of columns to be included in the analysis. A comma-separated list of optionally wildcard-containing names may be given.
  • -excludeColumns=columnNames — Specifies the names of columns to be excluded from the analysis. A comma-separated list of optionally wildcard-containing names may be given.
  • -rankOrder — Specifies computing rank-order correlations rather than standard correlations. This is considered more robust than standard correlations.
  • -stDevOutlier[=limit=factor][,passes=integer] — Specifies standard-deviation-based outlier elimination on each pair of columns prior to computation of the correlation coefficient. Any pair of values is ignored if one or both values are outliers relative to the column from which they come. The limit qualifier specifies the allowed deviation from the mean in standard deviations; the default is 1. The passes qualifier specifies how many times the outlier elimination (including recomputation of the mean and standard deviation) is performed; the default is 1.
  • -verbose — Requests verbose output.
• files: inputFile is an SDDS file containing two or more columns of data. outputFile contains one column (ShiftedBy) for the amount shifted, plus one column for each analyzed column in inputFile. The latter each contains the correlation coefficient with the shifted signal for the given shift value.
• see also:
  • sddscorrelate()
• author: M. Borland, ANL/APS.