Home > Applications > Horace > @d2d > func_eval.m

iFit/func_eval

PURPOSE ^

Evaluate a function at the plotting bin centres of d2d object or array of d2d objects

SYNOPSIS ^

function wout = func_eval (win, varargin)

DESCRIPTION ^

 Evaluate a function at the plotting bin centres of d2d object or array of d2d objects
 Syntax:
   >> wout = func_eval (win, func_handle, pars)
   >> wout = func_eval (win, func_handle, pars, 'all')

 Input:
 ======
   win         Dataset or array of datasets; the function will be evaluated
              at the bin centres along the plot axes

   func_handle Handle to the function to be evaluated at the bin centres
               Must have form:
                   y = my_function (x1,x2,pars)

               or, more generally:
                   y = my_function (x1,x2,pars,c1,c2,...)

               - x1,x2     Arrays of x coordinates along each of the two dimensions
               - pars      Parameters needed by the function
               - c1,c2,... Any further arguments needed by the function e.g.
                          they could be the filenames of lookup tables for
                          resolution effects)

               e.g. y=gauss2d(x1,x2,[ht,x0,sig1,sig2])

   pars        Arguments needed by the function. 
                - Most commonly just a numeric array of parameters
                - If a more general set of parameters is needed by the function, then
                  wrap as a cell array {pars, c1, c2, ...}

   'all'       [option] Requests that the calculated function be returned over
              the whole of the domain of the input dataset. If not given, then
              the function will be returned only at those points of the dataset
              that contain data.
               Applies only to input with no pixel information - it is ignored if
              full sqw object.

 Output:
 =======
   wout        Output object or array of objects 

 e.g.
   >> wout = func_eval (w, @gauss2d, [ht,x1_0,x2_0,sig1,sig2])

   where the function appears on the matlab path
           function y = gauss2d (x1, x2, pars)
           y = (pars(1)/(sig*sqrt(2*pi))) * ...

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Mon 26-Nov-2018 15:08:42 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1