Home > hfrc > matlab > utility > m_distance_bar.m

m_distance_bar

PURPOSE ^

Usage: [bar_handle, text_handle, location] = m_distance_bar( distance, ...

SYNOPSIS ^

function [bh, th, orig] = m_distance_bar( dist, orig, orientation, edge_frac )

DESCRIPTION ^

 Usage: [bar_handle, text_handle, location] = m_distance_bar( distance, ...
                              location, orientation, edge_frac )

 dist is the distance in km.

 if location is not given, ginput will be used to get one.  location is a
 lon,lat pair with the location of the center of the bar.

 orientation is either 'horiz', 'vert', or 'revvert' (defaults to 'horiz')

 edge_frac is the length of the bars at the edge of the distance bar as
 a fraction of the total distance.

 Distance bar will look correct so long as the distance is not so big
 that the curvature of the earth is important.

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

     $Id: m_distance_bar.m,v 1.2 2006-07-25 00:13:37 dmk Exp $    

 Copyright (C) 2006 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