Home > Objects > @iData > rmaxis.m

iFit/rmaxis

PURPOSE ^

s = rmaxis(s, Axis) : delete iData axes

SYNOPSIS ^

function this = rmaxis(this,rank)

DESCRIPTION ^

 s = rmaxis(s, Axis) : delete iData axes

   @iData/rmaxis function to delete iData axes.
     As Axes are often required for the Signal to be used, 
     default axes will be automatically re-created when needed.
   The Axis can be specified as a rank (1-ndims) or an axis name. 
   When the Axis is empty, all axes are removed.
   The input iData object is updated if no output argument is specified.
   Axis 1 is often labelled as 'y' (rows, vertical), 2 as 'x' (columns, horizontal).

 input:  s: object or array (iData)
         AxisIndex: rank or alias name of the axis
 output: s: array (iData)
 ex:     rmaxis(iData, 1) removes the 'x' axis (rank 1)

 Version: Mar. 22, 2017
 See also iData, iData/getaxis, iData/get, iData/set, iData/setaxis

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Wed 22-Mar-2017 09:13:30 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1