Home > Scripts > Models > sine.m

iFit/sine

PURPOSE ^

y = sine(p, x, [y]) : Sine function.

SYNOPSIS ^

function y=sine(varargin)

DESCRIPTION ^

 y = sine(p, x, [y]) : Sine function. 

   iFunc/sine Sine function. 
     y  = p(4) + p(1)*sin((x - p(2))/p(3))

 sine(period)         creates a model with specified period
 sine([ parameters ]) creates a model with specified model parameters

 input:  p: Sine model parameters (double)
            p = [ Amplitude Phase_Shift Period BackGround ]
          or 'guess'
         x: axis (double)
         y: when values are given and p='guess', a guess of the parameters is performed (double)
 output: y: model value
 ex:     y=sine([1 0 1 1], -10:10); or plot(sine);

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