3.11

BivariateNormal

Description

Provides a peak shape function interface for a peak on one time slice of a Rectangular detector.

V=\mathrm{Background} + \mathrm{Intensity}\times\mathrm{Normal}( \mu_x, \mu_y,\sigma_x,\sigma_y)

The Normal(..) is the Normal probability density function. Its integral over all x(col) and y(row) values is one. This means that Intensity is the total intensity with background removed.

Attributes (non-fitting parameters)

Name Type Default Description
CalcVariances      

There is only one Attribute: CalcVariances. This attribute is boolean.

If true, the variances are calculated from the data, given the means, variances and covariance. Otherwise they will become parameters and fit.

CalcVariances = true gives better/more stable results for peaks interior to the Rectangular Detector. For peaks close to the edge, CalcVariances should be false.

Properties (fitting parameters)

Name Default Description
Background 0.0  
Intensity 0.0  
Mcol 0.0 Mean column(x) value
Mrow 0.0 Mean row(y) value
  1. Background - The background of the peak
  2. Intensity - The intensity of data for the peak on this time slice
  3. Mcol - The col(x) of the center of the peak
  4. Mrow - The row(y) of the center of the peak on this slice
  5. ——- If CalcVariances is false, the following 3 parameters are also fit———
  6. SScol -The variance of the column(x) values in the peak for this time slice
  7. SSrow - The variance of the row(y) values in the peak for this time slice
  8. SSrc - The covariance of the row(x) and column(y) values in the peak for this time slice

Usage

The workspace can be “any” MatrixWorkspace where

  1. dataY(1) is the column(x) values for the pixels to be considered
  2. dataY(2) is the row(y) values for the pixels to be considered
  3. dataY(0)is the experimental data at the corresponding row and column for a panel and time slice( or merged time slices or...)

The data can have missing row and column values and need not represent a square or contiguous subregion of a panel

The values for out in function1D are, for each pixel, the difference of V(see formula) and dataY(0).

Categories: FitFunctions | Peak

Source

C++ source: BivariateNormal.cpp

C++ header: BivariateNormal.h