User's Guide

CLEANUCFM

Delete AVHRR archive images from the UCFM that are more than a specified number of days old.

Function:

Deletes AVHRR archive images from the Unitree Central File Manager (UCFM) that are more than a specified number of days old. Processing will take place for each day in a specified range.

Parameters:

SATNUM
Satellite number. The satellite number for which images will be deleted.

SDATE
Starting date. Starting date for which images will be deleted. Two values should be entered as "month day" (e.g., (8 14)). This value is used to determine which directories on the UCFM to examine.

EDATE
Ending date. Ending date for which images will be deleted. Two values should be entered as "month day" (e.g., (8 15)). This value is used to determine which directories on the UCFM to examine.

YEAR(-- VALID=(0:99)
Acquisition year. The acquistion year in which to delete scenes. The year should be entered as the last two digits of the year; i.e., 94 instead of 1994. If a calendar year is spanned, scenes from the subsequent year may be deleted also. For example, if SDATE is (12 1), EDATE is (1 31), and YEAR is 93, December of 1993 and January of 1994 will be processed.

ACQTYPE
Acquisition type. The type of AVHRR data to be deleted.

  = HRPT:  High Resolution
           Picture Transmission
  = LAC:   Local Area Coverage
  = GAC:   Global Area Coverage
  = ORB:   Stitched half orbits
  = ALL:   All of the above

NDAYS
Number of days. The image must be more than NDAYS old before it will be deleted.

LOGFILE(--)
Log file. Name of the log file to which the processing messages will be appended. The default is CLEANUCFM;LOG in ADAPSLOG.

Example:

  1. LAS> cleanucfm satnum=11 sdate=(5 14) edate=(5 15) year=93 acqtype=all ndays=90

    All of the 1993 archive images in the directories "[unitree.avhrr.sat11.month05.day14]" and "[unitree.avhrr.sat11.month05.day15]" that are more than 90 days old are deleted. Messages will be logged in a file called "CLEANUCFM;LOG" within the ADAPSLOG directory.

Description/Algorithm:

For each date within the specified range, CLEANONE is called to delete the archive images on the UCFM that are more than NDAYS days old. CLEANONE will delete old images in one specific directory. CLEANUCFM will always traverse forward in time from SDATE to EDATE.

Nonfatal Error messages:

    None.

Fatal Error messages:

  1. [cleanucfm-inp] Invalid input parameter (XXXXX)

    An error was found in the starting or ending date. A month specification must range between 1 and 12. A day specification must range between 1 and 31. A year specification must range between 0 and 99.

  2. [cleanucfm-del] Error deleting images

    An error occurred while deleting the images in one of the specified directories. Check the file permissions on the UCFM.

  3. [cleanucfm-nday] Error determining next day to process

    An error was encountered while determining the next day to process. Refer to the error message immediately preceding this message.

  4. [cleanucfm-abrt] CLEANUCFM aborted by user

    The process was aborted by the user. Examine the directories to determine which images were deleted.

  5. [cleanucfm-fatal] Fatal error encountered

    A fatal error was encountered. The message displayed preceding this message is the error that was encountered. Processing terminates.

User Notes:

  1. CLEANUCFM calls CLEANONE to delete old archive images from each specified directory. CLEANONE may also be called independently.

  2. The AVHRR archive directory structure on the UCFM is based on the satellite number, month, and day of acquisition. The year of acquisition is not taken into account within the directory structure (scenes from multiple years may reside in the same directory). However, only scenes acquired in YEAR will be deleted. An exception to this is when deleting images in a date range that spans the end of the calendar year. For example, if SDATE is (12 1), EDATE is (1 31), and YEAR is 93, December of 93 and January of 94 will be deleted.