Home > Scripts > Models > fxcorr.m

iFit/fxcorr

PURPOSE ^

FXCORR Correlation

SYNOPSIS ^

function y=fxcorr(x, h, shape)

DESCRIPTION ^

FXCORR Correlation
   y = FXCORR(x, h) correlates x and h.
   It works with x and h being of any dimensionality. When only one argument is given, 
     the auto-correlation is computed.
   The accuracy of the conv and xcorr operators depends on the sampling. Peaks should
     be describes with at least 5 points underneath.
   This is the same as calling 
     fconv(x,h, 'correlation');

      x = input vector (signal)
      h = input vector (filter)
  shape = optional shape of the return value
          full         Returns the full two-dimensional correlation.
          same         Returns the central part of the correlation of the same size as x.
          valid        Returns only those parts of the correlation that are computed
                       without the zero-padded edges. Using this option, y has size
                       [mx-mh+1,nx-nh+1] when all(size(x) >= size(h)).
          pad          Pads the x signal by replicating its starting/ending values
                       in order to minimize the correlation side effects.
          center       Centers the h filter so that correlation does not shift
                       the x signal.
          normalize    Normalizes the h filter so that the correlation does not
                       change the x signal integral.
          background   Remove the background from the filter h (subtracts the minimal value)
          deconv       Performs a deconvolution/decorrelation

 ex:     c=fxcorr(a,b);

      See also FCONV, CONV, CONV2, FILTER, FILTER2, FFT, IFFT

 Version: Mar. 22, 2017
 (c) E.Farhi, ILL. License: EUPL.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Wed 22-Mar-2017 09:13:30 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1