McIDAS Programmer's Manual

Chapter 6 - Format of the Data Files

This chapter describes the formats of the data files developed for applications running under McIDAS-X. The data files are presented alphabetically with the following information:

This chapter describes these file formats:

File

Description

AREAnnnn

Area (image) files

DC*

MD schema definition files

*.ET

Enhancement save files

FRAMED

Panel configuration file

FRAMENH.001

Frame enhancement table

FRAMEn.p

Image frame files

GMSCAL

GMS calibration file

GRIDnnnn

Grid files

*.GRX

Graphics save tables for McIDAS-X

HIRSCRPF

HIRS calibration reference parameters

HIRSTAUL

HIRS transmittance coefficients

MDXXnnnn

MD files

MSUSCRPF

MSU calibration reference parameters

OUTL*

Base map files

SATANNOT

Image annotation description file

SATBAND

Image annotation description file

SKEDFILE

Scheduled McIDAS commands

UC

McIDAS User Common

VASTBLS

VAS calibration tables

VIRTnnnn

Virtual graphics files

AREAnnnn

Area (image) files, where nnnn is a user-defined number.

In McIDAS-X, images are stored in binary files called areas. Each area file is a collection of information that defines the image and its associated ancillary data.

Area files are usually named AREAnnnn, where nnnn is a four-digit number between 0000 and 9999. This number is called the area file number. For example, AREA0013 is the name of the file containing area 13.

Areas do not have to follow this standard naming convention. The file masking option of DSSERVE may be used to access a data file of any name through the ADDE.

Area files consist of these six blocks:

Some blocks also contain satellite-specific information, which is located in the Image-specific characteristics section. For area file Application Program Interfaces (APIs), refer to the API functions list.

 

For more information about reading, writing and deleting image data, see the section titled Image data in Chapter 5, Accessing Data .

Directory block

The first 64 words of an area file contain the directory block for the image. The directory lists ancillary information about the image, such as the number of lines and data points per line, the satellite ID and the number of spectral bands. The data in the directory is stored as 32-bit (4-byte) twos- complement binary integers or as ASCII characters.

Each of the directory's 64 words is described below. Since some of the words are satellite specific, see the section titled Image-specific characteristics that follows. All byte offsets and pointers are zero-based. Note that all data shown as yyyddd are the year and day-of-year. The yyy values are the actual year modulo 1900.

Word

Description

1

relative position of the image object in the ADDE dataset

2

image type (currently=4)

3

SSEC sensor source number; see the Appendices

4

nominal year and Julian day of the image, yyyddd

5

nominal time of the image, hhmmss

6

upper-left image line coordinate

7

upper-left image element coordinate

8

reserved

9

number of lines in the image

10

number of data points per line

11

number of bytes per data point

12

line resolution

13

element resolution

14

number of spectral bands

15

length of the line prefix

16

SSEC project number used when creating the file

17

year and Julian day the file was created, yyyddd

18

file creation time, hhmmss

19

spectral band map, bands 1-32

20

spectral band map, bands 33-64

21 - 24

reserved for sensor-specific data

25 - 32

memo field; 32 ASCII characters

33

reserved

34

byte offset to the start of the data block

35

byte offset to the start of the navigation block

36

validity code

37 - 44

PDL (Program Data Load); used for pre-GOES-8 satellites

45

source of band 8; used for GOES AA processing

46

actual image start year and Julian day, yyyddd

47

actual image start time, hhmmss; in milliseconds for POES data

48

actual image start scan

49

length of the prefix documentation

50

length of the prefix calibration

51

length of the prefix band list

52

source type; satellite-specific (ASCII)

53

calibration type; satellite-specific (ASCII)

54 - 56

reserved

57

original source type

58

units

59

scaling

60

byte offset to the supplemental block

61

number of entries in the supplemental block

62

reserved

63

byte offset to the start of the calibration block

64

number of comment cards

 

 

For more information about image data, see the section titled Image data in Chapter 5, Accessing Data. For more information about coordinate systems, see the section titled Coordinate systems in Chapter 2, Learning the Basics .

Navigation block

The navigation (NAV) block contains the information for determining the location of data points in physical space. Word 35 of the directory block contains the byte offset to the start of the navigation block. If an image isn't navigated, word 35 is zero. The NAV block format varies with each satellite; see the section titled Image-specific characteristics that follows.

Calibration block

The calibration (CAL) block contains information for converting image data from its stored (internal) units to more meaningful units such as radiance or albedo. The presence of this block depends on the implementation of the satellite-specific calibration. Word 63 of the directory block contains the byte offset to the start of the calibration block. If there is no CAL block, word 63 is zero. The calibration block format varies with each satellite; see the section titled Image-specific characteristics that follows.

Supplemental (or auxiliary) block

The supplemental (or auxiliary) block contains additional information that is specific to a data type. For example, information specific to radar data is stored in this block. Also, the latitude/longitude grid for the LALO navigation is stored in this block. Word 60 of the directory block contains the byte offset to the start of the supplemental block. Word 61 contains the total number of entries in the supplemental block. If there is no supplemental block, words 60 and 61 are zero.

Data block

The data block contains the actual image data values. Any data point in an image or image sector can be located with image and file coordinates.

An area file may be produced from an image by sampling or averaging the data. In the case of multiband images, the file may include only a portion of the measured spectral bands, so that each element contains fewer data values than are contained in the original image. To map an area back to the original image, these two formulas are used:

Image Line = UpperLeftLine + (File Line * LineResolution)
Image Element = UpperLeftEle + (File Element * ElementResolution)

UpperLeftLine is the line coordinate of the first image line and UpperLeftEle is the element coordinate of the first image element. File Line and File Element are zero-based.

When LineResolution and ElementResolution are both 1, the image resolution is 1, or full resolution. If the image resolution is 4, every fourth line and element of an image originally at resolution 1 are included in the image. Each sensor has its own scan resolution, so an image resolution of one will mean different geographic resolutions from one satellite to another.

Each line is divided into two parts: the line prefix and the actual data values as shown below. The line prefix contains information about the image and the particular line.


 line prefix 1 line data 1 line prefix 2 line data 2 etc.
|_____________|___________|_____________|___________|___...
0 byte numbers increase >>

Although the size and content of the line prefix depend on the image source defined in word 52 of the directory block, each line in an image has the same prefix length. Word 15 of the directory block contains the length of the line prefix, in bytes. If no line prefix exists, word 15 is zero.

The line prefix may contain any region shown in the diagram below and described in the following table; the regions' lengths are multiples of four bytes.

 validity code   documentation   calibration   band list
|______________|_______________|_____________|___________|
0 byte numbers increase >>

Region

Description

validity code

Verifies the existence of the data portion of the image line. It is a constant value within each image and is stored in word 36 of the directory block. Comparing the value in the directory with the value of the validity code determines if data exists for an image line. If a line of data is missing, the corresponding place in the data file is either filled with zeros or flagged using non-matching validity codes.

documentation

Holds the documentation specific to each satellite. Word 49
of the directory block defines the length of the prefix documentation.

calibration

Holds the calibration coefficients for the data; needed when coefficients vary between image lines. Word 50 of the directory block defines the length of the prefix calibration.

band list

Contains an ordered list of the spectral bands comprising the data portion of the image line. Word 51 of the directory block defines the length of the prefix band list. Each band number is stored in a byte; thus, the range is 1 to 255.

Word 34 of the directory block contains the byte offset to the start of the data block. Each line in an image is the same length and a multiple of four bytes. To calculate the length of a line prefix, the line data, or the entire data block, use the formulas below.

line prefix length = doc + cal + band + 4 (if valcode is present)
line data length = nbands*nele*nbytes
line length = line prefix length + line data length
data block length = nlines * line length

The parameters used in these formulas are defined in the directory block and provided in the table below.

Parameter

Directory block word

Definition

valcode

36

length of the prefix validity code; if nonzero, the length is four bytes; otherwise it is zero

doc

49

length of the prefix documentation

cal

50

length of the prefix calibration

band

51

length of the prefix band list

nbands

14

number of bands per line

nele

10

number of data points per line

nbytes

11

number of bytes per band

nlines

9

number of lines in the image

Comment block

An area file may contain a comment (AUDIT) block containing a variety of textual information such as a list of commands run on the image object to date. Each comment record is 80 ASCII characters. Word 64 of the directory block contains the number of comment records, or cards.

TIP data

TIP (TIROS-N Information Processor) data is extracted from the AVHRR, GAC and LAC data described in the previous section. TIP data also contains information received from the MSU (Microwave Sounding Unit), the HIRS (High Resolution Infrared Sounder), and the SSU (Stratospheric Sounding Unit). These three sources measure incoming radiation in the infrared and microwave spectrum.

The navigation block for TIP data is filled with zeros; no calibration information is needed.

TIP directory block

Word

Value

Description

14

1

19

1

band map value

49

196

length of the line prefix documentation

50

0

length of the line prefix calibration

51

0

line prefix band list

52

TIRO

image source type; 4 bytes ASCII

53

RAW

calibration type; 4 bytes ASCII

TIP data block

TIP data is transmitted as 10 bits and stored as 16 bits. The 10-bit data is formatted as follows, with x representing a data bit and the rest being zero-filled after shifting: | 0 | x | x | x | x | x | x | x | x | x | x | 0 | 0 | 0 | 0 | 0 |

The line prefix for the data block contains the information below.

Region

Description

validity code

optional, but recommended to flag missing data, which requires zeros as placeholder data or a validity code that does not match the value in the area directory

documentation

196-byte DOC section from the signal transmission

calibration

0 bytes; not needed for TIP data

band list

0 bytes; not needed for TIP data

GMS

The following section describes the navigation and calibration for the visible and infrared channels of the Geostationary Meteorological Satellites, GMS-4 and GMS-5. GMS-4 has one channel of visible and one channel of infrared data. GMS-5 has two channels for visible and two channels for infrared data; only one channel of each is used. The remaining two channels are reserved for backup.

For a complete description of the line documentation fields, see NOAA Technical Memorandum NESS 107 , 1988. The band information for TIP data is provided in this manual in Appendix B, Image Information.

The tables referenced in this section are from the document Revision of GMS Stretched-VISSR Data Format , Japan Meteorological Agency, October 1993.

GMS navigation block

The following three tables list the words used in the GMS navigation block. These are 1-byte words. The first table lists all the words in the GMS navigation block and the following two tables list the words used in the attitude prediction data sub-blocks and the orbit prediction data sub-blocks.

The Type column in the tables below shows scaled integers in the format R*M.N. The R indicates real numbers, M is the number of bytes and N is the exponent.

The GMS data is also formatted using the navigation block format of GOES-7 data. The section GOES-7 AAA navigation block describes the GOES-7 navigation block.

Word

Type

Description

1-6

R*6.8

observation start time (MJD)

7-10

R*4.8

VIS channel stepping angle along line (rad)

11-14

R*4.8

IR channel stepping angle along line (rad)

15-18

R*4.10

VIS channel sampling angle along pixel (rad)

19-22

R*4.10

IR channel sampling angle along pixel (rad)

23-26

R*4.4

VIS channel center line number of VISSR frame

27-30

R*4.4

IR1 channel center line number of VISSR frame

31-34

R*4.4

VIS channel center pixel number of VISSR frame

35-38

R*4.4

IR1 channel center pixel number of VISSR frame

39-42

R*4.0

number of sensors of VIS channel

43-46

R*4.0

number of sensors of IR channel

47-50

R*4.0

VIS total line number of VISSR frame

51-54

R*4.0

IR total line number of VISSR frame

55-58

R*4.0

VIS pixel number of one line

59-62

R*4.0

IR pixel number of one line

63-66

R*4.10

VISSR misalignment angle around x-axis (rad)

67-70

R*4.10

VISSR misalignment angle around y-axis (rad)

71-74

R*4.10

VISSR misalignment angle around z-axis (rad)






75-78
79-82
83-86
87-90
91-94
95-98
99-102
103-106
107-110






R*4.7
R*4.10
R*4.10
R*4.10
R*4.7
R*4.10
R*4.10
R*4.10
R*4.7

These words are modified as a function of the horizon
points. See words 11-14 in Table A.1 in the document
Revision of GMS Stretched-VISSR Data Format

element of VISSR misalignment matrix
row 1 and column 1
row 2 and column 1
row 3 and column 1
row 1 and column 2
row 2 and column 2
row 3 and column 2
row 1 and column 3
row 2 and column 3
row 3 and column 3

111-114

R*4.4

IR2 channel center line of VISSR frame

115-118

R*4.4

IR3 channel center line number of VISSR frame

119-122

R*4.4

IR2 channel center pixel number of VISSR frame

123-126

R*4.4

IR3 channel center pixel number of VISSR frame

127-240

not used

241-246

R*6.8

daily mean of Satellite Spin Rate (rpm)

247-256

not used

257-617

attitude prediction data sub-blocks 1 through 10 (10 similar attitude prediction data sub-blocks are repeated). See the table below.

618-2352

orbit prediction data sub-blocks 1 through 8 (eight similar orbit prediction data sub-blocks are repeated); see the table below.

The table below describes an attitude data prediction sub-block. The GMS navigation block contains ten attitude data prediction sub-blocks that occupy words 257-617. Each block occupies 36 words.

Word

Type

Description

1-6

R*6.8

prediction time (UTC represented in MJD)

7-12

BCD*6

anno domini represented by BCD (YYMMDDHHmmSS: year, month, day, hour, minute, second)

13-18

R*6.8

angle between z-axis and satellite spin axis projected on yz-plane in mean of 1950.0 coordinates (rad)

19-24

R*6.11

angle between satellite spin axis and yz-plane in mean of 1950.0 coordinates (rad)

25-30

R*6.8

dihedral Angle between the Sun and the Earth measured clockwise seeing from North (rad)

