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

iFit/cut

PURPOSE ^

Take a cut from a d2d object by integrating over one or more of the plot axes.

SYNOPSIS ^

function varargout = cut (varargin)

DESCRIPTION ^

 Take a cut from a d2d object by integrating over one or more of the plot axes.

   >> w = cut (data_source, p1_bin, p2_bin)

   >> w = cut (..., '-save')       % Save cut to file (prompt for output file)
   >> w = cut (...,  filename)     % save cut to named file

   >> cut(...)                     % save cut to file without making output to workspace 
 
 Input:
 ------
   data_source     Data source: sqw file name or d2d-type data structure

   p1_bin          Binning along first plot axis
   p2_bin          Binning along second plot axis
                           
                   For each binning entry:
               - [] or ''          Plot axis: use bin boundaries of input data
               - [pstep]           Plot axis: sets step size; plot limits taken from extent of the data
                                   If pstep=0 then use current bin size and synchronise
                                  the output bin boundaries with the current boundaries. The overall range is
                                  chosen to ensure that the range of the input data is contained within
                                  the bin boundaries.
               - [plo, phi]        Integration axis: range of integration - those bin centres that lie inside this range 
                                  are included.
               - [plo, pstep, phi] Plot axis: minimum and maximum bin centres and step size
                                   If pstep=0 then use current bin size and synchronise
                                  the output bin boundaries with the current boundaries. The overall range is
                                  chosen to ensure that the range plo to phi is contained within
                                  the bin boundaries.

 Output:
 -------
   w              Output data object (d0d, d1d, d2d depending on binning requirements)

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