sample

IPW Command
Category - Foo Modeling


sample

sample

IPW User Command
Category - Foo Modeling


NAME

sample - a sample IPW command to demonstrate IPW man pages

SYNOPSIS

sample -z elev -b band[,...] [ -K ] [ -m mask ]
     [ -t big-threshold[,medium-threshold[,small-threshold]] ]
     [ image ]

DESCRIPTION

This section describes what the command does. Each paragraph should be surrounded by paragraphs tags: <P> and </P>.

References to the command should use the IPW macro "name", so if the command is renamed, the man page will be updated automatically. The name of the command should be in boldface, e.g., sample.

Tables should be specified using PRE-formatted text. For example, the following table shows those characters which must be represented by their HTML entity notation in an IPW man page:

     character            HTML notation

     double quote (")     &quot;
     less than (<)        &lt;
     greater than (>)     &gt;
     ampersand (&)        &amp;

A reference to another IPW command should be specified as a link to that command's man page, for example, isample. The link should be in boldface, so that the referenced command will stand out in the Unix version of the man page.

This is an example of some small indented segments of text. The Unix version of this man page will have the text indented as well, but without the bullets.

OPTIONS

-z elev
elev is the elevation of the reference location (m); used to compute air pressure.

-b band[,...]
Perform the calculation on only the specified bands of the input image.

-K
Accept/output temperatures in degrees K (default: degrees C).

-m mask
Use mask as a mask image. Calculations are performed only for those points in the input image whose corresponding points in mask are not 0.

-t big-threshold[,medium-threshold[,small-threshold]]
This is an example of an optional option which must have at least one argument: big-threshold. This description of the option should state any default value, e.g., (default: 60 kg/m^2).

If the option has two arguments, the second argument is taken to be the medium-threshold (default 10 kg/m^2).

If the option has three arguments, the third argument is taken to be the small-threshold (default 1 kg/m^2).

OPERANDS

image
Use image as the input image (default: standard input).

EXAMPLES

This section should include examples of how the command is used. The actual command-line that would be typed in by the user for the example should be PRE-formatted text.

Here is an EXAMPLES section based on the IPW command 'primg':

To interactively examine pixel values in image, type:

     primg -i image

then type the pixel coordinates on the standard input (but note that the coordinates must be typed in increasing line order).

If the text file "basin" contains the (line,sample) coordinates of the corners of a drainage basin in the DEM image "dem", and line, samp are the coordinates of an arbitrary point within the drainage basin, then:

     poly -s line,samp basin | primg -i dem

will print all of the pixel values in the image "dem" that lie within the drainage basin.

FILES

     $(IPW)/aux/proj/std          Standard geographic projections
     $(HOME)/ipw/foo.config       User's configuration file for
                                    Foo modeling

DIAGNOSTICS

elevation below sea level: elev

The elevation elev must be 0 or positive.

medium threshold (#) exceeds big threshold (#)

The medium-threshold must be equal to or smaller than the big-threshold.

small threshold (#) exceeds medium threshold (#)

The small-threshold must be equal to or smaller than the medium-threshold.

RESTRICTIONS

None.

HISTORY

Aug 1984
Written by J. Doe, UCSB

Jun 1987
Added the -K option. Z. Smith, USGS

Feb 1996
Increased the number of thresholds from two to three to improve model stability over small temperature variations. K. Brown, OSU

BUGS

None.

SEE ALSO

IPW:
advec, deltaT, gradient, zpr
Unix:
diff, grep

Doe, J.A., 1976. A simplied approach to the standard foobar equations. XYZ Technical Report 19, Regional Climatic Research Institute, Cascadia, TI, 150p.

Garen, D.C., and D. Marks, 1996. Spatially distributed snow modelling in mountainous regions: Boise River application. In: HydroGIS `96: Application of Geographic Information Systems in Hydrology and Water Resources Management, IAHS Publication No. 235, pp. 421-428.

Morris, E.M., 1982. Sensitivity of the European Hydrological System snow models. In: Hydrological Aspects of Alpine and High-Mountain Areas, J.W. Glen, ed., International Association of Hydrological Sciences, Wallingford, UK, IAHS-AIHS Publication 138, pp 221-231.


IPW software package / Last revised 16 March 1998 / ipw@mail.cor.epa.gov