31-36

R*6.8

spin Rate: spin speed of satellite (rpm)

The table describes the orbit prediction data sub-block. The GMS navigation block contains eight orbit prediction sub-blocks that occupy words 618-2352. Each block occupies 182 words.

Word

Type

Description

1-6

R*6.8

prediction time (UTC represented in MJD)

7-48

not used

49-54

R*6.6

x component of satellite position in Earth-fixed coordinates (m)

55-60

R*6.6

y component of satellite position in Earth-fixed coordinates (m)

61-66

not used

67-84

not used

85-90

R*6.8

Greenwich sidereal time in true of data coordinates (deg)

91-102

not used

103-108

R*6.8

right ascension from the satellite to the sun in the Earth-fixed coordinates (deg)

109-114

R*6.8

declination from the satellite to the sun in the Earth-fixed coordinates (deg)

115-128

not used

129-134
135-140
141-146
147-152
153-158
159-164
165-170
171-176
177-182

R*6.12
R*6.14
R*6.14
R*6.14
R*6.12
R*6.16
R*6.12
R*6.16
R*6.12

Element of nutation and precession matrix
row 1 and column 1
row 2 and column 1
row 3 and column 1
row 1 and column 2
row 2 and column 2
row 3 and column 2
row 1 and column 3
row 2 and column 3
row 3 and column 3

GMS calibration block

The GMS calibration block contains both directory and data conversion tables located in sub-blocks that follow the directory. The 128-word directory block, shown below, indicates the locations of the six sub-blocks. The starting byte offset for each sub-block varies with the data; therefore, it is shown as a variable in the directory below.

Word

Value

Description

0

GMS5

4-byte ASCII identifier

1

0x58

directory block length in bytes

2

COEF

4-byte ASCII identifier for sub-block 1

3

starting byte offset from word 0

4

4VIS or 5VIS

identifies sub-block 2

5

starting byte offset from word 0

6

4IR or 5IR1

identifies sub-block 3

7

starting byte offset from word 0

8

5IR2

identifies sub-block 4

9

starting byte offset from word 0

10

5IR3

identifies sub-block 5

11

starting byte offset from word 0

12

SPAR

identifies spares block, sub block 6

13

starting byte offset from word 0

14-21

not used

22-85

Words 1 to 256 of GMS 4-or -5 calibration block; see the table below

86-127

reserved for future tables (GMS-6, etc.)

The table below describes the calibration data sub-blocks, not all of which may be filled. The calibration data, which follows the directory, has a length of 6400 bytes.

See table A-7 in the Revision of GMS stretched-VISSR data format document for a complete description of the data block.

Byte

Descriptions

1-4

calibration information ID

5-10

data generated date (YYYYMMDDHHmm)

11

sensor selection

12-256

sub-block 1; infrared radiance calculations

257-1280

sub-block 2; visible level-to-albedo conversion tables; four 64-level tables for VIS1 through VIS4 detectors

1281-2304

sub-block 3; IR1 level-to-temperature conversion table

2305-3328

sub-block 4; IR2 level-to-temperature conversion table

3329-4352

sub-block 5; IR3 level-to-temperature conversion table

4353-6400

sub-block 6; spares

The prefixes for each scan line of visible data must contain a code indicating the detector used. The first four bytes of the documentation section should contain the following information.

Code

Description

00000000

not a visible band

6C6C0000

detector 1 of the visible band

B4B40000

detector 2 of the visible band

D8D80000

detector 3 of the visible band

FCFC0000

detector 4 of the visible band

DMSP

The Defense Meteorological Satellite Program (DMSP) satellites are polar orbiting satellites. DMSP has two sensors: the Operational Linescan System (OLS) and the Special Sensor for Microwave Imagery (SSM/I) data. The following sections describe the navigation and calibration blocks for each sensor.

DMSP Navigation Block

The table below lists the contents of the DMSP navigation block. The block contains 128 words and is used for all DMSP signal types.

Word

Value

Description

1

DMSP

navigation type; indicates the signal type being navigated

2

sensor source, year and date of the signal; ssyyddd

3

nominal time of image; hhmmss

4

1

orbit type; set to one

5

epoch date from the ASCII record below; yyddd

6

epoch time from the ASCII record below; days*1.e9

7

mean motion from the ASCII record below; deriv*1.e9

8

mean motion from ASCII record below; accel and mantissa

9

mean motion from the ASCII record below; accel and expon

10

bstart and mantissa; usually not used

11

b-start and expon; usually not used

12

inclination from the ASCII record below

13

right ascension of ascending node from the ASCII record below; deg*1.e6

14

eccentricity from the ASCII record below; ecc*1.e6

15

argument of perigee from the ASCII record below; per,deg*1e7

16

mean anomaly from the ASCII record below; anomaly*deg*
1.e6

17

mean motion; revs/day*1.e7

18-44

unused

45

data type; OLS, MT, MT2 or MI

46

ascending LT; 0=morning, 1=evening

47

number of first scan to navigate

48

time of first scan; sec*1.e3

49

scan flipped flag; 0=no 1=yes

50

element flipped flag; 0=no 1=yes

51

unused

52

number of elements per scan

53-120

unused

121-128

32-character ASCII record

The DMSP navigation block includes a 0-based, type 8 ASCII record, in words 120-127, that contains the scaled integer values used by the navigation block. The table below describes the ASCII record.

Character numbers

Description

3-4

spacecraft ID

6-17

epoch date; a decimal point indicates a fraction of a day

18-25

mean motion derivative

26-28

mean motion acc mantissa

28-30

mean motion acc exponent

32-39

inclination

41-48

RA of ascending mode

50-56

eccentricity

58-65

perigee

67-74

mean anomaly

76-85

mean motion

DMSP Calibration

The OLS and microwave sensors use different calibration. The OLS calibration uses only one pair of of gain and offset parameters to transform infrared pixel values to radiance. The offset is set to 190.0 and the gain is set to .4706. The calibration module kbxols.dlm contains the offset pair. The visible pixels are not calibrated.

For the microwave sensors, each data line is calibrated and the information is stored in the documentation section. A postprocessor, DMSPCAL, calculates the gains and offsets from the information in the documentation section. The table below describes the calibration documentation for each line of data.

Bytes

Description

0-1

validity code

2-4

hot load temperatures; two measurements in byte 2, one measurement in byte 3

5-6

radiometer temperatures; forward radiometer temperature

7-13

instantaneous gain; one for each channel; these are calculated from the hot load temperatures and cold counts
hotloadavg = average of 3 hotload temperatures
hotcountavg = average of band hot counts
coldcountbandavg = avg of band cold counts
instantaneousbandgain = (hotloadavg-2.7k)/
(hotcountbandavg-coldbandavg)

14-15

reference voltages; reference voltage and reference return both from block 6

16-20

cold voltages band 1

21-25

hot voltage band 1

26-30

cold voltages band 2

31-35

hot voltages band 2

36-40

cold voltages band 3

41-45

hot voltages band 3

46-50

cold voltages band 4

51-55

hot voltages band 4

56-60

cold voltages band 5

61-65

hot voltages band 5

66-70

cold voltages band 6

71-75

hot voltages band 6

76-80

cold voltages band 7

81-85

hot voltages band 7

When DMSPCAL is run, a gain and offset for each channel is placed in the calibration section of each scan line prefix. The table below describes the byte location of each gain and offset pair.

Bytes

Description

0-1

gain, band 1

2-3

offset, band 1

4-5

gain, band 2

6-7

offset, band 2

8-9

gain, band 3

10-11

offset, band 3

12-13

gain, band 4

14-15

offset, band 4

16-17

gain, band 5

18-19

offset, band 6

20-21

offset, band 6

22-23

gain, band 7

24-25

offset, band 7

Geographic Projections

The structure of the succeeding words of the following geographic projections are listed here:

Lambert Conformal

If the type is LAMB, this is the structure of the succeeding words:

Word

Description

2

image line of the North Pole

3

image element of the North Pole

4

standard latitude 1, DDDMMSS

5

standard latitude 2, DDDMMSS

6

spacing at standard latitude, M

7

normal longitude, DDDMMSS

8

radius of the planet, M

9

eccentricity of the planet, x1000000

10

coordinate type, &ge 0 planetodetic, < 0 planetocentric

11

longitude convention, &ge 0 west positive, < 0 west negative

12-120

reserved

121-128

memo entry; up to 32 characters of comments

Mercator

If the type is MERC, this is the structure of the succeeding words:

Word

Description

2

image line of the equator

3

image element of the equator

4

standard latitude

5

spacing at standard latitude, meters

6

normal longitude, DDDMMSS

7

radius of the planet, M

8

eccentricity of the planet, x1000000

9

coordinate type, &ge 0 planetodetic, < 0 planetocentric

10

longitude convention, &ge 0 west positive, < 0 west negative

11-120

reserved

121-128

memo entry; up to 32 characters of comments

Polar Stereographic

If the type is 'PS ' (four characters), this is the structure of the succeeding words:

Word

Description

1

PS

2

image line of the North Pole

3

image element of the North Pole

4

standard latitude, DDDMMSS

5

spacing at standard latitude, M

6

normal longitude, DDDMMSS

7

radius of the planet, M

8

eccentricity of the planet, x1000000

9

coordinate type, &ge 0 planetodetic, < 0 planetocentric

10

longitude convention, &ge 0 west positive, < 0 west negative

11-120

reserved

121-128

memo entry; up to 32 characters of comments

Radar

If the type is RADR, this is the structure of the succeeding words:

Word

Description

2

row (image coordinates) of the radar site

3

column (image coordinates) of the radar site

4

latitude of the radar site, DDDMMSS

5

longitude of the radar site, DDDMMSS

6

pixel resolution, meters

7

rotation of north from vertical, degrees x1000

8

if present, same as 6, but only for longitude direction

Rectilinear

If the type is RECT, this is the structure of the succeeding words:

Word

Description

2

a particular image row number

3

latitude corresponding to word 2, degrees x10000

4

a particular image column number

5

longitude corresponding to word 4, degrees x10000

6

latitude degrees/image line, degrees x10000

7

longitude degrees/image line, degrees x10000

8

radius of the planet, meters

9

eccentricity of the planet, x1000000

10

coordinate type, &ge 0 planetodetic, < 0 planetocentric

11

longitude convention, &ge 0 west positive, < 0 west negative

API functions

Function

Description

mcadir

opens a connection to read the directory block from an image object

mcadrd

reads the directory block from an image object

mcaget

opens a connection to read the data block from an image object

mcalin

reads the data portion of the current image line

mcapfx

reads the prefix portion of the current image line

mcanav

reads the navigation block of an image object

mcacal

reads the calibration block of an image object

mcacrd

reads the comment block of an image object

mcafree

frees the handle and memory of a connection opened by mcaget

mcaput

opens a connection to write the directory, navigation and calibration blocks of an image object

mcaout

writes the line prefix and data portions of an image line

mcacou

writes the comment block to an image object

mcadel

deletes image objects from a dataset

mcasort

gets the parameters from the command line and adds them to the selection array for a future mcaget call

DC*

MD schema definition files.

Schema definition files are ASCII text files that contain lines of text defining the structure of MD files for point-source data types. To create a schema definition file, use a standard editor to enter a set of text lines. The file serves as input to the schema registration program, SCHE, that reads the text lines and forms a blueprint of the MD file's structure. SSEC distributes the schema definition files below with every McIDAS upgrade.

Schema file

Contents

DCFO14

NGM MOS forecasts

DCIRAB

international radiosonde observations

DCISEN

isentropic data

DCISFC

international surface hourly observations

DCISHP

international ship and buoy observations

DCPIRP

PIREP, AIREP and ACARS data

DCSYN

surface synoptic observations

Because schema definition files form the input to an application, you must use the formats provided below for each text line of a schema file.

File header

A header is required for each schema definition file. Its format is shown below, followed by a table of parameter definitions.

SCHEMA name version date id "description

Parameter

Definition

name

four-character schema name

version

schema version number

date

Julian day the schema definition file was created

id

schema identification number

"description

comments

Row and column headers

Either a row header or a column header is required for each schema definition file. The row and column header formats are shown below, followed by a table of parameter definitions.

ROWS nrows "description
rkeyname1 rscale1 runits1
"description
...
rkeynameN rscaleN runitsN
"description

Parameter

Definition

nrows

default number of rows to make for this MD file

rkeyname1 ... N

name of the first and Nth row header keys

rscale1 ... N

scale factor of the first and Nth row header keys

runits1 ... N

physical units of the first and Nth row header keys

"description

comments

COLUMNS ncols "description
ckeyname1 cscale1 cunits1
"description
...
ckeynameN cscaleN cunitsN
"description

Parameter

Definition

ncols

default number of columns to make for this MD file

ckeyname1 ... N

name of the first and Nth column header keys

cscale1 ... N

scale factor of the first and Nth column header keys

cunits1 ... N

physical units of the first and Nth column header keys

"description

comments

Data lines

Use the format below for the data lines.

DATA
dkeyname1 dscale1 dunits1 "description
...
dkeynameN dscaleN dunitsN
"description

Parameter

Definition

dkeyname1 ... N

name of the first and Nth data keys

dscale1 ... N

scale factor of the first and Nth data keys

dunits1 ... N

physical units of the first and Nth data keys

"description

comments

Repeat groups

Repeat groups are optional. They are useful when data of the same type is repeated within the data portion of a record. The format is shown below.

REPEAT nrepeats
rkeynames rscales runits
"description

Parameter

Definition

nrepeats

number of repeat groups in the data portion of the schema definition

rkeynames

names of the repeated data keys

rscales

scale factors of the repeated data keys

runits

physical units of the repeated data keys

"description

comments

End-of-schema and comment formats

To end the schema definition file, use ENDSCHEMA . To enter comments, use the format "comments.

