Home > Scripts > Models > plane2d.m

iFit/plane2d

PURPOSE ^

signal = plane2d(p, x, y, {signal}) : Planar function

SYNOPSIS ^

function signal=plane2d(varargin)

DESCRIPTION ^

 signal = plane2d(p, x, y, {signal}) : Planar function

   iFunc/plane2d Planar function (fit 2D function/model)
       signal = p(1)*x+p(2)*y+p(3)

 plane2d([s1 s2])        creates a model with specified slopes
 plane2d([ parameters ]) creates a model with specified model parameters

 input:  p: plane2d model parameters (double array)
            p = [  'Slope_X' 'Slope_Y' 'Background' ]
          or 'guess'
         x: axis along rows    (double)
         y: axis along columns (double)
    signal: when values are given, a guess of the parameters is performed (double)
 output: signal: model value
 ex:     signal=plane2d([1 2 .5 .2 .3 30 .2], -2:.1:2, -3:.1:3); or plot(plane2d);

 Version: Mar. 22, 2017
 See also iData, iFunc/fits, iFunc/plot, gauss
 (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