const2d - Creates a two-dimensional dataset with constant value

SYNOPSIS

const2d  [ parameter=value ... ]  [ outputfile ]

Parameters are: master_filenum_lines,   num_samplesvar_type,   var_value.

DESCRIPTION

const2d makes a single variable, 2-dimensional dataset with a constant value. The size of the dataset is based on the size of a specified master dataset or by specifying the size of the dimensions line and sample.

This function often is used to create a solid background image for graphics overlays. If this is the case, a byte-valued dataset no larger than the size of the display should be created. This size is machine dependent. Consult the manufactures display specifications for the appropriate size.

The name of the output dataset variable is x.

There are no input TeraScan datasets. There is exactly one output TeraScan dataset.

PARAMETERS

master_file

This is the name of the master dataset used to define the region of interest.

A valid response is any TeraScan dataset that contains an earth transform. The default is no master.

num_lines

If master_file='' (i.e. none), it is necessary to specify the number of lines in the dataset.

Valid responses are [>0]. There is no default.

num_samples

If a master dataset is not specified it is necessary to specify the number of samples in the output dataset.

Valid responses are [>0]. There is no default.

var_type

This is the data type of the output variable. The data can be either byte (unsigned 8-bit), short (16-bit signed integer), long (32-bit signed integer), float (32-bit real) or double (64-bit real).

Valid responses are [byte, short, long, real, or double]

var_value

This is the value of the output dataset variable.

Valid responses are the numeric range of var_type. The default is [0].

EXAMPLES

Create a two-dimensional dataset.

% const2d
output file    : char(255) ? contest.dat
master_file    : char( 15) ? []
num_lines      : int       ? 500
num_samples    : int       ? 500
var_type       : char(  6) ? byte
var_value      : real      ? [0]

SEE ALSO

testim, fakedata, master, metafiles


Last Update: $Date: 1998/05/28 18:20:21 $