API functions

No API functions exist for reading and writing MD schema definition files.

For more information about MD file schemas and associated terminology, see the MDXXnnnn data structure in this chapter.

*.ET

Enhancement save files, where * is a user-defined file name.

Enhancement save files are binary files, each containing an 817-word (3268-byte) table. Words 2 through 768 contain the red, green and blue color intensities for each of the possible 256 brightness values. The individual intensities have a physical range of 0 to 255, where 0 is the minimum and 255 is the maximum intensity.

Word allocation

Word

Description

0

reserved for system use

1

red color intensity for an image brightness of 0

2

red color intensity for an image brightness of 1

3

red color intensity for an image brightness of 2

...

...

256

red color intensity for an image brightness of 255

257

green color intensity for an image brightness of 0

258

green color intensity for an image brightness of 1

259

green color intensity for an image brightness of 2

...

...

512

green color intensity for an image brightness of 255

513

blue color intensity for an image brightness of 0

514

blue color intensity for an image brightness of 1

515

blue color intensity for an image brightness of 2

...

...

768

blue color intensity for an image brightness of 255

769-816

reserved

API functions

Currently, no API library functions exist for reading or writing enhancement save files.

FRAMED

Panel configuration file.

The panel configuration file is a binary file that describes the layout of the panels for each image frame. If it is not present, all frames are single-paneled (i.e. full screen). There are two bytes per frame, one for the number of panels in the x-direction and one for the number of panels in the y-direction. Up to 127 panels in each axis can be defined for a single frame.

If the frame has never been paneled with the PANEL command, the two bytes contain HEX 8080. If the frame was explicitly set to 1x1 geometry, the bytes contain HEX 0101. The software considers them both to represent a single panel frame.

Byte allocation

Byte

Description

0

number of panels in the x-direction for frame 1

1

number of panels in the y-direction for frame 1

2

number of panels in the x-direction for frame 2

3

number of panels in the y-direction for frame 2

...

...

FRAMENH.001

Frame enhancement table.

The frame enhancement file is a binary file that contains an 816-word
(3264-byte) table for each frame allocated for the session. To calculate the word position of a particular frame's enhancement table, use the formula below.

position = (frame number * 816) + 1

In each table, the first 768 words contain the red, green and blue color intensities for each of the possible 256 brightness values. The individual intensities have a physical range of 0 to 255, where 0 is the minimum and 255 is the maximum intensity.

Word allocation for each file

Word

Description

0 - 815

reserved for system use

816 - 1631

image frame 1 enhancement table

1632 - 2447

image frame 2 enhancement table

2448 - 3263

image frame 3 enhancement table

...

...

Word allocation for each table

Word

Description

0

red color intensity for an image brightness of 0

1

red color intensity for an image brightness of 1

2

red color intensity for an image brightness of 2

...

...

255

red color intensity for an image brightness of 255

256

green color intensity for an image brightness of 0

257

green color intensity for an image brightness of 1

258

green color intensity for an image brightness of 2

...

...

511

green color intensity for an image brightness of 255

512

blue color intensity for an image brightness of 0

513

blue color intensity for an image brightness of 1

514

blue color intensity for an image brightness of 2

...

...

767

blue color intensity for an image brightness of 255

768-815

reserved

API functions

Currently, no API library functions exist for reading and writing frame enhancement files.

FRAMEn.p

Image frame files, where n is the frame number and p is the panel number.

The image frame file is a binary file that describes the contents of an image frame. For single panel (i.e. full screen) frames, y is zero. A single panel frame 1 uses file FRAME1.0; a 4-panel frame 2 uses files FRAME2.1 through FRAME2.4.

The file has three components:

The default size of the user extension is zero. The size can be modified by editing the the file m0panel.h and rebuilding McIDAS-X. No SSEC programs use the extension.

The navigation block contains the information for determining the location of the data points in physical space. The navigation block's format varies with each satellite. See the section titled Image-specific characteristics for image files (AREAnnnn).

For image frame Application Program Interfaces (APIs), refer to the API functions listing.

Frame directory

Word

Description

0

sensor source number; -1 means no image is currently loaded on the frame and the remaining words can be ignored; see the SATANNOT file in this chapter for a description of the sensor source numbers

1

year and Julian day of the image, ccyyddd

2

time of the image, hhmmss

3

spectral band

4

upper-left image line in satellite coordinates

5

upper-left image element in satellite coordinates

6

reserved for system use

7

image frame line containing the upper-left image line

8

image frame element containing the upper-left image element

9

value specified for lmag in IMGDISP's MAG keyword, if it's positive;
1 if lmag is negative

10

displayed line resolution factor (where 1=base resolution of the instrument) if lmag in IMGDISP's MAG kewyord is negative;
line resolution factor of source image file if lmag is positive

11

displayed element resolution if emag in IMGDISP's MAG keyword is negative;
element resolution factor of source image file if emag is positive

12

year and Julian day the image was created, ccyyddd

13

time the image was created, hhmmss

14

year and Julian day the image frame was created, ccyyddd

15

time the image frame was created, hhmmss

16-18

reserved

19

value specified for lmag in IMGDISP's MAG keyword

20

value specified for emag in IMGDISP's MAG keyword

21 - 31

reserved

32

if positive, element blowup; if negative, same as word 11

33 - 35

reserved

36

original source type if changed by IMGCOPY, IMGREMAP, etc.; CHARACTER

37 - 38

file name used by the SU application; CHARACTER

39 - 52

reserved

53

displayed geographic line resolution x100 if GEORES=YES is specified in IMGDISP;
0 if GEORES=YES is not specified

54

displayed geographic element resolution x100 if GEORES=YES is specified in IMGDISP;
0 if GEORES=YES is not specified

55 - 60

ASCII ADDE dataset name from IMGDISP

61

position number within the ADDE dataset

62 - 63

NEXRAD station ID (NEXRAD image only)

API functions

Fortran Function

Description

erafrm

flags a frame directory or navigation block as unused (erased)

frtonv

reads a navigation block

getfrm

reads a frame directory block

m0getusr

reads a user extension block

m0putusr

writes a user extension block

nvtofr

writes a navigation block

putfrm

writes a frame directory block

GMSCAL

GMS calibration file.

GMSCAL is a binary file that contains calibration data for GMS VIS (visible) and IR (infrared) sensor data transmitted in the GMS Stretched-VISSR real-time signal.

VIS data is 6-bit. Calibration is achieved with a 64-value VIS level-albedo lookup table. This calibration table is interpolated to make a 256-value table. IR data is 8-bit. Calibration is achieved with a 256-value IR level- temperature lookup table, which may change with the spacecraft.

The GMS calibration file is supplied with McIDAS-X.

Word allocation

Word

Description

0

number of IR calibration tables in the file

1

identification number of the first IR table in the file

2

identification number of the second IR table in the file

511

identification number of the 511th IR table, if present

512 - 767

interpolated VIS calibration table; albedos are multiplied by 10**6 and stored as integers

1024 - 1279

first IR calibration table in the file; it corresponds to the identifier stored in word 1; temperatures are multiplied by 10**3 and stored as integers

1280 - 1535

second IR calibration table in the file; it corresponds to the identifier stored in word 2 and is only present if the calibration table changes with the spacecraft

API functions

Currently, no API library functions exist for reading and writing GMSCAL.

Image-specific characteristics

Some aspects of McIDAS-X area files are specific to their image type. This section describes characteristics specific to the following types:

Although the descriptions for each image type vary, most include information about the directory, data, navigation and calibration blocks.

GRIDnnnn

Grid files, where nnnn is a user-defined number.

A grid has two components:

A grid file is a binary file, which may contain a user-defined maximum number of grids. By default, a grid file is created with the ability to store 159 grids unless otherwise specified.

Grid file numbers can be between 1 and 999999. If a grid file number is five or six digits, the file name begins with only GRI or GR. For example, grid file number 12345 has the file name GRI12345, but grid file number 123456 has the file name GR123456.

Grid files do not have to follow this standard naming convention. The file masking option of DSSERVE may be used to access a data file of any name through the ADDE.

The word allocation for grid files is divided into several sections below. The grid file directory is described first, followed by the grid header. The first 33 words and words 40 through 64 of the grid header are the same for all grid types; however, words 34 to 39 are specific to a particular grid type.

For grid file Applications Program Interfaces (APIs), refer to the API functions list at the end of this section.

Grid file directory

Word

Description

0 - 7

32 characters of label information

8

project number used to create the grid file

9

date the file was created, yyyddd

10

maximum number of grids (n) in the grid file

10+1

word offset, from the beginning of the grid file, where grid 1 starts; if the offset is -1, no grids exist

...

...

10+n

word offset for grid n

10+ n+1

next available address to start writing the next grid

Grid header

Each grid header contains 64 words. The offset of the first word in the header is defined by the word offset in Words 10 +1 through 10 + n in the grid file, where n is the grid number.

Header Word

Description

1

total size; rows * columns (not to exceed the value of MAXGRIDPT in g ridparm.inc)

2

number of rows

3

number of columns

4

Julian date of the data, ccyyddd

5

time of the data, hhmmss

6

forecast time for the grid, if applicable

7

name of the gridded variable, four character ASCII

8

scale of the gridded variable, specified as a power of 10

9

units of the gridded variable, four character ASCII

10

value of the vertical level
1013 = 'MSL'
999 = ' '
0 = 'TRO'
1001 = 'SFC'
(Otherwise, it is displayed as entered.)

11

scale of the vertical level

12

unit of the vertical level

13

gridded variable type:
1 = time difference
2 = time average
4 = level difference
8 = level average
(or any sum of 1, 2, 4 and 8)

14

used if the grid parameter is a time difference or time average, hhmmss

15

used if the grid parameter is a level difference or level average; values are the same as Word 9

16 - 32

reserved

33

grid origin; identifies the type of program that generated the grid d ata

34

grid projection type:
1 = pseudo-Mercator
2 = polar stereographic or Lambert conformal
3 = equidistant
4 = pseudo-Mercator (more general)
5 = no navigation
6 = tangent cone

35 - 40

varies, depending on the grid type; see the GRIDnnnn data file in Chapter 6 for more information

41 - 52

reserved; filled only if the grid was created by the McIDAS-XCD GRIB decoder

49

geographic grib number

50

parameter grib number

51

model grib number

52

level grib number

53 - 64

grid description

Remaining header words if grid type = 1 or 4 (pseudo-Mercator)

Header Word

Description

35

maximum latitude of the grid, degrees*10000

36

maximum longitude of the grid, degrees*10000

37

minimum latitude of the grid, degrees*10000

38

minimum longitude of the grid, degrees*10000

If TYPE=1:

39

increment between grid points; same in x/y directions

40

reserved

If TYPE=4:

39

increment between the grid points (latitude)

40

increment between the grid points (longitude)

Remaining header words if grid type = 2 (polar stereographic or Lambert conformal)

Header Word

Description

35

row number of the North Pole*10000

36

column number of the North Pole*10000

37

column spacing at standard latitude, meters

38

longitude parallel to columns, degrees*10000

39 - 40

standard latitudes, degrees*10000; set these two equal for polar stereographic

Remaining header words if grid type = 3 (equidistant)

Header Word

Description

35

latitude of (1,1), degrees*10000

36

longitude of (1,1), degrees*10000

37

clockwise rotation of column 1 relative to north, degrees*10000

38

column spacing, in meters

39

row spacing, in meters

Remaining header words if grid type = 5 (no navigation)

Header Word

Description

35 - 40

reserved

Remaining header words if grid type = 6 (tangent cone)

Header Word

Description

35

row number of the North Pole*10000

36

column number of the North Pole*10000

37

column spacing at standard latitude, meters

38

longitude parallel to columns, degrees*10000

39

standard latitude, degrees*10000

40

reserved

Reserved header words if grid was created by the McIDAS-XCD GRIB decoder

For more information, refer to the National Centers for Environmental Prediction Office Note 388: GRIB, Edition 1.

Header Word

Description

47

date grid was filed, yyyddd

48

time grid was filed, hhmmss

49

original geographic ID; GRIB projection number (PDS octet 7)

50

original parameter ID; GRIB parameter number (PDS octet 9)

51

original process ID or model number (PDS octet 6)

52

original level type (PDS octet 10)

Grid data

Word

Description

offset + 64

beginning of the grid data

...

...

offset + 64 + (rows*columns) - 1

end of the grid data

API functions

Function

Description

mcgdir

opens a connection to read a grid file directory

mcgdrd

reads a grid file directory

mcgfdrd

reads a grid file header

mcgget

opens a connection to read a grid

mcgridf

reads a grid in Fortran (column-major) order

mcgridc

reads a grid in C (row-major) order

mcgput

opens a connection to write a grid

mcgoutf

writes a grid in Fortran (column-major) order

mcgoutc

writes a grid in C (row-major) order

igquit

deletes a grid file

m0gsort

gets grid selection parameters from the command line

*.GRX

Graphics save tables for McIDAS-X, where * is a user-defined file name.

These binary files contain a table of the red, green and blue color intensities (0 to 255) for the graphics levels on a McIDAS-X workstation. The table is of variable length, depending on the number of graphics levels allocated by the McIDAS-X session that generated the file. Use the GU application to create a McIDAS-X graphics save table.

For graphics save tables Application Program Interfaces (APIs), refer to the API functions list at the end of this section.

Word allocation

Word

Description

0 - 3

reserved

4

red color intensity for graphics level 1

5

green color intensity for graphics level 1

6

blue color intensity for graphics level 1

...

...

3 * (n-1) + 1

red color intensity for graphics level n

3 * (n-1) + 2

green color intensity for graphics level n

3 * (n-1) + 3

blue color intensity for graphics level n

...

...

3 * (max-1) + 1

red color intensity for the maximum graphics level

3 * (max-1) + 2

