Method ao/phase


  PHASE is the phase operator for analysis objects.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: PHASE is the phase operator for analysis objects.
               Uses utils.math.phase() to compute the phase angle.
 
  CALL:        ao_out = phase(ao_in);
               ao_out = phase(ao_in, pl);
 
  PARAMETERS:  see help for data2D/applymethod for additional parameters
 
  Parameters Description
 
  VERSION:     $Id: phase.m,v 1.35 2012/01/12 12:35:54 hewitson Exp $
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ao
Sealed 0
Static 0

Parameter Description

1D

no description
Key Default Value Options Description
AXIS 'y' none The axis on which to apply the method.
DIM [] none The dimension of the chosen vector to apply the method to. This is necessary for functions like mean() when applied to matrices held in cdata objects. For tsdata, fsdata or xydata, this option has no effect.
OPTION '' none Any additional option to pass to the method.
back to top back to top

2D

no description
Key Default Value Options Description
AXIS 'y'
  • 'x'
  • 'y'
  • 'xy'
The axis on which to apply the method.
OPTION '' none Any additional option to pass to the method.
back to top back to top

3D

no description
Key Default Value Options Description
AXIS 'z'
  • 'x'
  • 'y'
  • 'z'
  • 'xyz'
The axis on which to apply the method.
DIM [] none The dimension of the chosen vector to apply the method to. This is necessary for functions like mean() when applied to matrices held in the z field of xyzdata objects.
OPTION '' none Any additional option to pass to the method.
back to top back to top

Some information of the method ao/phase are listed below:
Class name ao
Method name phase
Category Operator
CVS Version $Id: phase.m,v 1.35 2012/01/12 12:35:54 hewitson Exp $
Min input args 1
Max input args -1
Min output args 1
Max output args -1




©LTP Team