tipin - Creates TOVS datasets from HRPT telemetry data.

SYNOPSIS

tipin  [ parameter=value ... ]  [ outputfile ]

Parameters are: on_pass_disk, tape_device, pass_number, files_per_pass, pass_year, use_master, master_file, start_time, num_lines, hrpt_format.

DESCRIPTION

tipin creates TeraScan TOVS (TIROS Operational Vertical Sounder) sensor datasets (TIP files) from HRPT telemetry data. Input telemetry data can be read from the pass disk, tape, or standard UNIX files. Multiple passes on tape or the pass disk can be processed at once.

tipin is a machine dependent telemetry input function that generates a standard input file for preing. Note that the University of Wisconsin TOVS package is shipped without a tipin function, because as they state in their documentation, this is a host computer dependent function that they cannot provide. TeraScan supplies this version of tipin which is to be used in conjunction with the supplied version of the TOVS package.

The output TIP file contains raw 520-byte TIP records. The set of records extracted can be specified in one of two ways:

1) TIP records corresponding to AHVRR scan lines intersecting a master dataset.

2) A specific number of TIP records starting at a given time and scan sample.

NOTE: there are 3 AVHRR lines for each TIP record.

This function produces one output file. The name of this file should be called TOVSTIPI.DAT for compatibility with the subsequent TIP functions.

PARAMETERS

on_pass_disk

Answer yes if the input is from the pass disk, or no if the input is from tape or standard UNIX disk file.

Valid responses are [yes or no]. The default is no.

tape_device

If on_pass_disk=no, this is the name of the input tape device or UNIX disk file. Tape device names are machine specific. For example, the following devices are commonly used on the Sun SPARC Station:

  /dev/nwd0  - DAT, fixed blocking, APUNIX driver
  /dev/nrwd0 - DAT, variable blocking, APUNIX driver
  /dev/nsx0  - 8mm, fixed blocking, APUNIX driver
  /dev/nrsx0 - 8mm, variable blocking, APUNIX driver
  /dev/nrmt1 - 8mm or CCT, variable blocking, SUN driver

All of the above device names imply no rewind.

The default is extracted from the UNIX environment variable TAPE. Only tape devices listed in the file $PASSDIR/devtable, or simple UNIX disk files, are accepted.

pass_number

This specifies the number(s) of the pass(es) to process, when input is from tape or the pass disk. Passes are numbered starting with 1. Input tape is always assumed to be positioned at the first pass.

Valid responses for input from the pass disk are [1 to maximum number of passes that can be stored on your pass disk (see lspass)]. The default response is the number of last acquired pass.

Valid responses for input from tape are [1 to 100]. The default response is 1.

files_per_pass

If input is from tape, this is the number of tape files per pass. If files_per_pass=2, then each pass is assumed to consist of a header file, followed by a data file. If files_per_pass=1, then the tape is assumed not to have any header files.

Valid responses are [1 or 2]. The default response is 2.

pass_year

If on_pass_disk=yes, this is the year that the pass was collected. All passes processed in one execution of tipin must have the same year.

The valid range is [>=1970]. There default is [1990].

use_master

Answer yes if the data is to be selected from the intersection of a master dataset (number 1 in the description above, also see master). Answer no if subsets are to be specified by start time and sample (number 2 in description above).

Valid responses are [yes or no]. The default is yes.

master_file

If use_master=yes, this is the name of the master dataset used to specify a region for data extraction (see master). Note that the master dataset will not delineate the the region in the sense of the sample direction. All TOVS samples, for example, that extend from the beginning to the end of the scanline are written to the output data set. The full width of the scan is required for the subsequent processing steps.

Valid responses are any TeraScan dataset that contains an earth transform. The default is Master.

start_time

If use_master=no, this is the start time for data extraction. The first line with a time greater than start_time is the first output line. A response of 00:00:00 instructs tipin to begin processing at the first scan line.

Any valid time is allowed (see formats). The default is 00:00:00.

num_lines

If use_master=no, this is the number of TIP records written to the output dataset. Note that these do not correspond to scan lines. If the end of pass is detected before the output dataset is complete, the output dataset is truncated.

The valid range is [>=1]. The default is 700.

hrpt_format

OPTIONAL. This parameter defines the format of the raw telemetry to be read by tipin. The list of valid formats is [auto, scripps, dlr, toh, jwa, aes, dartcom, sharp, 14800, 14848, 15360, global, dundee, bug, lasham, lac, gac, user, jcook].

The choice auto stands for auto-sensing, which means tipin will try to guess the format based on various bit-patterns and record sizes. The other choices force tipin to read a particular format. See hrptin NOTES for descriptions of these other formats.

The default is auto. This parameter must be explicitly specified on the command line.

EXAMPLES

This example shows how to retrieve all the TIP data from the most recent HRPT pass on the pass disk.

[2] % tipin
output file(s) : char(255) ? [TOVSTIPI.DAT]
on_pass_disk   : char(  3) ? [yes]
pass_number    : int (  4) ? [3]
use_master     : char(  3) ? [yes] n
start_time     : char( 15) ? [00:00:00]
num_lines      : int       ? [700] 9999
pass number 3:Processing raw disk file 3
TOVSTIPI.DAT starts at time 21:50:23.82, sample 1.
Actual size is 1812 lines by 520 samples.
[3] %

The final message indicates that 1812 TIP records, each 520 bytes, were written to the output file.

FILES

sensorfile, orbdata, devtable

SEE ALSO

tovs, preing, ingtov, tovpre, tovret, filret, winret, tovscdf, hirscdf, tovsproc, avin, hrptin, avhrr

NOTES

See hrptin NOTES to see the input record formats supported by tipin.


Last Update: $Date: 1998/05/29 20:53:03 $