green color intensity for the maximum graphics level

3 * (max-1) + 3

blue color intensity for the maximum graphics level

API functions

Fortran
Function

Description

delgra

deletes a saved graphics table

resgra

restores a saved graphics table

savgra

writes a graphics save table

HIRSCRPF

HIRS calibration reference parameters.

HIRS calibration reference parameters are used to compute HIRS brightness temperatures. This binary file is organized chronologically by satellite with the last record being the most recent. Each record contains
48 words.

The first record is a header record. The following records contain data. Words 0 through 39 in the data records are the coefficients of fourth degree polynomials used to convert platinum resistance thermistor count values to temperatures. The first four words in each group of eight are for the warm blackbody target, and the fifth through eighth words in each group are for the cool blackbody, which is not routinely used in the calibration process.

This file is supplied with McIDAS-X.

For HIRS calibration reference parameters Application Program Interfaces (APIs), refer to the API functions list at the end of this section.

Word allocation for record 1

Word

Description

0

total number of records in the file

1 - 47

unused

Word allocation for records 2 through n

Word

Description

0 - 7

array of thermistor counts-to-temperature coefficients,
zeroth order

8 - 15

array of thermistor counts-to-temperature coefficients,
first order

16 - 23

array of thermistor counts-to-temperature coefficients,
second order

24 - 31

array of thermistor counts-to-temperature coefficients,
third order

32 - 39

array of thermistor counts-to-temperature coefficients,
fourth order

40 - 43

array of weights for blackbody target temperature

44

coefficient for calibrating the HIRS visible channel

45

reserved

46

NOAA satellite number

47

date, yyyddd

API functions

Function

Description

hircon

initializes the HIRS constants

HIRSTAUL

HIRS transmittance coefficients.

HIRSTAUL is a binary file containing 506-word records provided by the sensor source. Each sensor source has 20 records:

  • Records 1 through 19 contain transmittance coefficients for channels 1 through 19 of the HIRS instrument.
  • Record 20 contains other parameters used for radiative transfer calculations.

This file is supplied with McIDAS-X.

For HIRS transmittance coefficients Application Program Interfaces (APIs), refer to the API functions list at the end of this section.

Word allocation for records 1-19

Word

Description

0 - 199

carbon dioxide transmittance coefficients

200 - 319

carbon dioxide angular correction coefficients

320 - 325

continuum transmittance coefficients

326 - 339

water vapor transmittance coefficients

340 - 419

ozone transmittance coefficients

420 - 499

ozone angular correction coefficients

500 - 505

flags indicating whether to use coefficients

Word allocation for record 20

Word

Description

0 - 19

central wave numbers of the channels

20 - 59

coefficients for the Planck function

60 - 99

band correction coefficients

100 - 139

reserved

140 - 144

solar coefficients

145 - 157

flux coefficients

158 - 179

reserved

180 - 187

synthetic coefficients for the surface temperature

188 - 189

reserved

190 - 197

empirical coefficients for the surface temperature

198 - 505

reserved

API functions

Function

Description

pfcoef

retrieves HIRS Planck function, solar, flux and surface temperature coefficients

MDXXnnnn

MD files, where nnnn is a user-defined number.

MD files contain data records addressed by row and column coordinates. All records in a row also share information called a row header. Similarly, all records in a column share a column header. A complete record thus consists of the row header, column header and data. The headers hold parameters common to the data records. Row headers are located in column 0; column headers are in row 0. Fields in a record are identified by 4-character names called keys. Data values are stored as integers. Each record can be up to 400 words long; individual fields in a record are one word (4 bytes) long.

The MD file structure is self-contained. All information for accessing one of these binary files exists in the 4096-word header, which contains the schema specifying the default number of rows and columns in an MD file; the composition of the row headers, column headers and data records; and the names, scale factors, and units of the keys.

A copy of the schema resides in the MD file and in the McIDAS-X disk file named SCHEMA, which contains all schemas recognized by the system. The copy held in SCHEMA serves as a blueprint for all MD files of a particular kind of data. When an MD file is created, the schema is copied from SCHEMA to the MD file header block with all appropriate modifications.

MD file numbers can be between 1 and 999999. If an MD file number is five or six digits, the file name begins with only MDX or MD. For example, MD file number 12345 has the file name MDX12345, but MD file number 123456 has the file name MD123456.

MD files do not have to follow this standard naming convention. The file masking option of DSSERVE may be used to access a data file of any name through the ADDE.

For MD file Application Program Interfaces (APIs), refer to the API functions list at the end of this section.

Word allocation

Word

Description

0

schema name

1

schema version number

2

schema registration date, yyyddd

3

default number of rows

4

default number of columns

5

total number of keys in the record

6

number of keys in the row header

7

number of keys in the column header

8

number of keys in the data portion

9

1-based position of the column header

10

1-based position of the data portion

11

number of repeat groups

12

size of the repeat group

13

starting position of the repeat group

14

missing data code

15

integer ID of the file

16 - 23

text ID of the file

24

creator's project number

25

creation date, yyyddd

26

creator's ID

27

zero-based offset to the row header

28

zero-based offset to the column header

29

zero-based offset to the data portion

30

first unused word in the file

31

start of the user record

32

start of the key names

33

start of the scale factors

34

start of the units

35 - 38

reserved

39

beginning Julian day of the data, ccyyddd

40

beginning time of the data, hhmmss

41

ending Julian day of the data, ccyyddd

42

ending time of the data, hhmmss

43 - 60

reserved

61 - 62

file name

63

MD file number

64 - 463

user record, MD coordinates (0,0); not described by the schema; use for storing arbitrary information

464 - 863

names of the file keys

864 - 1263

scale factors for the keys

1264 - 1663

units of the keys

1664 - 4095

reserved


The row header begins at word 4096. The row header's length in words is rows * number of keys in the row header .

Following the row header is the column header. The column header's length is columns * number of keys in the column header .

The MD data follows the column header. The data's length is rows * columns * number of keys in the data portion . Any remaining words are available for user purposes.

Words 39-42 are filled in only during the production of real-time files. When real-time file data is copied to other MD files, words 39-42 in the destination files are set to null.

API functions

Function

Description

m0pthdr

opens a connection to read a point source data header

m0ptrdhdr

reads the point source data header

m0ptget

opens a connection to read point source data

m0ptrd

reads point source data

mdo

writes point source data

mdquit

deletes a point source file

m0psort

gets point source selection parameters from the command line

MSUSCRPF

MSU calibration reference parameters.

The parameters in MSUSCRPF compute MSU (Microwave Sounding Unit) brightness temperatures and check the quality of MSU data. This binary file is organized chronologically by date; the last record is the most recent. Each record contains 48 words. There may be more than one record for a particular satellite.

The first record is a header record. The following records contain data. Words 0 through 11 in the data records are the coefficients of second-degree polynomials used to convert platinum resistance thermistor resistance measurements to temperatures for the internal warm targets.

This file is supplied with McIDAS-X.

For MSU calibration reference parameters Application Program Interfaces (APIs), refer to the API functions list at the end of this section.

Word allocation for record 1

Word

Description

0

total number of records in the file

1 - 47

unused

Word allocation for records 2 through n

Word

Description

0 - 3

resistance-to-temperature coefficients, zeroth order; if word 0 is the missing value, the record was deleted

4 - 7

resistance-to-temperature coefficients, first order

8 - 11

resistance-to-temperature coefficients, second order

12 - 23

coefficients to linearize MSU counts

24 - 27

high and low calibration points for electronic systems A and B

28 - 35

average space and target temperatures for channels 1 to 4

36 - 43

standard deviations of space and target temperatures for channels 1 to 4

44

nominal target temperature

45

MSU serial number

46

NOAA satellite number

47

date, yyyddd

API functions

Function

Description

msucon

initializes the MSU constants

OUTL*

Base map files, where * is the map file name.

These variable-length, binary files contain the base map data for drawing graphical map outlines. The map files and their descriptions are provided in the table below.

Map file

Description

OUTLSUPU

high resolution USA

OUTLSUPW

world coastal

OUTLUSAM

medium resolution USA

OUTLHPOL

world political boundaries

OUTLHRES

high resolution world coastal outline

OUTLUSAL

low resolution USA and North America

OUTLWRLD

world coastal

Word allocation for OUTLSUPU, OUTLSUPW, OUTLUSAM, OUTLHPOL and OUTLHRES

Words 1 to 6000 contain the directory for the line segments. Each directory block contains six words of information.

Word

Description

0

number of blocks (line segments)

1

minimum latitude, degrees * 10000

2

maximum latitude, degrees * 10000

3

minimum longitude, degrees * 10000; west is positive

4

maximum longitude, degrees * 10000; west is positive

5

beginning word of data start for segment 1

6

number of words to read

7 - 12

directory for line segment 2

...

...

5995 - 6000

directory for line segment 1000

6001

latitude degrees * 10000

6002

longitude degrees * 10000

6003

latitude degrees * 10000

6004

longitude degrees * 10000

...

...


The maximum number of line segments is 1000. The number of points in a segment is limited to 3000 by the arrays in the MAP program.

Word allocation for OUTLUSAL and OUTLWRLD

Word

Description

0 . . . n-1

n number of latitude/longitude pairs as halfwords; longitude, degrees * 10, 0 to 360 west is positive; latitude, degrees * 20,
0 to 180 north is positive; odd number means pen down; even number means pen up

n + 1

end of file marker; HEX FFFF0000

API functions

Currently, no API library functions exist for reading and writing base map files. There are, however, programs in McIDAS-XRD, MAKEMAP and MAP2TEXT, that convert McIDAS map files to and from a text format.

SATANNOT

Image annotation description file.

The satellite description text information in this binary file is displayed as text annotation when a satellite image is loaded onto a display device.

Each 80-character record contains the following:

  • a satellite name, in columns 1 to 19
  • a band specifier code, if applicable, in column 20
  • a sensor source number, in columns 30 and 31

For image annotation description file Application Program Interfaces (APIs), refer to the API functions list at the end of this section.

File size depends on the number of satellite description entries and is computed by (20*number of entries ) words. For example, two entries may look like this:

Columns 1 to 19

Column 20

Columns 30 and 31

GOES-7 IR

D

33

NOAA-10

K

60

This file is supplied with McIDAS-X.

API functions

Function

Description

m0ssdesc

retrieves the satellite sensor information

SATBAND

Image channel description file.

This file contains 80 character ASCII text records describing the instrument channel information. For each satellite/instrument combination, there is an instrument description block which must conform strictly to the following format:

Format

Description

Sat ss1..ssn

First line of instrument description block,

where ss1..ssn is a list of SSEC assigned satellite sensor numbers

cal type

Instrument calibration type

BRes lres eres

Line and element base resolution (in km)

nnnn wl description

Channel number (nnnn), wavelength (wl), and text description

EndSat

Last line of instrument description block

This file is supplied with McIDAS-X.

There is one instrument description block for each supported satellite.

For satellites that support multiple calibration types, the combination of Cal, BRes, and nnnn lines may be repeated for each calibration type.

API functions

Currently, no API library functions exist for reading and writing this file.

SKEDFILE

Scheduled McIDAS-X commands.

This binary file has 7172 words and is divided into two sections.

  • The first section contains basic directory information for the scheduler entries. The scheduler (SKED) uses this section to quickly scan all entries to decide which are due to run.
  • The second section contains additional directory information and the text of the McIDAS-X command for each entry. This section is read when listings are made or a command is ready to run.

The file division is invisible to all parts of the schedule system accessing the file via the ID number.

For scheduled McIDAS commands Application Program Interfaces (APIs), refer to the API functions list at the end of this section.

Word allocation for the file

Word

Description

0 - 7

unused

8 - 807

first section of scheduler entry information

808 - 871

unused

872 - 7171

second section of scheduler entry information

Word allocation for the first section

This section contains eight words for each entry (maximum of 100).

Word

Description

0

time of the next scheduled run; all times are kept internally, in seconds, since 1 January 1972

1

number of runs remaining

2

interval between runs

3

late tolerance if the scheduler is delayed

4

terminal at which the command runs

5

ID number or name assigned when the command is entered in the schedule

6

initials of the person who entered the command in the schedule

7

project number under which the command runs

Word allocation for the second section

This section contains 64 words for each entry.

Word

Description

0

time that the command first runs

1

total number of times the command runs

2

unused

3 - 63

text of the McIDAS-X command

API functions

Function

Description

skio

schedule file I/O routines

Meteosat PDUS

Meteosat PDUS images are remapped and calibrated at the ground station before the stretched signal is disseminated. This simplifies the navigation and calibration data sections. All data is eight bits; each band is stored in a separate file.

For more information on Meteosat labels and headers, see the EUMETSAT document Meteosat High Resolution Image Dissemination .

Meteosat PDUS directory block

Word

Value

Description

14

1

each band is stored separately

19

0
128
512

for visible image band map
(eighth bit from right) for IR band map
(tenth bit from right) for WV band map

22

.xxxxx

MIEC absolute calibration band value (IR or WV) from the calibration section of the Meteosat header; stored as scaled integer xxxxx

23

xx.x

space count corresponding to the calibration value from the calibration section of the Meteosat header; stored as scaled integer xxx

24

1 or 2

physical sensor number from the Meteosat header

37

line offset of the southeast corner of the area in image coordinates; 16-bit value from the Meteosat header, right justified plus 1

38

element offset of the southeast corner of the area in image coordinates; 16-bit value from the Meteosat header, right justified plus 1

39

satellite center longitude of rectification; 16-bit value from the Meteosat header and right justified

44

0

49

24

length of the data block line prefix documentation, in bytes

50

0

length of the data block line prefix calibration, in bytes

51

0

length of the data block line prefix band list, in bytes

52

MSAT

image source type; 4 bytes ASCII

53

RAW

