W3MISCAN
The W3MISCAN routine reads one ssm/i scan line (64 retrievals)
from the NCEP bufr ssm/i dump file. Each scan is time
checked against the user-requested time window and
satellite id combinations. When a valid scan is read
the program returns to the calling program. The user
must pass in the type of the input ssm/i dump file, either
derived products (regardless of source) or brightness
temperatures (7-channels). If the latter is chosen, the
user has the further option of processing, in addition
to the brightness temperatures, in-line calculation of
wind speed product via the Goodberlet algorithm, and/or
in-line calculation of both wind speed and total column
precipitable water (tpw) products using the neural net
3 algorithm. If the wind speed or tpw is calculated here
(either algorithm), this subroutine will check for brightness
temperatures outside of a preset range and will return a
missing wind speed/tpw if any b. temp is unreasonable. Also,
for calculated wind speeds and tpw, this program will check
to see if the b. temps are over land or ice, and if they are
it will also return missing values since these data are
valid only over ocean.
USAGE: CALL W3MISCAN(INDTA,INLSF,INGBI,INGBD,LSAT,LPROD,LBRIT,
NNALG,GBALG,KDATE,LDATE,IGNRTM,IBUFTN,IER)
Input argument list:
INDTA - UNIT NUMBER OF NCEP BUFR SSM/I DUMP DATA SET
INLSF - UNIT NUMBER OF DIRECT ACCESS NESDIS LAND/SEA FILE
- (VALID ONLY IF LBRIT AND EITHER NNALG OR GBALG TRUE)
INGBI - UNIT NUMBER OF GRIB INDEX FILE FOR GRIB FILE
- CONTAINING GLOBAL 1-DEGREE SEA-SURFACE TEMP FIELD
- (VALID ONLY IF LBRIT AND EITHER NNALG OR GBALG TRUE)
INGBD - UNIT NUMBER OF GRIB FILE CONTAINING GLOBAL 1-DEGREE
- SEA-SURFACE TEMP FIELD (VALID ONLY IF LBRIT AND EITHER
- NNALG OR GBALG TRUE)
LSAT - 10-WORD LOGICAL ARRAY (240:249) INDICATING WHICH
SATELLITE IDS SHOULD BE PROCESSED (SEE REMARKS)
LPROD - LOGICAL INDICATING IF THE INPUT BUFR FILE CONTAINS
- PRODUCTS (REGARDLESS OF SOURCE) - IN THIS CASE ONE OR
- MORE AVAILABLE PRODUCTS CAN BE PROCESSED AND RETURNED
LBRIT - LOGICAL INDICATING IF THE INPUT BUFR FILE CONTAINS
- BRIGHTNESS TEMPERATURES - IN THIS CASE B. TEMPS ARE
- PROCESSED AND RETURNED ALONG WITH, IF REQUESTED, IN-
- LINE GENERATED PRODUCTS FROM ONE OR BOTH ALGORITHMS
- (SEE NEXT TWO SWITCHES)
THE FOLLOWING TWO SWITCHES APPLY ONLY IF LBRIT IS TRUE
NNALG - LOGICAL INDICATING IF THE SUBROUTINE SHOULD
- CALCULATE AND RETURN SSM/I WIND SPEED AND TPW
- VIA THE NEURAL NET 3 ALGORITHM (NOTE: B O T H
- WIND SPEED AND TPW ARE RETURNED HERE)
GBALG - LOGICAL INDICATING IF THE SUBROUTINE SHOULD
- CALCULATE AND RETURN SSM/I WIND SPEED VIA THE
- GOODBERLET ALGORITHM
KDATE - REQUESTED EARLIEST YEAR(YYYY), MONTH, DAY, HOUR,
- MIN FOR ACCEPTING SCANS
LDATE - REQUESTED LATEST YEAR(YYYY), MONTH, DAY, HOUR,
- MIN FOR ACCEPTING SCANS
IGNRTM - SWITCH TO INDICATE WHETHER SCANS SHOULD BE TIME-
- CHECKED (= 0) OR NOT TIME CHECKED (=1) {IF =1, ALL
- SCANS READ IN ARE PROCESSED REGARDLESS OF THEIR TIME.
- THE INPUT ARGUMENTS "KDATE" AND "LDATE" (EARLIEST AND
- LATEST DATE FOR PROCESSING DATA) ARE IGNORED IN THE
- TIME CHECKING FOR SCANS. (NOTE: THE EARLIEST AND
- LATEST DATES SHOULD STILL BE SPECIFIED TO THE
- "EXPECTED" TIME RANGE, BUT THEY WILL NOT BE USED FOR
- TIME CHECKING IN THIS CASE)}
Output argument list:
IBUFTN - OUTPUT BUFFER HOLDING DATA FOR A SCAN (1737 WORDS -
- SEE REMARKS FOR FORMAT. SOME WORDS MAY BE MISSING
- DEPENDING UPON LPROD, LBRIT, NNALG AND GBALG
IER - ERROR RETURN CODE (SEE REMARKS)
Input files:
UNIT AA - (WHERE AA IS EQUAL TO INPUT ARGUMENT 'INDTA') NCEP
- BUFR SSM/I DUMP DATA SET HOLDING SCANS (SEE REMARKS
- REGARDING ASSIGN)
UNIT BB - (WHERE BB IS EQUAL TO INPUT ARGUMENT 'INLSF')
- DIRECT ACCESS NESDIS LAND/SEA FILE (SEE REMARKS
- REGARDING ASSIGN) (VALID ONLY IF LBRIT AND EITHER
- NNALG OR GBALG TRUE)
UNIT CC - (WHERE CC IS EQUAL TO INPUT ARGUMENT 'INGBI') GRIB
- INDEX FILE FOR GRIB FILE CONTAINING GLOBAL 1-DEGREE
- SEA-SURFACE TEMPERATURE FIELD (SEE REMARKS
- REGARDING CREATION AND ASSIGN) (VALID ONLY IF LBRIT
- AND EITHER NNALG OR GBALG TRUE)
UNIT DD - (WHERE DD IS EQUAL TO INPUT ARGUMENT 'INGBD')
- UNBLOCKED GRIB FILE CONTAINING GLOBAL 1-DEGREE SEA-
- SURFACE TEMPERATURE FIELD (SEE REMARKS REGARDING
- ASSIGN) (VALID ONLY IF LBRIT AND EITHER NNALG OR
- GBALG TRUE)
Output files:
UNIT 06 - PRINTOUT
REMARKS:
RETURN CODE IER CAN HAVE THE FOLLOWING VALUES:
IER = 0 SUCCESSFUL RETURN OF SCAN
IER = 1 ALL SCANS HAVE BEEN READ, ALL DONE
IER = 2 ABNORMAL RETURN - INPUT BUFR FILE IN UNIT
'INDTA' IS EITHER EMPTY (NULL) OR IS NOT BUFR
IER = 3 ABNORMAL RETURN - REQUESTED EARLIEST AND
LATEST DATES ARE BACKWARDS
IER = 4 ABNORMAL RETURN - ERROR OPENING RANDOM
ACCESS FILE HOLDING LAND/SEA TAGS
IER = 5 ABNORMAL RETURN - THE NUMBER OF DECODED
"LEVELS" IS NOT WHAT IS EXPECTED
IER = 6 ABNORMAL RETURN - SEA-SURFACE TEMPERATURE
NOT FOUND IN GRIB INDEX FILE - ERROR RETURNED
FROM GRIB DECODER GETGB IS 96
IER = 7 ABNORMAL RETURN - SEA-SURFACE TEMPERATURE
GRIB MESSAGE HAS A DATE THAT IS EITHER:
1) MORE THAN 7-DAYS PRIOR TO THE EARLIEST
REQUESTED DATE OR 2) MORE THAN 7-DAYS AFTER
THE LATEST REQUESTED DATE
IER = 8 ABNORMAL RETURN - BYTE-ADDRESSABLE READ ERROR
FOR GRIB FILE CONTAINING SEA-SURFACE
TEMPERATURE FIELD - ERROR RETURNED FROM GRIB
DECODER GETGB IS 97-99
IER = 9 ABNORMAL RETURN - ERROR RETURNED FROM GRIB
DECODER - GETGB - FOR SEA-SURFACE
TEMPERATURE FIELD - > 0 BUT NOT 96-99
INPUT ARGUMENT LSAT IS SET-UP AS FOLLOWS:
LSAT(X) = TRUE -- PROCESS SCANS FROM SATELLITE ID X (WHERE X
IS CODE FIGURE FROM BUFR CODE TABLE 0-01-007)
LSAT(X) = FALSE - DO NOT PROCESS SCANS FROM SATELLITE ID X
X = 240 IS F-7 DMSP SATELLITE (THIS SATELLITE IS
NO LONGER AVAILABLE)
X = 241 IS F-8 DMSP SATELLITE (THIS SATELLITE IS
NO LONGER AVAILABLE)
X = 242 IS F-9 DMSP SATELLITE (THIS SATELLITE IS
NO LONGER AVAILABLE)
X = 243 IS F-10 DMSP SATELLITE (THIS SATELLITE IS
NO LONGER AVAILABLE)
X = 244 IS F-11 DMSP SATELLITE (THIS IS AVAILABLE
AS OF 8/96 BUT IS NOT CONSIDERED TO BE AN
OPERATIONAL DMSP SSM/I SATELLITE)
X = 245 IS F-12 DMSP SATELLITE (THIS SATELLITE IS
NO LONGER AVAILABLE)
X = 246 IS F-13 DMSP SATELLITE (THIS IS AVAILABLE
AND IS CONSIDERED TO BE AN OPERATIONAL
ODD DMSP SSM/I SATELLITE AS OF 8/1996)
X = 247 IS F-14 DMSP SATELLITE (THIS IS AVAILABLE
AS OF 5/97 BUT IS NOT CONSIDERED TO BE AN
OPERATIONAL DMSP SSM/I SATELLITE)
X = 248 IS F-15 DMSP SATELLITE (THIS IS AVAILABLE
AS OF 2/2000 AND IS CONSIDERED TO BE AN
OPERATIONAL ODD DMSP SSM/I SATELLITE AS OF
2/2000)
X = 249 IS RESERVED FOR A FUTURE DMSP SATELLITE
NOTE: HERE "EVEN" MEANS VALUE IN IBUFTN(1) IS AN ODD NUMBER
WHILE "ODD" MEANS VALUE IN IBUFTN(1) IS AN EVEN NUMBER
CONTENTS OF ARRAY 'IBUFTN' HOLDING ONE COMPLETE SCAN (64 INDIVIDUAL
RETRIEVLAS (1737 WORDS)
=====> ALWAYS RETURNED:
WORD CONTENTS
---- --------
1 SATELLITE ID (244 IS F-11; 246 IS F-13; 247 IS F-14;
248 IS F-15)
2 4-DIGIT YEAR FOR SCAN
3 2-DIGIT MONTH OF YEAR FOR SCAN
4 2-DIGIT DAY OF MONTH FOR SCAN
5 2-DIGIT HOUR OF DAY FOR SCAN
6 2-DIGIT MINUTE OF HOUR FOR SCAN
7 2-DIGIT SECOND OF MINUTE FOR SCAN
8 SCAN NUMBER IN ORBIT
9 ORBIT NUMBER FOR SCAN
10 RETRIEVAL #1 LATITUDE (*100 DEGREES: + N, - S)
11 RETRIEVAL #1 LONGITUDE (*100 DEGREES EAST)
12 RETRIEVAL #1 POSITION NUMBER
13 RETRIEVAL #1 SURFACE TAG (CODE FIGURE)
=====> FOR LPROD = TRUE (INPUT PRODUCTS FILE: NOTE ALL PRODUCTS
BELOW ARE AVAILABLE IN THE FNOC "OPERATIONAL" PRODUCTS
DATA DUMP; MOST NCEP PRODUCTS DATA DUMPS CONTAIN ONLY
WIND SPEED AND TOTAL PRECIPITABLE WATER):
14 RETRIEVAL #1 CLOUD WATER (*100 KILOGRAM/METER**2)
15 RETRIEVAL #1 RAIN RATE (*1000000 MILLIMETERS/SECOND)
16 RETRIEVAL #1 WIND SPEED (*10 METERS/SECOND)
17 RETRIEVAL #1 SOIL MOISTURE (MILLIMETERS)
18 RETRIEVAL #1 SEA-ICE CONCENTRATION (PER CENT)
19 RETRIEVAL #1 SEA-ICE AGE (CODE FIGURE)
20 RETRIEVAL #1 ICE EDGE (CODE FIGURE)
21 RETRIEVAL #1 TOTAL PRECIP. WATER (*10 MILLIMETERS)
22 RETRIEVAL #1 SURFACE TEMPERATURE (*100 DEG. KELVIN)
23 RETRIEVAL #1 SNOW DEPTH (MILLIMETERS)
24 RETRIEVAL #1 RAIN FLAG (CODE FIGURE)
25 RETRIEVAL #1 CALCULATED SURFACE TYPE (CODE FIGURE)
=====> FOR LBRIT = TRUE (INPUT BRIGHTNESS TEMPERATURE FILE):
26 RETRIEVAL #1 19 GHZ V BRIGHTNESS TEMP (*100 DEG. K)
27 RETRIEVAL #1 19 GHZ H BRIGHTNESS TEMP (*100 DEG. K)
28 RETRIEVAL #1 22 GHZ V BRIGHTNESS TEMP (*100 DEG. K)
29 RETRIEVAL #1 37 GHZ V BRIGHTNESS TEMP (*100 DEG. K)
30 RETRIEVAL #1 37 GHZ H BRIGHTNESS TEMP (*100 DEG. K)
31 RETRIEVAL #1 85 GHZ V BRIGHTNESS TEMP (*100 DEG. K)
32 RETRIEVAL #1 85 GHZ H BRIGHTNESS TEMP (*100 DEG. K)
=====> FOR LBRIT = TRUE AND NNALG = TRUE (INPUT BRIGHTNESS
TEMPERATURE FILE):
33 RETRIEVAL #1 NEURAL NET 3 ALGORITHM WIND SPEED
(GENERATED IN-LINE) (*10 METERS/SECOND)
34 RETRIEVAL #1 NEURAL NET 3 ALGORITHM TOTAL PRECIP.
WATER (GENERATED IN-LINE) (*10 MILLIMETERS)
=====> FOR LBRIT = TRUE AND GBALG = TRUE (INPUT BRIGHTNESS
TEMPERATURE FILE):
35 RETRIEVAL #1 GOODBERLET ALGORITHM WIND SPEED
(GENERATED IN-LINE) (*10 METERS/SECOND)
36 RETRIEVAL #1 GOODBERLET ALGORITHM RAIN FLAG
(CODE FIGURE)
37-1737 REPEAT 10-36 FOR 63 MORE RETRIEVALS
(NOTE: ALL MISSING DATA OR DATA NOT SELECTED BY
CALLING PROGRAM ARE SET TO 99999)
| W3lib.tar |
Library contains Fortran 90 decoder/encoder
routines for GRIB edition 1. (Fortran90)
Date posted: 2/22/2007 |
< /html>