User's Guide

REATMOINFO

Return scene information from the composite date log file (REprocess to apply ATMOspheric correction using this INFOrmation)

Function:

Return scene information from the composite date log file needed to reprocess existing composites in order to apply atmospheric correction.

Parameters:

DATELOG
Date log file. The file containing the composites date band information ('short' or 'long' format). See User Note 2 for more information.

PERIODS
Period name(s). The period names that were included in the composite. For example, '1995p31' for a global composite (period 31 for 1995), '008014' for a US composite (julian days 008 through 014). NOTE: This parameter is not used if the date log file specified in DATELOG is a 'short' format file (all entries in the date log file are assumed to be within the period of interest).

SATNUM
NOAA satellite number. The number of the satellite (ie "14" for NOAA-14).

SCENELIST
Scene listing. A returned list containing the scenes used in the composite. All entries in the list with a value of "-1" signify that the scene was not used in the composite. For example, if SCENELIST(5) = -1, then we know that scene number 5 was not used in the composite. Otherwise, the positive entry is used as an index into the DATELIST array. For example, if SCENELIST(4) = 3, then scene number 4 was used in the composite, and the date of scene number 4 is stored in DATELIST(3).

DATELIST
Date listing. The list of dates used in the composite are returned in this parameter. Entries are of the form "MMDDYY".

NDAYS
Number of days. The number of entries returned in DATELIST is returned in this parameter.

OZONELIST
Ozone listing. The list of months used in the composite is returned in this parameter. The month returned in the first element of OZONELIST always coincides with the month specified in the first element of DATELIST. Entries are of the form "MM".

NMONTHS
Number of months. The number of entries returned in OZONELIST.

Examples:

  1. LAS> reatmoinfo datelog="us_239245.log" periods(="232238","239245") satnum=@satnum scenelist=@scenelist datelist=@datelist ndays=@ndays ozonelist=@ozonelist nmonths=@nmonths

    The date log file "us_239245.log" is read. The information relevant to periods "232238" and "239245" is returned in the appropriate parameters.

Description/Algorithm:

Each entry in the date log file is read.

For date log files in the 'long' format the following
comments apply:

 - If the date index is "-1", the scene was not used in
   the composite and should not be considered.
 - If the period name of the entry was not specified in
   PERIODS, the entry should not be considered (it's not
   within the period of interest).

For date log files in the 'short' format the following
comments apply:

 - All entries in the log file were used in the composite
   (all entries are assumed to be within the periods
   specified in PERIODS).
A list of all of the acquisition dates used in the composite is compiled and returned in DATELIST. A list of all the scenes used in the composite is compiled and returned in SCENELIST. A date band value (band generated by the compositing process to designate which image each pixel in the composite came from) is used as an index into SCENELIST, and SCENELIST is used as an index into DATELIST. For example, if the date band value is 10, and SCENELIST[10] is equal to 3, then DATELIST[3] contains the acquisition date of the scene referred to as scene 10 in the date band. A list of all the months used in the composite is compiled and returned in OZONELIST (at most two months).

Nonfatal Error Messages:

  1. [reatmoi-warn] Nonfatal error encountered

    A nonfatal error was encountered during processing. The error message that is displayed immediately preceding this message is the specific error that was encountered. Processing will continue.

  2. [reatmoi-clos] Error closing input file <XXXXXX>

    An error occurred closing the input file. Contact the system administrator if this error persists.

Fatal Error Messages:

  1. [reatmoi-fatal] Fatal error encountered

    A fatal error was encountered during processing. Processing is terminated. The error message that is displayed immediately preceding this message is the specific error that was encountered.

  2. [reatmoi-open] Error opening input file

    An error occurred while trying to open the input date log file. Ensure that the file exists with the proper permissions and rerun.

  3. [reatmoi-read] Error reading line in input file

    An error occurred while trying to read the input date log file. Make certain the file is properly formatted, and rerun. See User Note 2 for more information on the date log file format.

  4. [reatmoi-rparm] Error returning parameter to TAE

    An error occurred while trying to return information to TAE. Contact the system administrator if this error persists.

  5. [reatmoi-indx] Invalid scene index specified

    A scene number as specified in the date band log file is invalid. Examine the scene number values in the specified date band log file.

  6. [reatmoi-days] Maximum number of days exceeded

    The number of days used in the composite has exceeded the expected maximum number. Verify the number of days spanned by the composite being processed.

  7. [reatmoi-form] Error determining log file format

    The log file format was not determined. Refer to the sample log files ('short' or 'long' format) to determine their correct format.

User Notes:

  1. Part of the REATMO software.

  2. The date band log file is generated at the time the composite is generated. For a sample input date band log file, see the file 'us_232245;log' ('long' format), or the file '1992p19;log' ('short' format) stored under CVS as part of the REATMO module.