calibration type; 4 bytes ASCII

54

0
1

data was ingested as sent (full resolution)
data was sampled down (every other pixel); VIS is sent as resolution 1 in some images and resolution 2 in others

55

bitmap indicating types of data in the original image; bits are numbered right to left (least to most significant bit):
bit 0: 1 if VIS is included in transmission; 0 if not
bit 1: 1 if IR is included in transmission; 0 if not
bit 2: 1 if WV is included in transmission; 0 if not
all other bits = 0

Meteosat PDUS data block

The line prefix for the data block contains the information below. For the line data, each value is transmitted as eight bits and is stored west to east and north to south in the area, the opposite of how it is transmitted.

Region

Description

validity code

optional but recommended to flag missing data, which must have zeros as placeholder data or a validity code that does not match the value in word 36 of the directory block

documentation

24 bytes; this is a copy of the label that arrives with each subframe

calibration

0 bytes (not used)

band list

0 bytes (not used) since each band is stored in a separate area

Meteosat PDUS navigation block

A PDUS navigation block is divided into 256 words.

Word

Value

Description

1

MSAT

navigation type

2

Julian day of the navigation, yyddd

3

time of the navigation, hhmmss

4

0

reference position for the telescope

5

0

line number of the telescope reference position

6

1250

center scan line

7

center longitude of rectification (west positive), ddmmss

8 - 9

0

reserved

10

Julian day of the navigation, yyddd

11 - 256

0

reserved

Meteosat PDUS calibration block

No calibration block is needed for PDUS; the calibration information is stored in the directory block.

UC

McIDAS-X User Common.

User Common is a block of data stored in shared memory. Its contents are lost if McIDAS-X stops; otherwise, it retains values that allow for interprocess communication of information usually related to the state of the McIDAS-X session (for example, the number of frames being viewed or the location of the cursor). UC variables with negative subscripts are carried along from the calling process through all spawned processes. UC variables with positive subscripts and UC(0) are available to all tasks that are running whether spawned or not. Words -12 to -1 contain a snapshot of the state taken just before the command begins.

For McIDAS user common Application Program Interfaces (APIs), refer to the API functions list at the end of this section.

Word allocation

Word

Description

-123 to -120

current font information

-82

logon initialization flag; 1 = I option used by PC

-58

ending column number in the current MD wind file

-57

ending row number in the current MD wind file

-56

starting row number in the current MD wind file

-55

current MD wind file used for core output

-54

current MD wind file used for imv, selector and core output

-53

element size of the target cursor

-52

line size of the target cursor

-51

space bar toggle

-50

error status word

-46

current TCOL

-45

current TWIN

-44

second cursor state control word; bits 0-2 are not used;
bits 3-5 are cursor color; bits 6-8 are cursor type

-43

second cursor element position

-42

second cursor line position

-41

second cursor element size

-40

second cursor line size

-38

next record pointer for the file created with DEV=F

-37 to -35

the disk file name for the DEV=F file; on the workstation, the file descriptors for the printer or file dataset for sdest, edest and ddest, respectively

-34

current graphics virtual frame; if less than zero, doesn't plot

-33

current diagnostic message (ddest) device: 0 = suppressed;
1 = terminal screen; 2 = local printer; 3 = system printer

-32

current error message (edest) device: 0 = suppressed;
1 = terminal screen; 2 = local printer; 3 = system printer

-31

device for standard text messages: 0 = suppressed;
1 = terminal screen; 2 = local printer; 3 = system printer

-30

auto context table search: 0 = no keyword substitution;
1 = parameter fetching subroutines; for example, CKWP, resort to system string table for missing keyword parameters

-26

0 = program currently running is not a macro
1 = program currently running is a macro

-25

0 = program currently running is background
1 = program currently running is foreground
-1= program currently running is background with Fortran main; can do Fortran I/O
2 = program currently running is a console started task, such as a tape job

-24

current level when starting another process: 0 = scanner;
1 = next program, etc.

-23

number of this initiator

-22

0 = command was not started by the scheduler
1 = command was started by the scheduler

-21

abort signal handling; see word 455

-16

project number the command runs under; may be different from the logged on project number in UC(1)

-13

cursor state control word:
if bits 0-2 = 0, cursor is frozen (PC command)
if bits 0-2 = 1, cursor is controlled by joystick (P)
if bits 0-2 = 2, size/position are joystick controlled (Z)
bits 3-5 are cursor color (DT); bits 6-8 are cursor type (DT)

-12

cursor element position

-11

cursor line position

-10

cursor element size

-9

cursor line size

-8

graphics state control word:
if bit 0 = 1, graphics are connected to loop control (J)
if bit 1 = 1, graphics frame is looping (L)
if bit 2 = 0, graphics frame is blanked (W)

-7

graphics lower bound

-6

graphics upper bound

-5

current graphics frame

-4

frame state control word:
if bit 0 = 1, frame is connected to loop control (Y)
if bit 1 = 1, frame is looping (L)
if bit 2 = 0, frame is blanked (K)

-3

image frame lower bound

-2

image frame upper bound

-1

current image frame

0

user's terminal number

1

project number under which the current user is logged on;
may be different from UC(-16)

2

user's initials

4

current navigation file number

5

current MD file number

6

current grid file number

11

number of lines on the screen; for terminals where all frames are the same size

12

number of elements on the screen; for terminals where all frames are the same size

13

number of image frames

14

number of graphics frames

15

0 = terminal is local ProNET; 1 = terminal is remote bisync;
2 = terminal is asynchronous

16

0 = terminal is nonvideo; 1 = terminal is video;
2 = terminal is host

17

flag for the E key: 0 = lat/lon are displayed in dddmmss;
1 = lat/lon are displayed in decimal

20

set to 1 by the G key

21

set to 1 by the Q key

22

import pointer

37

image display hardware: 6 = X Windows

38

graphics state flag: 0 = no graphics; 1 = draws graphics

39

virtual graphics state flag: 0 = doesn't write virtual graphics;
nonzero = virtual frame to write

46

default graphics line width

47

graphics dash length, in pixels

48

graphics dash gap length, in pixels

49

graphics dash gap color

50

loop control system; consists of the LS command and the A, B, J, Y, O and L keys; images and graphics are connected to and disconnected from the loop system via UC 54 and 59;
1 = loop control system is looping; 2 = not looping

51

current image frame

52

image frame loop, upper bound

53

image frame loop, lower bound

54

1 = image frames are connected to the loop control
0 = image frames aren't connected

55

1 = image frames are visible
0 = image frames are blanked (Alt K)

56

current graphics frame

57

graphics frame loop, upper bound

58

graphics frame loop, lower bound

59

1 = graphics frames connected to loop control
0 = graphics frames not connected

60

1 = graphics frames are visible
0 = graphics frames are blanked (Alt W)

61

cursor size, vertical

62

cursor size, horizontal

63

cursor position, line number

64

cursor position, element number

65

cursor type: 1 = box; 2 = crosshair; 3 = box and crosshair;
4 = solid box; 5 = star wars

66

cursor color (0 - 7)

67

joystick 1: 0 = disconnected; 1 = controls cursor position;
2 = vernier cursor control; 3 = controls cursor size;
4 = velocity cursor

69

second cursor size, vertical

70

second cursor size, horizontal

71

second cursor position, line number

72

second cursor position, element number

73

second cursor type; see word 65

74

second cursor color; see word 66

75

cursor mode: 0 = single cursor mode; 1 = dual cursor mode

76

saved cursor type; set when word 65 = 0 to turn off the cursor

77 - 79

reserved

87

McBASI list window size

88

McBASI auto-line number line number

89

McBASI run abort flag

98

current MD core output file for motion vectors (WINDCO)

99

nortle toggle

100

current MD selector file for motion vectors (WINDCO)

121

single-letter command; otherwise, zero

122

used by the scheduler (sked); last time through all entries flag

158

vdisk drive letter

160

TCP/IP address of session partner

161

TCP rate measurement word

162

TCP connection status code

163

TCP reserved

164

WINDCO velocity cursor toggle set by Alt V: 0 = off; 1 = on

165

WINDCO sampling flag set by Alt X

166

WINDCO mode is active

167

reserved

168

0 = asynchronous communication is OK
1 = async comm is suspended, port available

169

1 = update loop when new image enters it

170

1 = loop in both directions (1 2 3 4 5 4 3 2 1)

171

reserved

172

routing table modification flag: 0 = modified; 1 = unchanged

173

briefing control signature for channel 1

174

briefing control signature for channel 2

176

1 = system is running without a session manager

177

communication connection state flag: 0 = no carrier;
1 = communications connected; 2 = connection in progress

178

switch to tell mousef to ignore mouse button press

185

mouse button status; two 2-byte integer (I* 2) values that correspond to mouse buttons 1 and 2 respectively

186

mouse movement values (mickies); two 2-byte integer (I * 2) values that correspond to movement up/down and left/right respectively

187

switch to tell mousef to set mickies into UC(186)

188

image nortle toggle

189

1 = commands go to the host

190

outgoing spool-in-use flag

191

mouse PID so EXIT can kill it

192

outgoing message request pointer

193

outgoing message completed pointer

194

1 = system shutdown request

195

last text window displayed; see UC(200)

196

count of text waiting to be displayed

197

import pointer from the decoder

198

communications port name, binary 0 for ProNET

199

last written pointer for import decoder

200

reserved

201

first line in the text window to display; the range is 1 to 57

202 - 203

mouse RAW position

204

reserved

205

reserved

206

reserved

207

nonzero means kbdctl is in insert mode

208

PF key input only; nonzero means that command line text is not allowed and the user cannot change the text window; the program must change the window

209

address of a memory segment used for displaying text on windows 5 through 9; each text window uses 4000 bytes; each character is represented in a 2-byte format where the least significant byte is the character displayed and the most significant byte is the color attribute

210

number of commands that mctext should remember, as specified in the -ih option of the .mcidasrc file

211

1 = echo all GUI commands to the mctext window

212-214

reserved

215 - 305

reserved

315 - 350

briefing port, frame controls and movie flag

400

number of text screens in use

401

reserved

451 - 453

cursor color (red, green, blue); the range is 0 to 255

455

1 = traps abort signals; see UC(-21)

456

ID of the command window

457

ID of the image window

465

offset from the start of UC to the start of redirect memory

467

1 = independent graphics

470

1 = to use fonts

471 - 480

family name of the font

500

number of graphics levels

501

interpolation strategy

502

1 = image window should resize to the size of the current frame (Alt R)

503

zoom factor; used when UC(300) is one

504

mcimage process ID

600

number of gray levels

700

TCPIP module loaded

701

IMPORT module loaded

1000 - 1999

user/site defined

2000

if nonzero, the image window should raise itself and reset the value to zero

2001+

frame object offsets from the start of UC

3001+

terminal types with variable frame sizes; line and element sizes as halfwords

4000

relative pointer for random looping

4001+

list for random looping, where zero is the end

5001+

list of dwell rates

6000

relative pointer for random graphics loops

6001+

list for random graphics loop, where zero is the end

7001+

list of random opposites, where zero is the end

16383 -

end of segment

API functions

Function

Description

luc

reads a word from User Common

puc

writes a word to User Common

mcmoubtn

reports the state of the mouse buttons as soon as a mouse button event occurs

Mcluc

returns a value from User Common

Mcpuc

changes a value in User Common

VASTBLS

VAS calibration tables.

VASTBLS is a binary file that holds the current calibration values of the temperature, brightness and radiance for all 12 channels of GOES AA satellite data. Its fixed size is 1622016 words.

Word allocation for the file

The primary blocks for VASTBLS are shown below. Each block represents a table of calibrated values for each raw value.

Word

Description

0 - 540671

radiance calibration block (watts/meter**2/steradian*1000)

540672 - 1081343

temperature calibration block, in Kelvin

1081344 - 1622015

brightness calibration block, 0 to 255

Word allocation for the primary segment

Each primary segment contains secondary segments (12 maximum) allocated by band number. Word addresses are relative to the start of the primary segment.

Word

Description

0 - 45055

band 1 block

45056 - 90111

band 2 block

90112 - 135167

band 3 block

135168 - 180223

band 4 block

180224 - 225279

band 5 block

225280 - 270335

band 6 block

270336 - 315391

band 7 block

315392 - 360447

band 8 block

360448 - 405503

band 9 block

405504 - 450559

band 10 block

450560 - 495615

band 11 block

495616 - 540671

band 12 block

Word allocation for the secondary segment

Each secondary segment contains base segments allocated by the Delta-F value. This value ranges from -5 to +5, providing 11 base segments per secondary segment. Each of the word addresses below is relative to the start of the secondary segment. The values are the actual numbers used to calibrate the data.

Word

Description

0 - 4095

Delta-F = -5

4096 - 8191

Delta-F = -4

8192 - 12287

Delta-F = -3

12288 - 16383

Delta-F = -2

16384 - 20479

Delta-F = -1

20480 - 24575

Delta-F = 0

24576 - 28671

Delta-F = +1

28672 - 32767

Delta-F = +2

32768 - 36863

Delta-F = +3

36864 - 40959

Delta-F = +4

40960 - 45055

Delta-F = +5

API functions

Currently, no API library functions exist for reading and writing this file.

VIRTnnnn

Virtual graphics files, where nnnn is the virtual graphics number.

These variable-length, binary files contain one or more virtual graphics scenes. A scene contains graphics attribute information, such as page boundary, line width, pen position and color information.

For virtual graphics file Application Program Interfaces (APIs), refer to the API functions list at the end of this section.

Word allocation

Below is a description of one scene in a virtual graphics file.

Word

Description

0

top of the page boundary and virtual graphics version as halfwords

1

bottom of the page boundary and line width as halfwords

2

left edge of the page boundary

3

right edge of the page boundary

4

