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

HFRC

PURPOSE ^

HFRC - This creates a HFRC object.

SYNOPSIS ^

function a = HFRC(b, varargin)

DESCRIPTION ^

 HFRC - This creates a HFRC object.

 These objects are designed to contain High Frequency Radar data, such
 as that produced by CODAR.  

 Usage: There are several ways to create an HFRC object:

  new_hfrc = HFRC; % Creates an empty HFRC object.
  new_hfrc = HFRC( HFRC_obj ); % Just returns the HFRC object.
  new_hfrc = HFRC( FILENAMES, ... ); 
  new_hfrc = HFRC( DIMS );

 The third form allows you to give the names of total vector files (in
 a cellstr vector) that will be loaded into the HFRC object.  It is
 basically an interface to format4_2hfrc.m.  

 The last form creates an empty HFRC object with non-zero dimensions.
 All variables will initially be filled with zeros.  This is useful for
 filling HFRC objects by hand when the final dimensions are known.  DIMS
 should be a two element array.

 ... represent further arguments to the functions called.

 NOTE that in HFRC objects, bad or absent data can generally be represented
 by NaN's in either U or V or both, or zero values for both U and V.

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

     $Id: HFRC.m,v 1.25 2004-03-23 00:59:33 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