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

m_plot

PURPOSE ^

M_PLOT - Plots information about HFRC objects using M_map m_plot function

SYNOPSIS ^

function [hndl,t] = m_plot( h, t, varargin )

DESCRIPTION ^

 M_PLOT - Plots information about HFRC objects using M_map m_plot function

 This is a generic method that will plot information about an HFRC
 object.  It is assumed that you have already used basemap to produce a
 background map.

 Usage: handle = m_plot( hfrc_obj, 'percent_coverage', ... )
        handle = m_plot( hfrc_obj, timestep, scale, ... )
        handle = m_plot( hfrc_obj, 'grid', ... )

 In the first form, a percent coverage map will be generated using
 m_colordot.  ... represents further arguments to that
 function. percent_coverage can be abbreviated perc.  handle will be a
 set of handles to the colored dots.

 In the second form, a total vector map will be generated.  timestep can be
 a number between 1 and size(hfrc_obj,1) (# of timesteps), in which case,
 that timestep will be displayed.  If timestep is greater than
 size(hfrc_obj,1), then it is assumed that the number represents a datenum
 and the timestep with the date closest to that date will be displayed.
 timestep can also be a string of a form acceptable by datenum, in which
 case the closest timestep to that date will be displayed.  scale is how
 much to scale the total vectors by.  ... represent further arguments to
 the m_quiver function.

 In the third form, the grid points of the HFRC object will be
 plotted. ... represents further arguments to the m_plot function, such as
 'MarkerSize'.  

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

     $Id: m_plot.m,v 1.4 2006-12-18 15:20:19 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