beginning pen position/color triples where (in an x-y plane): word n = pen y position
word n + 1 = pen x position
word n + 2 = pen color
Decimal 256 marks the end of a scene.

API functions

Fortran Function

Description

vpout

writes to a virtual graphics file

Meteosat PDUS

Meteosat PDUS images are remapped and calibrated at the ground station before the stretched signal is disseminated. This simplifies the navigation and calibration data sections. All data is eight bits; each band is stored in a separate file.

For more information on Meteosat labels and headers, see the EUMETSAT document Meteosat High Resolution Image Dissemination .

Meteosat PDUS directory block

Word

Value

Description

14

1

each band is stored separately

19

0
128
512

for visible image band map
(eighth bit from right) for IR band map
(tenth bit from right) for WV band map

22

.xxxxx

MIEC absolute calibration band value (IR or WV) from the calibration section of the Meteosat header; stored as scaled integer xxxxx

23

xx.x

space count corresponding to the calibration value from the calibration section of the Meteosat header; stored as scaled integer xxx

24

1 or 2

physical sensor number from the Meteosat header

37

line offset of the southeast corner of the area in image coordinates; 16-bit value from the Meteosat header, right justified plus 1

38

element offset of the southeast corner of the area in image coordinates; 16-bit value from the Meteosat header, right justified plus 1

39

satellite center longitude of rectification; 16-bit value from the Meteosat header and right justified

44

0

49

24

length of the data block line prefix documentation, in bytes

50

0

length of the data block line prefix calibration, in bytes

51

0

length of the data block line prefix band list, in bytes

52

MSAT

image source type; 4 bytes ASCII

53

RAW

calibration type; 4 bytes ASCII

54

0
1

data was ingested as sent (full resolution)
data was sampled down (every other pixel); VIS is sent as resolution 1 in some images and resolution 2 in others

55

bitmap indicating types of data in the original image; bits are numbered right to left (least to most significant bit):
bit 0: 1 if VIS is included in transmission; 0 if not
bit 1: 1 if IR is included in transmission; 0 if not
bit 2: 1 if WV is included in transmission; 0 if not
all other bits = 0

Meteosat PDUS data block

The line prefix for the data block contains the information below. For the line data, each value is transmitted as eight bits and is stored west to east and north to south in the area, the opposite of how it is transmitted.

Region

Description

validity code

this is present for the real-time data

documentation

24 bytes; this is a copy of the label that arrives with each subframe

calibration

0 bytes (not used)

band list

0 bytes (not used) since each band is stored in a separate area

Meteosat PDUS navigation block

A PDUS navigation block is divided into 256 words.

Word

Value

Description

1

MSAT

navigation type

2

Julian day of the navigation, yyddd

3

time of the navigation, hhmmss

4

0

reference position for the telescope

5

0

line number of the telescope reference position

6

1250

center scan line

7

center longitude of rectification (west positive), ddmmss

8 - 9

0

reserved

10

Julian day of the navigation, yyddd

11 - 256

0

reserved

Meteosat PDUS calibration block

No calibration block is needed for PDUS; the calibration information is stored in the directory block.

Meteosat Second Generation (MSG) Level 1.5

Meteosat Second Generation (MSG) images are remapped and calibrated at the ground station before the stretched signal is disseminated. This simplifies the navigation and calibration data sections. All data is sixteen bits; each band is stored in a separate file.

For more information on Meteosat labels and headers, see the EUMETSAT document Meteosat High Resolution Image Dissemination .

MSG directory block

Word

Value

Description

3

51

MSG-1

14

11

1

Number of Bands

bands 1-11 are present

band 12 is present

19

Band bit map

Bit Band Wavelength Description
(µ m)
0 1 .635 Daytime cloud detection
1 2 0.81 Surface water and vegetation
2 3 1.64 Ice/water cloud detection
3 4 3.92 Sea surface temperature, hot spot detection
4 5 8.7 Ice/water, cloud detection
5 6 10.8 Cloud detection, surface temperature
6 7 12.0 Sea surface temperature, soil moisture
7 8 6.25 Water vapor
8 9 7.35 Water vapor
9 10 9.66 Ozone absorption
10 11 13.4 CO2 absorption
11 12 0.7 Broad band visible (high resolution)

Bands 1-11 are low resolution images (3 km) with a center latitude/longitude point of (0,0).

Band 12 is a high resolution visible image (1 km) which has a southern and northern data block offset from each other. The center latitude/longitude point is (0,2).

52

MSG

image source type; 4 bytes ASCII

53

RAW

calibration type; 4 bytes ASCII

MSG data block

For the line data, each value is transmitted as sixteen bits and is stored east to west and south to north in the original files.

MSG navigation block

An MSG navigation block is divided into 128 words.

Word

Value

Description

1

MSG

navigation type

2 - 128

0

reserved

MSG calibration block

An MSG calibration block is divided into 128 words.

Word

Value

Description

1

*

central wave number #1 (IR channels 3-11)

2

*

central wave number #2 (IR channels 3-11)

3

*

gain (channels 1-3,12)

4

*

offset (channels 1-3,12)

5-128

0

reserved

* values stored as 4 ASCII F10.6 characters separated by a space character.

GVAR Imager

The GVAR Imager provides two types of data:

The supplemental data is provided in Block 0, which is the GVAR Imager documentation block. Block 0 has its own directory block, validity code, documentation region and data. The GVAR Imager sensor data likewise has its own directory, data, navigation and calibration blocks. Both types of data are described below.

The OGE tables referenced in this section are from Operations Ground Equipment, Internal Specification, DRL 504-02-1 Part 1, Specification No E007020 , released February 9, 1994, Space Systems/Loral, 3825 Fabian Way, Palo Alto, California 94303-4604. That document describes data which is formatted by the ground station and then retransmitted.

The band information for the GVAR Imager is provided in Appendix B, Image Information.

Block 0

The GVAR Imager documentation, Block 0, contains additional control information about an image. Some of this information is also contained in the imager sensor data. For each line of GVAR Imager sensor data transmitted, one line of Block 0 documentation is transmitted and stored in a separate area. Below are the values specific to the Block 0 directory.

Word

Value

Description

12

8

line resolution

13

1

element resolution

14

1

number of bands

19

1

band map

25 - 32

RT IMGR DOC

normal entry; ASCII

49

44

length of the data block line prefix documentation,
in bytes

50

0

length of the data block line prefix calibration,
in bytes

51

0

length of the data block line prefix band list, in bytes

52

GVAR

image source type; 4 bytes ASCII

53

RAW

calibration type; 4 bytes ASCII

The line prefix's validity code for Block 0 is four bytes. Its documentation region is 44 bytes, consisting of the following:

Documentation region

Bytes

OGE table

block header CRC

2

3-5

scan status

4

3-6

year, day and time from Block 0

8

3-6

block header

30

3-5

The rest of the Block 0 line contains 8040 bytes of 8-bit data. See OGE Table 3-6.

Bytes 17-24 contain the time the block was sent from the ground station.

GVAR Imager directory block

The GOES-8 through GOES-12 satellites have two instruments: an imager and a sounder. Areas with SSEC-assigned, even-numbered sensor sources provide imager data, while odd-numbered sensor sources provide sounder data. Word 52 of the directory block contains the image source type (GVAR) for 2-byte GVAR data as it is ingested. Word 53 contains the units that data is stored in; RAW for 2-byte raw GVAR data.

Word 14 of the directory block contains the number of spectral bands present in an image. The filter band map in word 19 of the directory block describes the bands in an area. A bit is set for each band appearing in the area. The number of bands must match the value in word 14. The values specific to the sensor data's directory block are shown below.

Word

Value

Description

11

2

number of bytes per band

19

1 for VIS
2, 4, 8 or 16 for IR

band map; one bit should be set for each band in the area

25 - 32

RT IMGR IR
RT IMGR VIS
RT IMGR

normal entry; ASCII
visible band
multibanded

49

226

length of the data block line prefix documentation if single band, otherwise a higher value; in bytes

50

0

length of the data block line prefix calibration,
in bytes

51

0

length of the data block line prefix band list,
in bytes

52

GVAR

image source type; 4 bytes ASCII

53

RAW

calibration type; 4 bytes ASCII

55

1

GVAR Imager data block

The GVAR Imager produces observational data for a spatial location in five spectral bands: one visible (VIS) and four infrared (IR). An image contains only one of these five bands. Word 19 in the directory block contains a band filter map indicating the area file's band.

The highest resolution for a visible image is one. It is four for an IR image, since longer wavelengths have less resolution. For a GVAR satellite, resolution one means approximately 1 km resolution at the satellite subpoint.

Each element in a GOES-8 image contains one 10-bit pixel representing raw data from the instrument. Each pixel is stored as two bytes in the McIDAS-X area file. The hardware shifts the data so the 10 bits are formatted as shown below. The x's are the data bits; the rest is 0-filled after shifting.

| 0 | x | x | x | x | x | x | x | x | x | x | 0 | 0 | 0 | 0 | 0 |

The sensor data's line prefix contains a 4-byte validity code and a 76-byte documentation region consisting of the following:

Documentation region

Bytes

OGE table

block header CRC (the last three bits only); a bit is set if the block header copy is good; this data is usually 00,07

2

scan status

4

3-6

year, day and time from Block 0

8

block header

30

3-5

line documentation consisting of sixteen pairs of 10-bit fields, right justified; each 10-bit field can be obtained with a LOGICAL AND against 03FF

32

3-7

block zero record, first 150 words

150

3-6

The block header and line documentation blocks are included for every band in the image line.

The rest of the line consists of up to 41920 bytes of data. Since it is 2-byte data, half that many pixels are represented.

Bytes 17-24 contain the time the block was sent from the ground station.

GVAR Imager navigation block

The GVAR Imager navigation block contains 640 words. Unless otherwise noted, words are twos-complement binary integers. This navigation information comes from Block 0 records. Bytes designated R*4 in OGE Tables are in Gould format. They must be scaled and converted to integers or converted to Real on the machine doing the decoding, scaled as designated below, and then converted to integer.

Word

Value

Description

1

GVAR

navigation type; 4 bytes ASCII

2

ASCII string, usually a letter followed by three integers

3

imager scan status; bits 0-15 are right justified, with 15 the least significant; IMC active flag is bit 8, counting from the least significant bit; 1=active; see OGE Table 3-6, bytes 3-6

4

imager scan status; bits 16-31 are right justified, with 31 the least significant; yaw-flip processing enabled flag is bit 16, counting from the least significant bit; 1=enabled; see OGE Table 3-6, bytes 3-6

5

0

reserved

6 - 62
6
7
8
9
10
11
12
13 - 14
15
16
17
18
19 - 31
32 - 42
43 - 51
52 - 60
61
62

see OGE Table 3-6, bytes 295 - 522
reference longitude, rad*10000000
reference distance from nominal, km*10000000
reference latitude, rad*10000000
reference yaw, rad*10000000
reference attitude roll, rad*10000000
reference attitude pitch, rad*10000000
reference attitude yaw, rad*10000000
epoch date/time, BCD format
delta from epoch time, minutes*100
image motion compensation roll, rad*10000000
image motion compensation pitch, rad*10000000
image motion compensation yaw, rad*10000000
longitude delta from reference values, rad*10000000
radial distance delta from reference values, km*10000000
sine of the geocentric latitude delta values, units*10000000
sine of the orbit yaw delta values, units*10000000
daily solar rate, rad/min*10000000
exponential start time from epoch, minutes*100

63 - 117
63
64
65
66
67
68
...
95
96
97
98
99
100
101
102
103-107
108-112
113-117
118-127
128
129





















MORE
GVAR

roll attitude angle (OGE Table 3-6, bytes 523-742)
exponential magnitude, rad*10000000
exponential time constant, minutes*100
mean attitude angle, rad*10000000
number of sinusoids/angles, no units
magnitude of first order sinusoid, rad*10000000
phase angle of first order sinusoid, rad*10000000
...
magnitude of fifteenth sinusoid, rad*10000000
phase angle of fifteenth sinusoid, rad*10000000
number of monomial sinusoid, no units
order of applicable sinusoid, no units
order of first monomial sinusoid, no units
magnitude of monomial sinusoid, rad*10000000
phase angle of monomial sinusoid, rad*10000000
angle from epoch at daily solar rate, rad*10000000
repeat of words 98-102 for second monomial
repeat of words 98-102 for third monomial
repeat of words 98-102 for fourth monomial
reserved
4 bytes ASCII
4 bytes ASCII

130-239
130-184

185-239

240-255
256
257







MORE
GVAR

attitude angles
repeat of Words 63-117 for pitch attitude angle; see OGE
Table 3-6, bytes 743-962
repeat of Words 63-117 for yaw attitude angle; see OGE
Table 3-6, bytes 963-1182
reserved
4 bytes ASCII
4 bytes ASCII

258-367
258-312

313-367

misalignment angles
repeat of Words 63-117 for roll misalignment angle; see
OGE Table 3-6, bytes 1183-1402
repeat of Words 63-117 for pitch misalignment angle; see
OGE Table 3-6, bytes 1403-1622

368

year and Julian day, yyyddd

369

nominal start time of the image; comes from Block 0 when navigation data is taken from Block 0, HHMMSSmmm

370

1

imager/sounder instrument flag; 1=imager, 2=sounder

371-379

reserved

380

instrument nadir, north/south cycles; see OGE Table 3-6, byte 6305

381

instrument nadir, east/west cycles; see OGE Table 3-6,
byte 6306

382

instrument nadir, north/south increments; see OGE Table
3-6, byte 6307-6308

383

instrument nadir, east/west increments; see OGE Table 3-6, byte 6309-6310

384

MORE

4 bytes ASCII

385

GVAR

4 bytes ASCII

386-511

reserved

512

MORE

4 bytes ASCII

513

GVAR

4 bytes ASCII

