Home > Scripts > Models > tophat.m

iFit/tophat

PURPOSE ^

y = tophat(p, x, [y]) : Top-Hat rectangular function

SYNOPSIS ^

function y=tophat(varargin)

DESCRIPTION ^

 y = tophat(p, x, [y]) : Top-Hat rectangular function

   iFunc/tophat Top-Hat rectangle fitting function
     y=0*x+p(4); y(find(p(2)-p(3) < x & x < p(2)+p(3))) = p(1);
     and y is set to the background outside the full width.

 tophat(width)          creates a model with a specified width
 tophat([ parameters ]) creates a model with specified model parameters

 input:  p: Top-Hat rectangular model parameters (double)
            p = [ Amplitude Centre HalfWidth 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=tophat([1 0 1 1], -10:10); or plot(tophat);

 Version: Aug. 22, 2017
 See also iFunc, iFunc/fits, iFunc/plot, heavisde, triangl
 (c) E.Farhi, ILL. License: EUPL.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Tue 22-Aug-2017 11:03:30 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1