Home > Objects > @iData > peaks.m

iFit/peaks

PURPOSE ^

[half_width, center, amplitude, baseline] = peaks(s, dim, m) : peak position and width of iData

SYNOPSIS ^

function [sigma, position, amplitude, baseline] = peaks(a, dim, m)

DESCRIPTION ^

 [half_width, center, amplitude, baseline] = peaks(s, dim, m) : peak position and width of iData

   @iData/peaks function to compute an estimate of peak position and width along
     dimension 'dim'

 input:  a: object or array (iData/array of)
         dim: dimension to use. Default is 1 (int)
         m: typical peak width or 0 for automatic guess (int)
 output: half_width: width of peaks (scalar/array)
         center:     center of peaks (scalar/array)
         amplitude:  amplitude of peaks (scalar/array)
         baseline:   baseline (background) (iData)
 ex:     c=peaks(a);

 References: Slavic, NIM 112 (1973) 253 ; M. Morhac, NIM A 600 (2009) 478 

 Version: Mar. 22, 2017
 See also iData, iData/median, iData/mean, iData/std

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