514-640

reserved

GVAR Imager calibration block

The imager calibration block is made up of 128 words (512 bytes), as shown in the table below. The data is in the Gould format.

Word

Value

Description

1 - 8

visible bias coefficients; one per detector (OGE Table 3-6, bytes 6399-6430)

9 - 16

visible first order gain coefficients; one per detector
(OGE Table 3-6, bytes 6431-6462)

17 - 24

visible second order gain coefficients; one per detector (OGE Table 3-6, bytes 6463-6494)

25

visible radiance to albedo conversion factor (OGE Table
3-6, bytes 6495-6498)

26 - 29

det side 1 IR bias scaling factors; one per IR channel (OGE Table 3-6: bytes 6667-6670 Ch 4, Side 1; bytes 6675-6679 Ch 5, Side 1; bytes 6683-6686 Ch 2, Side 1; bytes 6691-6694 Ch 3, Side 1)

30 - 33

det side 2 IR bias scaling factors; one per IR channel (OGE Table 3-6: bytes 6695-6698 Ch 4, Side 2; bytes 6703-6706 Ch 5, Side 2; bytes 6711-6714 Ch 2, Side 2; bytes 6719-6722 Ch 3, Side 2)

34 -- 37

det side 1 IR gain scaling factors; one per IR channel (OGE Table 3-6: bytes 6723-6726 Ch 4, Side 1; bytes 6731-6734 Ch 5, Side 1; bytes 6739-6742 Ch 2, Side 1; bytes 6747-6750 Ch 3, Side 1)

38 - 41

det side 2 IR gain scaling factors; one per IR channel (OGE Table 3-6: bytes 6751-6753 Ch 4, Side 2; bytes 6759-6762 Ch 5, Side 2;bytes 6767-6770 Ch 2, Side 2; bytes 6775-6778 Ch 3, Side 2)

42 - 128

0

GVAR Block 11

The GVAR Block 11 holding areas contain data for sounder images. This data is not easily accessed. A decoder must reformat the raw Block 11 data and place it in the sounder image, where it is available for analysis and display.

GVAR Block 11 directory block

Word

Value

Description

11

1 or 2

number of bytes per element, depending on the element size of the band; a holding area cannot contain both 1- and 2-byte data

14

1

number of bands in the image

19

block type filter; positions of set bits correspond to the block types requested; the least significant bit is the rightmost bit; the value 787968 translates to 0c0600 hex with bits set in positions 20, 19, 11 and 10

25 - 32

RT BK11 BYT1

normal entry; ASCII

49

40

length of the data block line prefix documentation,
in bytes

50

0

length of the data block line prefix calibration,
in bytes

51

0

length of the data block line prefix band list, in bytes

52

BK11

image source type; 4 bytes ASCII

53

RAW

calibration type; 4 bytes ASCII

GVAR Block 11 data block

GVAR transmits 22 types of Block 11 data. This can be 6-, 8- or 10-bit data. The user can specify any type to be stored in a single holding area. Control fields in the line prefix or the first portion of the data (called the SAD ID) are used by postprocesses, such as the sounder decoder, to determine the block type. Each data block line consists of a single Block 11 sector, or block . All blocks are 8040 bytes. Refer to the OGE, sections 3.3.7 - 3.3.7.14 for a description of the contents of each block type.

The 10-bit data is formatted as follows, with x representing a data bit and the rest being zero-filled after shifting.

| 0 | x | x | x | x | x | x | x | x | x | x | 0 | 0 | 0 | 0 | 0 |

The 8-bit data is formatted as follows:

| x | x | x | x | x | x | x | x |

The 6-bit data is formatted as follows:

| 0 | 0 | x | x | x | x | x | x |

The line prefix for Block 11 contains a 4-byte validity code. Its documentation region is 40 bytes, consisting of the following:

Documentation region

Bytes

OGE table

block header CRC; this field is overwritten in the mainframe by a 2-byte counter and is used to check sequencing of the data flow

2

3-5

year, day and time from Block 0

8

3-6

block header

30

3-5

The rest of the Block 11 line consists of up to 8040 bytes of data, depending on block type.

Bytes 17-24 contain the time the block was sent from the ground station.

GVAR Sounder

GVAR Sounder areas are decoded from Block 11 data. The GVAR Sounder decoder reads the Block 11 holding areas, which contain blocks of type 32 (20 hex), type 35 (23 hex) and others. These blocks are documented in OGE, sections 3.3.7.2 and 3.3.7.3.

Navigation and calibration data is read from type 32 blocks, which are sounder documentation blocks. Sensor data is read from type 35 blocks, which are sounder scan data blocks. After the sensor data is read, it is reformatted and placed in the sounder image area.

The band information for the GVAR Sounder is provided in Appendix B, Image Information.

GVAR Sounder directory block

Word

Value

Description

12

10

line resolution; if lines are sampled or averaged, the resolution is a multiple of 10

13

10

element resolution; if pixels are sampled or averaged, the resolution is in multiples of 10

14

19

number of bands

19

524287

band filter map; translates to 0007ffff hex; a bit is set for each of bands 1 - 19

25 - 32

Priority Completed

normal entry; ASCII

49

36 or
216

length of the data block line prefix documentation, in bytes; if 216, the first 180 words of Sounder Auxillary Data block have been have been added

50

0

length of the data block line prefix calibration,
in bytes

51

up to 24 in multiples of four

length of the data block line prefix band list,
in bytes; see the section below for more information

52

GVAR

image source type; 4 bytes ASCII

53

RAW

calibration type; 4 bytes ASCII

GVAR Sounder data block

The GVAR Sounder produces data for a given spatial location in 18 IR spectral bands and one visible band. The number of bands in the sounder data must match the value in word 14 of the directory block. Word 19 designates the band map. All sounder data fields are 13 bits placed in 2-byte (16-bit) fields. Each data point in a scan data block has 23 bands of data. The data points correspond to a geographic area 11 pixels west-east and 4 pixels north-south. For each image line, the decoder produces 11 sets of 23 interleaved fields of data.

Bands 20-23 of this data are not displayable; they hold the latitude and longitude of the first 19 bands. The latitude and longitudes are 32-bit values. Since the actual sounder data is 16 bits, the latitude and longitude values must be split in half to store them in the area structure.

Band 20 holds the two most significant bytes of the latitude; band 21 holds the two least significant bytes. Band 22 holds the two most significant bytes of the longitude; band 23 holds the two least significant bytes.

If the latitude and longitude values are not requested, the band list section will contain 20 bytes total with 19 bytes used.

These latitude and longitude values are in the Gould floating point format. See OGE, section 3.5.4. For example, if the latitude of a data point is 100.1640625, the hex representation is 42642A00; band 20 holds 4264, and band 21 holds 2A00.

This package does not provide any code for using these latitudes and longitudes; they are included only for reference purposes.

The four sounder detectors are numbered 1, 2, 3, and 4. Each data block line contains information from only one detector. The documentation block contains a field indicating which detector was used for the current line.

The line prefix contains a 4-byte validity code and a documentation region, which is described in the table below. The remainder of the line consists of the interleaved sounder data.

Documentation region

Bytes

OGE table

first nine words of the Sounder Auxiliary Data Block ID

9

3-8

year, day and time of the scan line start

8

3-11

scan status

2

3-11

number of blocks in the scan

2

3-11

O&A location (not used)

2

detector status

10

3-11

number of the detector used for this line

1

padding

2

If the value in word 49 of the area directory is 216, the first 180 words of the Sounder Auxiliary Data block have been inserted here.

180

3-11

GVAR Sounder navigation block

Navigation blocks contain 640 words. Unless otherwise noted, words are twos complement binary integers. Navigation information comes from Block 11 records, type 32. Bytes designated R*4 in the OGE Tables are in Gould format in the holding areas. They must be scaled and then converted to integer, or converted to Real on the machine doing the decoding, scaled as designated below, and then converted to integer.

If the latitude and longitude values are not requested, the band list section will contain 20 bytes total with 19 bytes used.

Because the word allocation information for the sounder navigation block is nearly identical to that for the imager, it is not repeated here. Only the words with a different description are shown below. That difference is usually the OGE table number and/or byte numbers.

Word

Value

Description

3

scan status; bits 0-15 are right justified, bit 15 is the least significant bit; the IMC active flag is bit 8, counting from the least significant bit; 1=active (OGE Table 3-11, bytes 31-32)

4

yaw-flip flag; bits 0-15 are right justified, bit 15 is the least significant bit; the yaw-flip processing enabled flag is bit 16, counting from the least significant bit; 1=enabled (OGE Table 3-10, bytes 57-58)

6 - 62

(OGE Table 3-11, bytes 323 - 550)

63 - 117

roll attitude angle (OGE Table 3-11, bytes 551-770)

130-184

repeat of Words 63-117 for pitch attitude angle (OGE Table
3-11, bytes 771-990)

185-239

repeat of Words 63-117 for yaw attitude angle (OGE Table
3-11, bytes 991-1210)

258-312

repeat of Words 63-117 for roll misalignment angle (OGE Table 3-11, bytes 1211-1430)

313-367

repeat of Words 63-117 for pitch misalignment angle (OGE Table 3-11, bytes 1431-1650)

370

imager/sounder instrument flag; 1=imager, 2=sounder

380

instrument nadir, north/south cycles (OGE Table 3-6, byte 3005)

381

instrument nadir, east/west cycles (OGE Table 3-6, byte 3006)

382

instrument nadir, north/south increments (OGE Table 3-6, bytes 3007-3008)

383

instrument nadir, east/west increments (OGE Table 3-6, bytes 3009-3010)

GVAR Sounder calibration block

Word

Value

Description

1 - 4

visible bias coefficients; one per detector (OGE Table 3-11, bytes 3075-3090)

5 - 8

visible first order gain coefficients; one per detector (OGE Table 3-11, bytes 3091-3106)

9 - 12

visible second order gain coefficients; one per detector (OGE Table 3-11, bytes 3107-3122)

13

visible radiance to albedo conversion factor (OGE Table 3-11, bytes 3123-3126)

14 - 31

IR bias scaling factors; one per IR channel (OGE Table 3-11, bytes 3991-4278); all channels contain the same values for each detector

32 - 49

IR gain scaling factors; one per IR channel (OGE Table 3-11, bytes 4279-4566); all channels contain the same values for each detector

50 - 128

0

GOES VISSR

The image source type VISR is historic in origin, going back to the early GOES satellites. At that time, data was 1-byte for both the visible and IR. Later satellites, such as GOES-6 and -7, were equipped with IR sensors that returned 10-bit values stored as two bytes. For data storage and transfer reasons, commands such as IMGCOPY can convert the 2-byte data to 1-byte. This conversion to 1-byte data preserves the temperature information for the IR channels. It is valid for GVAR, POES, Meteosat and GMS satellite data.

The image source type VISR is from word 52 of the directory block. If the area contains IR data, the temperature may be calculated from the pixel value using the formulas below, where T is the brightness temperature (degrees K) and B is the pixel value (0 to 255). For IR data, the highest pixel values correspond to the coldest temperatures.

T = 418 - B

where B >176 or B =176

T = 330 - (B / 2)

where B <176 or B = 176

The line prefix in a VISR area may be absent or it may contain only the 4-byte validity code.

The band information for GOES VISSR is provided in Appendix B, Image Information.

GOES-7

GOES-7 produced data in two different modes:

  • Mode AA
  • Mode AAA

Most GOES-7 data after 24 March 1987 (Julian day 87083) is AAA. This section documents the mode AAA for the IR and VAS instruments. Word 52 of the area directory contains the source type AAA.

The VAS senses the atmosphere for a given spatial location in up to 12 different IR spectral bands and one visible band. All or some of the IR bands may be included in a single VAS type area. The visible, however, may be contained in a separate area of VISR type. As a result, it may require two areas to contain the total information transmitted by the satellite during a given time period.

GOES-7 AAA directory block

Word

Value

Description

14

number of spectral bands

19

band filter map; a bit is set to one for each band appearing in the area

52

AAA

image source type; 4 bytes ASCII

53

RAW

calibration type; 4 bytes ASCII

GOES-7 AAA data block

The line prefix consists of a 4-byte validity code, 512 bytes of IR common documentation, and 116 bytes of VAS calibration information organized as follows.

Bytes

Description

4

day, yyddd

4

time of the scan, hhmmss

4

scan number (satellite coordinate line number)

104

13 eight-byte groups (1 per possible band) each containing:
channel number - 2-byte binary integer (see the table on the next page)
number of spins - 2-byte binary integer
unused - 4 bytes

The line prefix also contains 4, 8, 12 or 16 bytes of band list information; one byte for each band plus up to three bytes to round to the nearest whole word.

The structure of a VAS area is complicated by two facts:

  • Every line may not contain all the spectral bands indicated in the band map (word 19 in the directory block).
  • The order of the bands may not be the same on every line.

What does appear on a given line is indicated in the band list section, which acts as an index for the line. Only the leftmost n bytes of the band list contain nonzero data, with n being the actual number of bands contained in each element of the line. The I th byte of the band list corresponds to the I th 16-bit pixel in each element of the line. Unused band list bytes are filled with binary zeros; the data in the unused pixel locations may not be zero, but in any case should be ignored.

The channel numbers range from 1 to 38; channel 39 exists but has never been put into service. Each is described in the table below.

Channel

Detector

Size

Location

Spectral band

1

HGCDTE

large

upper

1

2

HGCDTE

large

upper

2

3

HGCDTE

large

upper

3

4

HGCDTE

large

upper

4

5

HGCDTE

large

upper

5

6

INSB

large

upper

6

7

HGCDTE

large

upper

7

8

HGCDTE

large

upper

8

9

HGCDTE

large

upper

9

10

HGCDTE

large

upper

10

11

INSB

large

upper

11

