#!/usr/bin/perl -w

#========================================================================
# run_ice_surf_stats_usage.pl - defines run_ice_surf_stats.pl usage message
#
# 10-Apr-2002 T. Haran tharan@colorado.edu 303-492-1847
# National Snow & Ice Data Center, University of Colorado, Boulder
# $Header: /export/data/ice_recon/src/scripts/run_ice_surf_stats_usage.pl,v 1.2 2002/04/11 21:13:10 haran Exp $
#========================================================================

#
#  flush stdout with each print
#
$|=1;

$usage = "\n
USAGE: run_ice_surf_stats.pl dir_in [dir_out]
       defaults:                     dir_in

  dir_in - directory containing all the *.tif files containing ice surface
    images to be processed by ice_surf_stats.pro. Use . to indicate the
    current directory. Input filenames must be of
    the form:
      RRRRRR_YYYYMMMDDS_CC.tif
        where
          RRRRRR is the region code and must be one of:
            beaufo - Beaufort Sea, 73N 150W
            cacana - Central Arctic/Canada, 85N 120W
            cafram - Central Arctic/Fram Strait, 85N 000E
            esiber - East Siberian Sea, 82N 150E
            nbeauf - North Beaufort Sea, 82N 150W
          YYYY is the year, e.g. 2000.
          MMM is the month and must be one of:
            jan, feb, mar, apr, may, jun,
            jul, aug, sep, oct, nov, dec
          DD is the day of the month, e.g. 19.
          S is the serial letter for images of the given day, e.g. a.
          CC is the class code and must be one of:
            2c for a 2-class image.
            3c for a 3-class image.
    An example input filename is beaufo_2000jun19a_2c.tif. 

  dir_out - directory containing the *.txt files containing ice surface
    statistics produced as output from ice_surf_stats.pro. If dir_out is
    not supplied, dir_in will be used. Use . to indicate the current
    directory. If dir_out does not exist, it will be created. Output
    filenames will be of the form:
      RRRRRR_YYYYMMDDS_CC_stats.txt
    An example output filename is beaufo_2000jun19a_2c_stats.txt\n";

# this makes the routine work properly using require in other programs
1;