Home > Scripts > Models > heaviside.m

iFit/heaviside

PURPOSE ^

y = heaviside(p, x, [y]) : Heaviside step function

SYNOPSIS ^

function y=heaviside(varargin)

DESCRIPTION ^

 y = heaviside(p, x, [y]) : Heaviside step function

   iFunc/heaviside Heaviside step fitting function
     y = 0*x+p(4); y(find(x >= p(2))) = p(1);
   The Width parameter sign indicates if this is a raising (positive) or 
   falling (negative) Heaviside.

 heaviside(threshold)      creates a model with a specified threshold
 heaviside([ parameters ]) creates a model with specified model parameters

 input:  p: Heaviside model parameters (double)
            p = [ Amplitude Centre FullWidth 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=heaviside([1 0 1 1], -10:10); or plot(heaviside);

 Version: Nov. 27, 2018
 See also iFunc, iFunc/fits, iFunc/plot
 (c) E.Farhi, ILL. License: EUPL.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Tue 27-Nov-2018 10:56:24 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1