12

INSB

large

upper

12

13

HGCDTE

large

lower

1

14

HGCDTE

large

lower

2

15

HGCDTE

large

lower

3

16

HGCDTE

large

lower

4

17

HGCDTE

large

lower

5

18

INSB

large

lower

6

19

HGCDTE

large

lower

7

20

HGCDTE

large

lower

8

21

HGCDTE

large

lower

9

22

HGCDTE

large

lower

10

23

INSB

large

lower

11

24

INSB

large

lower

12

25

HGCDTE

small

upper

3

26

HGCDTE

small

upper

4

27

HGCDTE

small

upper

5

28

HGCDTE

small

upper

7

29

HGCDTE

small

upper

8

30

HGCDTE

small

upper

9

31

HGCDTE

small

upper

10

32

HGCDTE

small

lower

3

33

HGCDTE

small

lower

4

34

HGCDTE

small

lower

5

35

HGCDTE

small

lower

7

36

HGCDTE

small

lower

8

37

HGCDTE

small

lower

9

38

HGCDTE

small

lower

10

For a given spectral band, only one detector size is used in an area. However, two channels representing different positions of the detector for a particular band may appear in a single area although they may not appear on the same line. For example, channels 8 and 20 may appear in the same area, but not channels 8 and 36.

GOES-7 AAA navigation block

Unless otherwise noted, the words in the GOES-7 navigation block are twos-complement binary integers.

Word

Value

Description

1

GOES

navigation type (ASCII characters)

2

satellite ID, year, and Julian day, ssyyddd

3

nominal start time of the image, hhmmss

4 - 12
4
5
6
7
8
9
10
11
12


1

orbit parameters
orbit type
epoch date (ETIMY), yymmdd
epoch time (ETIMH), hhmmss
semimajor axis (SEMIMA), km * 100
orbital eccentricity (ECCEN) * 1000000 (unitless)
orbital inclination (ORBINC), deg * 1000
mean anomaly (MEANA), deg * 1000
argument of perigee (PERIGEE), deg * 1000
right ascension of ascending node (ASNODE), deg * 1000

13 - 15
13
14
15

attitude parameters
declination of satellite axis (DECLIN), dddmmss (+=north)
right ascension of satellite axis (RASCEN), dddmmss
picture center line number (PICLIN)

16

spin period (SPINP); the satellite period, in microseconds, or the spin rate in revolutions/minute

17 - 20
17
18


19
20

frame geometry
total sweep angle, line direction (DEGLIN), dddmmss
number of scan lines (LINTOT), nnlllll where nn is the
number of sensors and lllll is the number of scans; total
number of lines is nn * lllll
total sweep angle, element direction (DEGELE), dddmmss
number of elements in a scan line (ELETOT)

21 - 30
21
22
23
24
25
26

27
28
29
30












0

camera geometry
forward-leaning (PITCH), dddmmss
sideways-leaning (YAW), dddmmss
rotation (ROLL), dddmmss
reserved
east/west adjustment (IAJUST) in visible elements (+ or -)
time computed by IAJUST from the first valid landmark of the
day (IAJTIM), hhmmss
reserved
angle between VISSR and sun sensor (ISEANG), dddmmss
reserved for later implementation of *SKEW*
reserved

31 - 38
31
32
33
34
35
36
37
38

betas for this area
scan line of the first beta
time of the first beta scan line (beginning), hhmmss
time of the first beta scan line (continued), milliseconds*10
beta count 1
scan line of the second beta
time of the second beta scan line (beginning), hhmmss
time of the second beta scan line (cont.), milliseconds*10
beta count 2

39-128
39

40
41-120
121-128

gammas for this area
gamma, element offset * 100; this is the nominal offset at
time zero of this day
gamma-dot, element drift per hour * 100
reserved
memo; up to 32 ASCII characters of comments

GOES-7 AAA calibration block

The calibration block is composed of the following data.

Word

Value

Description

1

sensor source number

2

date, yyddd

3

time, hhmmss

4 - 9

radiance equation coefficients, array IAB(2,38)

80 - 117

radiance equation coefficients scale factors, IFAB(38)

118-128

0

Transforming the VAS raw IR values into brightness temperatures is accomplished via the intermediate computation of calibrated VAS radiances. The array IAB contains two coefficients for each of the 38 channels; IFAB contains one scale factor for each channel.

If the channel is ICHAN, compute the radiance for the raw value P using:

AB1 = IAB (1,ICHAN)
AB2 = IAB (2,ICHAN)
FAB = 2.**(15-IFAB (ICHAN))
R = (AB2 * P /32. - AB1 ) / FAB

The raw value P is divided by 32 because the data is stored as 15-bit numbers, but the coefficients expect 10-bit numbers.

AVHRR

The AVHRR (Advanced Very High Resolution Radiometer) instrument is a 5-channel scanning radiometer. It generates data in HRPT, LAC and GAC modes.

  • HRPT (High Resolution Picture Transmission) is real-time, 1 km resolution, direct readout data. It is confined to areas where the satellite is in range of a ground receiving station.
  • LAC (Local Area Coverage) is 1 km resolution data recorded onboard the satellite and transferred to the ground station at a later time.
  • GAC (Global Area Coverage) is 4 km resolution data derived from 1 km data. An on-board processor averages four of five data points along every third scan line and stores the data for transmission.

The band information for the AVHRR sensor is provided in Appendix B, Image Information.

AVHRR directory block

Word

Value

Description

14

5

all five bands are normally stored in one file

15

244 or 364

line prefix length in bytes. (TIRO = 244, AVHR = 364)

19

band map for the image, which has valid bits 1 through 6 for the new AVHRR/3 instruments on NOAA-15 (Note that if bit 3 is turned on, bit 6 must be turned on as well, and vice-versa, since both sensors share a single data band identified as either 3 or 6); determining which line belongs to which sensor can be made only from reading the line prefixes, except when an entire area contains only band 3 or only band 6

26

POES signal type (HRPT, LAC, GAC)

36

line prefix validity (VAL) code. (length=4)

47

time in milliseconds

49

192

length of the line prefix documentation

50

40 or 160

line prefix calibration length (40 for TIRO, 160 for AVHR)

51

8

length of the level (LEV) map section in the line prefix

52

TIRO/AVHR

image source type

53

RAW

pixel type stored in the area file

54

0, 1

sampling/averaging indicator (0=average, 1=sample)

55

1, 2, 3

signal type indicator (1=LAC, 2=GAC, 3=HRPT)

56

orbit position (ascending node, decending node, equatorial pass)

AVHRR navigation block

The AVHRR navigation block is divided into 128 words.

Word

Value

Description

1

TIRO

navigation type; 4 bytes ASCII

2

sensor source, year and Julian day of the navigation, ssyyddd

3

time of the navigation, hhmmss

4

1

orbit type

5

epoch date, yymmdd

6

epoch time, hhmmss

7

semi-major axis, km * 100

8

orbital eccentricity, *1000000

9

orbital inclination, degrees * 1000

10

mean anomaly, degrees * 1000

11

0

argument of perigee, degrees * 1000

12

right ascension of the ascending node, degrees * 1000

13

2048

number of samples per line

14

angular increment between samples, degrees * 1000

15

fraction of a second in epoch time

16 - 45

reserved

46

-1
1

satellite is in a descending pass
satellite is in an ascending pass

47

image coordinates of the first line to navigate

48

time at the start of the first line, milliseconds from start-of-day

49

time interval between lines, in milliseconds

50

0
1

image is displayed normally
image is inverted

51

number of lines in the inverted image

52

number of elements in the inverted image

53

time interval between lines, in microseconds (preferred over word 49)

54

time interval between individual data points * 100000000

55-120

reserved

121-128

comments; up to 32 characters

AVHRR Calibration

The calibration block is not used. Instead, calibration is done dynamically on a line-by-line basis to accommodate changing orbital conditions in the AVHRR/3 instrument. Therefore, the calibration data is contained in the data line prefixes. Refer to theTIRO and AVHR line prefix descriptions below, and Appendix D, POES AVHRR Calibration Information for additional information.

Because NOAA-12 and -14 AVHRR use the older TIRO calibration while the NOAA-15 AVHRR uses the newer AVHR calibration, changes have been made in the McIDAS-X area structure between the NOAA-14 areas and the NOAA-15 areas.

AVHRR data block

The AVHRR data block consists of data lines, each consisting of a line prefix and line data. The TIRO and AVHR line prefixes are different.

TIRO line prefix

The TIRO line prefix for the data block contains the information below.

Region

Description

validity code

this is present for the realtime data

documentation

192-byte DOC section from the signal transmission

calibration

40 bytes of zeros; filled during post-processing in McIDAS

level

8 bytes; values 1 through 5 (left to right), with three pad zeros in successive bytes, indicate the order the bands will appear in each pixel in the subsequent data section

The TIRO line prefix is defined as follows:

Byte
Address

Section

Description

0

VAL

Validity code

4

DOC

Words 7-102 of HRPT minor frame (all left shifted 5 bits into a 2-byte sample)

196

CAL

Band 1 Slope/Gain 1 (all slopes and intercepts in the CAL block are scaled by 1000)

200

Band 1 Intercept/Offset 1

204

Band 1 Slope/Gain 2

208

Band 1 Intercept/Offset 2

212

Band 2 Slope/Gain 1

216

Band 2 Intercept/Offset 1

220

Band 2 Slope/Gain 2

224

Band 2 Intercept/Offset 2

228

Band 3 Slope/Gain 1

232

Band 3 Intercept/Offset 1

236

Band 3 Space scan five sample average (rounded and left shifted 5 bits)

240

Band 3 Internal target temperature (scaled by 100)

244

Band 4 Slope/Gain 1

248

Band 4 Intercept/Offset 1

252

Band 4 Space scan five sample average (rounded and left shifted 5 bits)

256

Band 4 Internal target temperature (scaled by 100)

260

Band 5 Slope/Gain 1

264

Band 5 Intercept/Offset 1

268

Band 5 Space scan five sample average (rounded and left shifted 5 bits)

272

Band 5 Internal target temperature (scaled by 100)

276

LEV

Band number: 01

277

Band number: 02

278

Band number: 03 or 06

279

Band number: 04

280

Band number: 05

281

Unused Band numbers: 00 00 00 (three bytes)

AVHR line prefix

The AVHR line prefix for the data block contains the information below.

Region

Description

validity code

this is present for the realtime data

documentation

192-byte DOC section from the signal transmission

calibration

160 bytes from the signal transmission

level

8 bytes; values 1 through 5 (left to right), with three pad zeros in successive bytes, indicate the order the bands will appear in each pixel in the subsequent data section

The AVHR line prefix for the data block is defined as folllows.


Section

Byte
Address

Size
(bytes)


Contents

VAL

0

4

Validity code

DOC

4

192

Words 7-102 of HRPT minor frame (all left shifted 5 bits into a 2-byte sample)

CAL

196

4

Band 1 Slope/Gain 1 (all slopes and intercepts in the CAL section are scaled by 100,000 except for the band 3 slope)

200

4

Band 1 Intercept/Offset 1

204

4

Band 1 Slope/Gain 2

208

4

Band 1 Intercept/Offset 2

212

16

Unused

228

4

Band 2 Slope/Gain 1

232

4

Band 2 Intercept/Offset 1

236

4

Band 2 Slope/Gain 2

240

4

Band 2 Intercept/Offset 2

244

16

Unused

260

4

Band 6 Slope/Gain 1

264

4

Band 6 Intercept/Offset 1

268

4

Band 6 Slope/Gain 2

272

4

Band 6 Intercept/Offset 2

276

16

Unused

...or...

260

4

Band 3 Slope/Gain (scaled by 10,000,000)

264

4

Band 3 Intercept/Offset (scaled by 100,000)

268

8

Unused

276

4

Band 3 Space scan five sample average (rounded and left shifted 5 bits)

280

4

Band 3 Target scan five sample average (rounded and left shifted 5 bits)

284

4

Band 3 Internal target temperature (scaled by 100)

288

4

Unused

292

4

Band 4 Slope/Gain (scaled by 100,000)

296

4

Band 4 Intercept/Offset

300

8

Unused

308

4

Band 4 Space scan five sample average (rounded and left shifted 5 bits)

312

4

Band 4 Target scan five sample average (rounded and left shifted 5 bits)

316

4

Band 4 Internal target temperature (scaled by 100)

320

4

Unused

324

4

Band 5 Slope/Gain (scaled by 100,000)

328

4

Band 5 Intercept/Offset

332

8

Unused

340

4

Band 5 Space scan five sample average (rounded and left shifted 5 bits)

344

4

Band 5 Target scan five sample average (rounded and left shifted 5 bits)

348

4

Band 5 Internal target temperature (scaled by 100)

352

4

Unused

LEV

356

1

Band number: 01

357

1

Band number: 02

358

1

Band number: 03 or 06

359

1

Band number: 04

360

1

Band number: 05

361

3

Unused Band numbers: 00

For a complete description of the AVHRR instruments on the satellites and their calibration, see the NOAA-KLM User's Guide at http://www2.ncdc.noaa.gov/docs/klm or http://www2.ncdc.noaa.gov/docs/intro.htm. For instruments prior to 1988, see NOAA Technical Memorandum NESS 107, 1988 (now obsolete) or http://noaasis.noaa.gov/NOAASIS/ml/calibration.html.

AVHRR line data

AVHRR data is transmitted as 10 bits and stored as 16 bits. The 10-bit data is formatted as follows, with x representing a data bit and the rest being zero-filled after shifting.

| 0 | x | x | x | x | x | x | x | x | x | x | 0 | 0 | 0 | 0 | 0 |

The 16-bit values from each of the five channels covering the same geographic area are stored interleaved in one image. The lines of data are stored in a time-ordered sequence and as the satellite scans right to left.