Home > hfrc > matlab > @HFRC > rotate.m

rotate

PURPOSE ^

ROTATE - rotates totals currents through an angle

SYNOPSIS ^

function h = rotate( h, angle, rerrors )

DESCRIPTION ^

 ROTATE - rotates totals currents through an angle

 Usage: hfrc2 = rotate( hfrc, angle, rotate_errors )

 angle gives the angle that will be added to the angle of the current
 vectors.  Angle will be added with respect to the horizontal and the
 normal cartesian coordinates (horizontal = 0, vertical, up = pi/2 ).
 The angle should be in radians.

 Angle can be an array of the same size as the HFRC object, in which
 case it will rotate each vector differently.  Useful for looking at
 means and things like that.

 Angle can also be a column or row vector, in which case it will be
 assumed that you want to rotate each row or column, respectively of the
 HFRC object by that angle.  

 rotate_errors is a boolean, defaults to false, that specifies whether
 or not to also rotate the errors.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

     $Id: rotate.m,v 1.5 2003-09-26 19:48:46 dmk Exp $    

 Copyright (C) 2001 David M. Kaplan
 Licence: GPL (Gnu Public License)

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Mon 18-Dec-2006 07:26:46 by m2html © 2003