Home > Applications > Horace > @d3d > mask.m

iFit/mask

PURPOSE ^

Remove the bins indicated by the mask array

SYNOPSIS ^

function wout = mask (win, varargin)

DESCRIPTION ^

 Remove the bins indicated by the mask array

 Syntax:
   >> wout = mask (win, mask_array)

 Input:
 ------
   win                 Input sqw object

   mask_array          Array of 1 or 0 (or true or false) that indicate
                      which points to retain. 
                       Numeric or logical array of same number of elements
                      as the data.
                       Note: mask will be applied to the stored data array
                      according as the projection axes, not the display axes.
                      Thus permuting the display axes does not alter the
                      effect of masking the data.

 Output:
 -------
   wout                Output dataset.

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