passinfo - Returns info about most recent or other online pass

SYNOPSIS

passinfo  [ parameter=value ... ]

Parameters are: archive_header, pass_number, item, std_format, master_file, target_lat, target_lon.

DESCRIPTION

passinfo retrieves and reports information about the record entries in the online pass catalog. passinfo can also be used to report information about passes archived on tape. passinfo is designed to be used in shell scripts to provide logic functions for post-processing procedures. The value of any one of several 'items' about a particular pass can be returned by a call to passinfo. The returned value is written to standard output.

The pass_number parameter identifies online passes. The archive_header parameter describes passes archived to tape. These two parameters cannot be used at the same time.

Items sunzenith and satzenith were added because items sunelev and satelev only range from 90 degrees (i.e., straight up) down to 0 degrees. Elevations below 0 degrees are reported as 0 degrees. Zeniths are allowed to range from 0 degrees (i.e., straight up) to 180 degrees (i.e., on the other side of the earth).

PARAMETERS

archive_header

OPTIONAL. archive_header lists the information contained in the archive tape header file for a given pass. The recommended way to use this parameter is as follows:

      set HDR = `archive operation=header dev_name=$TAPE`
      set X = `passinfo archive_header="$HDR" item=... `

If the archive_header parameter is used, the pass_number parameter is ignored.

pass_number

OPTIONAL. pass_number specifies which entry of the online catalog to retrieve the specified information about.

Values are [ 1 - number of partitions on passdisk ]

Default is [ last pass ]

item

OPTIONAL. item specifies what item of information about the particular online catalog entry to retrieve.

Values are [ satellite, telemetry, sunelev, satelev, sunzenith, satzenith, numlines, estlines, passnum, satazim, sunazim, flags0, flags1, flags2, flags3, flags4, device, file, blocksize, subtrack, sublat, sublon, coverage, orbit, date, time, duration ]

Default is [ satellite ]

satellite - returns the satellite name.

telemetry - returns the telemetry type.

sunelev - returns the sun elevation angle in degrees.

Return values are [ 0 - 90 ].

satelev - returns the satellite elevation angle in degrees.

Return values are [ 0 - 90 ].

sunzenith - returns the sun zenith angle in degrees.

Return values are [ 0 - 180 ].

satzenith - returns the satellite zenith angle in degrees.

Return values are [ 0 - 180 ].

numlines - returns the number of scan lines in the pass

Return values are [ >= 0 ].

estlines - returns the estimated number of scan lines in the pass

Return values are [ >= 0 ].

passnum - returns the entry number in the online catalog

Return values are [ >= 1 ].

satazim - returns the satellite azimuthal angle.

Return values are [ 0 - 360 ].

flags0 - returns the value for the archive status flag.

Values are [ 0 (None), 1 (Pending), 2 (Busy), 3 (Done), 4 (Failed) ]

flags1 - returns the value for the pass status flag.

Values are [ 0 (Idle), 2 (Busy), 3 (Done), 4 (Failed) ]

flags2 - returns 1 if pass will be catalogued, else 0.

Values are [ 0 (No), 1 (Yes) ]

flags3 - returns the pass number from tape (untested).

flags4 - unused.

device - returns the archive target device.

Return values are any full tape name from $PASSDIR/system.config.

file - returns the name of the corresponding pass partition.

Return values are any full path name from $PASSDIR/BAST.

blocksize - returns blocksize corresponding to telemetry.

blocksize * numlines = total pass size in bytes.

subtrack - returns distance from satellite subtrack to the target.

Return values can be any non-negative number.

sublat - returns latitude of satellite subtrack point closest to target.

Return values can be any number in the range [-90, 90]. North latitudes are positive; south latitudes are negative.

sublon - returns longitude of satellite subtrack point closest to target.

Return values can be any number in the range [-180, 180]. East longitudes are positive; west longitudes are negative.

coverage - returns the percent of a given master file covered by satellite pass. For NOAA passes, the sensor is assumed to be AVHRR. For DMSP passes, the sensor is assumed to be OLS.

Return values are in the range [ 0 - 100 ].

orbit - returns the orbit number of the satellite pass. A satellite's orbit number is incremented by one each time the satellite subtrack crosses over the equator from south to north.

Return values can be any non-negative number.

date - returns the date for the start of the pass.

If std_format=yes, return values are of the form yy/mm/dd, e.g., 93/05/15. Otherwise, return values are in days since January 1, 1900, inclusive.

time - returns the time for the start of the pass.

If std_format=yes, return values are of the form hh:mm:ss GMT, e.g., 23:16:40. Otherwise, return values are in seconds since 00:00:00 GMT.

duration - returns the duration of the pass.

If std_format=yes, return values are of the form hh:mm:ss, e.g., 00:11:30. Otherwise, return values are in seconds.

std_format

OPTIONAL. If std_format=yes, date items are output as yy/mm/dd and time and durat items are output as hh:mm:ss. Otherwise, date items are output in days since January 1, 1900 inclusive, and time and durat are output in seconds.

Valid responses are (yes, no). The default is yes.

master_file

OPTIONAL. master_file is used only to compute percent coverage.

The value can be any TeraScan dataset with a map projection-based earth transform. The default is Master.

target_lat

OPTIONAL. target_lat specifies the latitude of the target.

Values are any valid latitude. Default is the current receiver latitude.

target_lon

OPTIONAL. target_lon specifies the longitude of the target.

Values are any valid longitude. Default is the current receiver longitude.

EXAMPLES

Use in shell scripts as follows

set X = `passinfo item=telemetry pass_number=2`

if ($X == 'hrpt')  ...

FILES

BAST, onlinecat

SEE ALSO

llpass, lspass

NOTES

Sun and satellite elevation and azimuth calculations for a geostationary satellite pass are based on the pass start date and time. This is because the true sensor information needed to compute the scan time corresponding to target lat/lon coordinates is available only after ingesting the pass data.

Subtrack distance and master coverage calculations are not supported for geostationary satellite passes.

passinfo will be fooled if the selected pass is from a satellite other than the one listed in the online catalog; e.g., those GOES and GMS passes that have been received via Meteosat.


Last Update: $Date: 2002/05/07 23:22:49 $