CrossCorrelate
From MantidProject
Contents |
Summary
Cross-correlates a range of spectra against one reference spectra in the same workspace.
Properties
| Order | Name | Direction | Type | Default | Description |
|---|---|---|---|---|---|
| 1 | InputWorkspace | Input | Workspace | Mandatory | The name of the input workspace. |
| 2 | OutputWorkspace | Output | Workspace | Mandatory | The name of the output workspace. |
| 3 | ReferenceSpectra | Input | Integer | Mandatory | The Workspace Index of the spectra to correlate all other spectra against. |
| 4 | WorkspaceIndexMin | Input | Integer | Mandatory | The workspace index of the first member of the range of spectra to cross-correlate against. |
| 5 | WorkspaceIndexMax | Input | Integer | Mandatory | The workspace index of the last member of the range of spectra to cross-correlate against. |
| 6 | XMin | Input | Double | Mandatory | The starting point of he region to be cross correlated. |
| 7 | XMax | Input | Double | Mandatory | The ending point of the region to be cross correlated. |
Description
Compute the cross correlation function for a range of spectra with respect to a reference spectrum.
This is use in powder diffraction experiments when trying to estimate the offset of one spectra with respect to another one. The spectra are converted in d-spacing and then interpolate on the X-axis of the reference. The cross correlation function is computed in the range [-N/2,N/2] where N is the number of points.
More details can be found here.
Usage
Python
CrossCorrelate("InputW","OutputW",2,3,75,1.6,2.2)
Source Code
Header CrossCorrelate.h
Source CrossCorrelate.cpp
