User's Guide

REFAID

Generate reference aids.

Function:

Generates reference aids for an AVHRR archive image. REFAID will create database record and/or browse image reference aids.

Parameters:

Subcommand -DISK:
Read the AVHRR archive image from disk and generate the specified reference aids.

IN
Input image. The AVHRR archive image for which reference aids will be created.

BRWOPT
Browse option. Indicates if a browse image should be generated. The browse image will be placed in the ADAPSBRW directory.

  = YES:  Generate a browse image
  = NO:   Don't generate a browse image

DBOPT
Data base option. Indicates if a data base record should be generated. The data base record will be placed in the ADAPSDB directory.

  = YES:  Generate a data base record
  = NO:   Don't generate a data base record

TSTAMP
Time stamp. The time (HHMMSS) the image was originally processed through the AVHRR Data Acquisition and Processing System (ADAPS). This stamp is used to uniquely identify and match the browse and database files. If NULL, the time stamp is retrieved from the image name (characters 18 through 23). If NULL and the image name does not contain a time stamp, the current time will be used.

ERRDIR(--)
Error directory specification. If an error occurs, the AVHRR archive image will be moved into this directory. If defaulted, the ADAPSERR directory will be used as the error directory.

LOGFILE("REFAID")
Log file. Name of the log file to write all processing messages to. LOGFILE will have the ;LOG extension appended. The default is REFAID;LOG in the current directory.

REFOPT("ARCHIVE")
Refaid option. Determine what to do with the archive image reference aid once processing is complete.

  = DELETE:  Delete the input image from disk.
  = SAVE:    Retain the input image on disk.  The 
             image will remain in its current 
             directory.
  = ARCHIVE: Archive the input image.  The image will
             be moved to the ADAPSARC directory.
Subcommand -TAPE:
Read the AVHRR archive image from tape and generate the specified reference aids.

SCENEID
Scene ID. Scene ID of the archive image to be read from tape.

TAPEID
Tape ID. The ID of the tape that contains the AVHRR archive image.

BRWOPT
Browse option. Indicates if a browse image should be generated. The browse image will be placed in the ADAPSBRW directory.

  = YES:  Generate a browse image
  = NO:   Don't generate a browse image

DBOPT
Data base option. Indicates if a data base record should be generated. The data base record will be placed in the ADAPSDB directory.

  = YES:  Generate a data base record
  = NO:   Don't generate a data base record

TSTAMP
Time stamp. The time (HHMMSS) the image was originally processed through the AVHRR Data Acquisition and Processing System (ADAPS). This stamp is used to uniquely identify and match the browse and database files. If NULL, the time stamp is retrieved from the image name (characters 18 through 23). If NULL and the image name does not contain a time stamp, the current time will be used.

ERRDIR(--)
Error directory specification. If an error occurs, the AVHRR archive image will be moved into this directory. If defaulted, the ADAPSERR directory will be used as the error directory.

LOGFILE("REFAID")
Log file. Name of the log file to write all processing messages to. LOGFILE will have the ;LOG extension appended. The default is REFAID;LOG in the current directory.

Examples:

  1. LAS> refaid-tape sceneid=ah11041092051930 tapeid=017224 brwopt=yes dbopt=yes errdir=[opsavhrr.errdir] logfile=archfile tstamp=142108

    The AVHRR archive image AH11041092051930 will be read from tape 017224. The image is placed in the ADAPSPROD directory and is renamed to AH11041092051930.142108. A browse image will be created in the ADAPSBRW directory, and a data base record will be created in the ADAPSDB directory. If an error occurs, the image will be moved into the [OPSAVHRR.ERRDIR] directory. A log file named "ARCHFILE;LOG" will be created in the current directory.

  2. LAS> refaid-disk in=ah12345678901122.144359 brwopt=yes dbopt=no logfile=yourfile refopt=delete

    Reference aids will be generated for the AVHRR archive image AH12345678901122.144359 on disk. Only a browse image will be created. The time stamp used to uniquely identify the image, 144359, will be extracted from the image name. Upon completion, the image will be deleted. A log file named "YOURFILE;LOG" will be created in the current directory.

Description/Algorithm:

REFAID will create a browse image and/or a data base record for the specified AVHRR archive image. The -DISK subcommand should be used when the archive image is located on disk, while the -TAPE subcommand should be used when the image must be read from an AVHRR archive tape. The image read from tape will be placed in the ADAPSPROD directory. Upon completion, REFAID-DISK will move the image to the ADAPSARC directory, delete the archive image, or leave the archive image where it is (based on the value of REFOPT). REFAID-TAPE will delete the image from the ADAPSPROD directory upon completion. All processing messages will be appended to LOGFILE.

Nonfatal Error Messages:

  1. [refaid-hln] Processing HLN data without line work

    An error occurred while trying to overlay WDBII line work into the image. Since it is data from the HLN (Snug Harbor, Hawaii) receiving station, it will be processed without line work.

Fatal Error Messages:

  1. [refaid-ar2las] Error converting the ARCHIVE image to LAS

    An error occurred while generating a LAS image from an AVHRR archive image. Refer to the AVHRRIN User's Guide for more information.

  2. [refaid-browse] Error generating the browse image

    An error occurred while generating the browse image. Refer to the BROWSE User's Guide for more information.

  3. [refaid-credb] Error creating the data base record

    A fatal error occurred while creating the data base record in the ADAPSDB directory. Refer to the AVHRRDB User's Guide for more information.

  4. [refaid-fatal] Fatal error encountered

    A fatal error was encountered. The message preceding this message is the specific error encountered.

  5. [refaid-id] Invalid scene ID

    SCENEID must be an AVHRR archive image scene ID. Scene IDs are of the form a<TSSMMDDYYhhmmss>, where T specifies the data type, SS is the satellite number, MMDDYY is the date of acquisition, and hhmmss is the start time of acquisition. Correct any mistakes in SCENEID.

  6. [refaid-lookup] Error retrieving the lookup table values

    An error occurred while trying to retrieve lookup table values. Refer to the SETLUT User's Guide for more information.

  7. [refaid-noopt] No options specified in calling sequence

    No options were selected. At least one option must be specified.

  8. [refaid-readarch] Error reading archive image from tape

    An error occurred reading the archive image from tape. Refer to the READARCH User's Guide for more information.

  9. [refaid-renamb] Error renaming the browse image

    Reference aids are given a temporary name until all processing has completed successfully. An error occurred renaming the browse image in the ADAPSBRW directory. Refer to the CMRENAME User's Guide for more information.

  10. [refaid-renami] Error renaming the ingest image

    An error occurred moving the ingest image to ADAPSARC. Refer to the CMRENAME User's Guide for more information.

  11. [refaid-strch] Error applying stretch to the image data

    An error occurred while trying to stretch the image. Refer to the MAP User's Guide for more information.

User Notes:

  1. At least one reference aid option must be chosen.

  2. If the -TAPE subcommand is specified, the AVHRR archive image is copied from tape into the ADAPSPROD directory and is removed after reference aids have been created.