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

radial_component

PURPOSE ^

RADIAL_COMPONENT - returns the radial component of a set of vectors

SYNOPSIS ^

function [r,uv] = radial_component( h, o )

DESCRIPTION ^

 RADIAL_COMPONENT - returns the radial component of a set of vectors
 with respect to a given origin

 Usage: [ rad_comp, unit_vecs ] = radial_component( hfrc_obj, origin )

 If origin is not given, then hfrc_obj.info.radSitePositions(1,:) will
 be used.

 Radial components will be positive if the component of the total vector
 along the radial direction points towards the radar, as is the convention
 in CODAR radial files.

 unit_vecs is a structure with two components (U & V) that are the unit
 vectors used to calculate the radial components.  You can get the angle
 those vectors make using angle(unit_vecs.U + i*unit_vecs.V).

CROSS-REFERENCE INFORMATION ^

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