Home > hfrc > matlab > utility > plot_tide_ellipses.m

plot_tide_ellipses

PURPOSE ^

PLOT_TIDE_ELLIPSES - a function to plot up tidal ellipses from CODAR

SYNOPSIS ^

function [cwh, ccwh, info] = plot_tide_ellipses( ht, ts, name, snr, f, varargin )

DESCRIPTION ^

 PLOT_TIDE_ELLIPSES - a function to plot up tidal ellipses from CODAR
 data 

 Usage: [clockwise_hndls, cclockwise_hndls, info] = plot_tide_ellipses(ht,ts,name,snr,f...)

 where ht = tide HFRC object, ts = tide structure, name = name of tidal
 component of interest, snr = minimum signal-to-noise ratio for plotting
 of ellipses and f = scale factor.  All of these parameters are
 required.

 ... are parameter/value pairs for the line function.  These are applied
 equally to clockwise and counterclockwise ellipses.

 info is a [size(ht,2) x 3] matrix.  The first column is the signal to
 noise ratio of each grid point and the second column is a logical that
 is true for grid points that were clockwise and the third column is the
 handle to the ellipse for that grid point.  If no ellipse was plotted
 for a grid point, then the third column will have an NaN.

CROSS-REFERENCE INFORMATION ^

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