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

iFit/func_eval

PURPOSE ^

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

SYNOPSIS ^

This is a script file.

DESCRIPTION ^

 Evaluate a function at the plotting bin centres of sqw object or array of sqw object
 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,... ,xn,pars)

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

               - x1,x2,.xn Arrays of x coordinates along each of the n 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,sig])
                    y=gauss4d(x1,x2,x3,x4,[ht,x1_0,x2_0,x3_0,x4_0,sig1,sig2,sig3,sig4])

   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 - this option is ignored if
              the input is a full sqw object.

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

 e.g.
   >> wout = func_eval (w, @gauss4d, [ht,x1_0,x2_0,x3_0,x4_0,sig1,sig2,sig3,sig4])

   where the function gauss appears on the matlab path
           function y = gauss4d (x1, x2, x3, x4, pars)
           y = (pars(1)/(sig*sqrt(2*pi))) * ...
%   Overloaded methods:
      sqw/func_eval
      IX_dataset_3d/func_eval
      IX_dataset_2d/func_eval
      IX_dataset_1d/func_eval
      sqw/func_eval
      d4d/func_eval
      d3d/func_eval
      d2d/func_eval
      d1d/func_eval

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