gvarin [ parameter=value ... ] [ outputfile ] gvarin [ parameter=value ... ] [ directory ]
Parameters are: on_pass_disk, input_mode, instrument, co_process, post_process, pass_number, tape_device, files_per_pass, block_size, delta_line, delta_sample, full_disk, use_master, master_coverage, inside, master_file, abs_frame, start_spin, num_spins, start_percent, width_percent, lastquit, ring_buffer, frame_number, message, calibrate, byte_output, min_temp, temp_step, vis_step
gvarin creates a TeraScan TDF dataset from raw GOES GVAR telemetry data. The dataset contains two-dimensional imaging or sounding data from visible and infrared sensors.
The raw data can be read from the pass disk, from tape, or from the UNIX file. Raw data on tape must be in TeraScan Archive Format (TAF).
GOES I-M (Geostationary Operational Environmental Satellite) is a weather satellite in an earth-fixed orbit over the equator which retransmits environmental data. It carries a five-channel infrared imager and a nineteen-channel infrared sounder. The telemetry which contains imager and sounder data is called GVAR (GOES I-M Variable) format.
In its normal picture-taking mode, GOES I-M transmits one visible channel with 1.0 km resolution, three thermal infrared channels with 4 km resolution, and one water vapor channel with 8 km resolution.
Are the telemetry frames on disk or tape? Answer yes if the telemetry frames are on disk and no if the frames are on tape or UNIX file.
Valid responses are [yes or no]. The default is no.
The ingest mode. Whether to ingest multiple frames from the same pass (continuous mode) or to ingest the first frame only (single mode).
Valid responses are [single or continuous]. The default is single.
Whether to ingest imager or sounder data.
Valid responses are [imager or sounder]. The default is imager.
OPTIONAL. The shell command to run each time after the output dataset has been defined. The "%s" symbol can be used on the command line to pass the name of the output dataset. This command will be executed on the background.
Valid response is any Born shell command/script call. The default is empty space meaning there is no command to run.
OPTIONAL. The shell command to run each time after the ingest of the dataset has been completeled. The "%s" symbol can be used on the command line to pass the name of the output dataset. This command will be executed on the background.
Valid response is any Born shell command/script call. The default is empty space meaning there is no command to run.
This is the number(s) of the pass(es) on pass disk or on the tape to process. You can list passes on disk with the command lspass.
The range of valid responses for a pass disk depends on the disk configuration. The default is the most recent pass.
If on_pass_disk=no, gvarin prompts for tape_device. This takes the device address of the input tape device. Tape device names are machine specific.
This must be a valid UNIX tape device address.
This is the number of the files per pass on the archive tape. gvarin only prompts for this parameter if the answer to on_pass_on_disk was no (i.e. pass is on tape) and the tape_device is not a UNIX file.
Valid range [>=1]. The default is 2.
This is the number of bytes per physical block.
Valid range [>=512]. The default of 26624 is used by the TeraScan receiving system.
For Imager only. This is the output lines subsampling rates for each of the five image channels.
Valid ranges [1 through 32]. The default is 8 2 1 2 2.
For Imager only. This is the output pixels subsampling rates for each of the five image channels.
Valid ranges [1 through 32]. The default is 8 2 2 2 2. With the default subsampling rates all five channels will have the same resolution.
OPTIONAL. Answer yes if only the full disk image needs to be ingested.
Valid responses are [yes or no]. The default is no.
Answer yes if the data is to be selected from the intersection of a master dataset and a transmitted image.
Valid responses are [yes or no]. The default is yes.
OPTIONAL. Determines the minimal percent of master or the area specified with start_spin, num_spins, start_percent, width_percent that needs to be covered by image.
Valid responses are real numbers [0. through 100.]. The default value 0. means that the coverage percent will not be analyzed.
OPTIONAL. Only if master_coverage > 0. If the selected area covers the entire image but the coverage is less then specified by master_coverage, then the entire image will be ingested in the abs_frame=no mode.
Valid responses are [yes or no]. The default is no.
If use_master=yes, this is the name of the master dataset used to specify a region for data extraction (see master).
Valid responses are any TeraScan dataset that contains an Earth transform. The default is Master.
OPTIONAL. Specifies if a user wants to use the absolute GVAR frame to define the ingest area as opposed to the relative frame, where the scan #1 refers to the beginning of the transmitted image. abs_frame=yes combined with use_master=yes will work as if the transmitted image had full size. The bad values will be assigned to the pixels not present on the input frame. Setting non-zero master_coverage will automaticaly set abs_frame=yes.
Valid values are [yes] or [no]. The default is no.
If use_master=no, this is the spin (i.e. line) number to start saving data. This number is relative to the 8 km resolution channel.
Valid responses are [1..1973]. The default is 1.
If use_master=no, this is the number of spins to retrieve. This number is relative to the 8 km resolution channel and in terms of unsampled spins. Thus if num_spins=500 and delta_line="2 ...." then the actual number of visible lines will be 500*8/2 = 2000.
Valid responses are [1..1973]. The default is 1973.
If use_master=no, this is the percentage of the image to skip in the scan direction (i.e left to right) before saving data. Thus if start_percent=50, the retrieved image will begin halfway into the scan lines, i.e. at middle of the transmitted image, and consist of data to the right (east) of this starting point.
Valid responses are [0..100]. The default is 0.
If use_master=no, this is the percentage of the image width to be saved. Thus if start_percent=25 and width_percent=50, the middle 50 percent of the image will be saved.
Valid responses are [0..100]. The default is 0.
OPTIONAL. Whether to quit ingesting after the required number of spins was reached.
Valid responses are [yes and no]. The default is yes.
Asks whether to print messages from block #11 to the standard output.
Valid responses are [yes and no]. The default is yes.
Asks whether to calibrate the data. For channel 1 the units are always percent albedo. If calibrate=yes, the units for channels 2,3,4,5 will be brightness temperature, otherwise radiance.
Valid responses are [yes and no]. The default is yes.
Only if calibrate=yes. Answer yes if the output dataset is to be saved as 8-bit integer data.
Valid responses are [yes and no]. The default is no.
Only if byte_output=yes. The minimal output temperature in degrees Kelvin.
Valid responses are [100. ... 300.]. The default is 188..
If calibrate=yes and byte_output=yes, this parameter is used to convert temperature to 8-bit value as follows:
8-bit value = nearest int( (temperature - min_temp) / temp_step )
Valid responses are [.01 ... 1.]. The default is .5.
If calibrate=yes and byte_output=yes, this parameter is used to convert percent albedo to 8-bit value as follows:
8-bit value = nearest int( percent_albedo / vis_step )
Valid responses are [.01 ... 1.]. The default is .4.
OPTIONAL, instrument=sounder only. Whether the input raw sounder data is stored on a disk file in the ring-buffer format.
Valid responses are [yes and no]. The default is no.
OPTIONAL, ring_buffer=yes only. The sounder frame number to be ingested from the ring-buffer disk file.
Valid response is any integer number [0 through 255]. However, only the limited number of the latest frames is stored in the input file. The numbers of available frames can be diplayed with the gvslist command. The value frame_number=-1 can be used to specify the latest complete frame stored in the input data file.
[1] gvarin co_process="coproc.sh %s" post_proc="postproc.sh %s" output file(s) : char(255) ? [.] input_mode : char( 10) ? [single] continuous on_pass_disk : char( 3) ? [yes] n tape_device : char(255) ? [/dev/nrht0] gvar.raw block_size : int ? [26624] delta_line : int ( 5) ? [8 2 1 2 2] 2 2 2 2 2 delta_sample : int ( 5) ? [8 2 2 2 2] 2 2 2 2 2 use_master : char( 3) ? [yes] n start_spin : int ? [1] num_spins : int ? [1973] 500 start_percent : real ? [0] 25 width_percent : real ? [75] 50 calibrate : char( 3) ? [yes] no var gvar_ch1[2000 4214], (scale 0.010) albedo*100% var gvar_ch2[500 1054], (scale 0.001) ir_radiation var gvar_ch3[250 1054], (scale 0.010) ir_radiation var gvar_ch4[500 1054], (scale 0.010) ir_radiation var gvar_ch5[500 1054], (scale 0.010) ir_radiation
refdata/coast/wdb2.cil 1 KM resolution coast/islands/lakes refdata/coast/wdb2.riv 1 KM resolution rivers refdata/coast/wdb2.bdy 1 KM international boundaries refdata/coast/wdb2.states 1 KM internal boundaries refdata/coast/wdb2.thin 10 KM reduced resolution wdb2.cil
Non-zero master_coverage parameter can be combined with start_spin, num_spins, start_percent, width_percent to ingest the area specified in the absolute frame system. This approach can be more convenient than using the master, but it requires the knowledge of these four parameters. Start and stop lines and pixels for each product are stored as a part of GVAR telemetry. They are extracted and reported by gvarin in the message like
frame #45: [10037 12496] x [8173 22020], start spin 1256
which indicates that
start line = 10037 stop line = 12496 start pixel = 8137 stop pixel = 22020
Therefore,
start_spin = [10037/8]+1 = 1255 num_spins = [(12496-10037+1)/8]+1 = 308 start_percent = 8137*100/30680 = 26.5 width_percent = (22020-8137+1)*100/30680 = 45.2
where 30680 is the number of pixels in a full visible line. We also used the fact that one scan is composed of 8 visible lines. The values computed above can be generated for each of the currently existing products.
The table below contains the information that may have changed by now.
GOES-8 Imager Scan Sectors. Sub-Satellite Longitude: 75 W +-------------------------+----------------+----------------+ | | Start | Stop | | Product Name +-------+--------+-------+--------+ | | Lines | Pixels | Lines | Pixels | +-------------------------+-------+--------+-------+--------+ | Full Disk | 2472 | 5853 | 13320 | 24829 | | Full Disk - Abbreviated | 2472 | 5853 | 12480 | 24829 | | Full Disk * | 2472 | 5853 | 10312 | 24829 | | N. Hemisphere | 2696 | 8174 | 7680 | 22022 | | N. Hemisphere-Extended | 2696 | 8174 | 10000 | 22022 | | S. Hemisphere-South | 9928 | 8174 | 12424 | 22022 | | Continental US (CONUS) | 2864 | 9252 | 6392 | 17752 | | S. Hemisphere - Small | 7896 | 8500 | 9528 | 14112 | +-------------------------+-------+--------+-------+--------+ Note: frames with * are abbreviated frames used during the 6- hour post-maneuver period of INR recovery.
xcapcon, fastreg, gvslist, GOES-NEXT satellite documentation
Last Update: $Date: 1999/05/10 20:14:11 $