burst2 - Separates a variable along one dimension

SYNOPSIS

burst2  [ parameter=value ... ]  [ inputfile directory ]

Parameters are:  include_varsburst_dimtokenlink_allinstantiate.

DESCRIPTION

For each specified variable in an input dataset, burst2 separates the variable along the dimension, burst_dim, and writes each of the "slices" into a separate dataset in the output directory. Optionally, burst2 will copy all the "non-burst" variables into each of the output datasets as well. The output variables can be specified to be link variables or instantiated variables (see datasets). The links will point back to the "whole" variables or appropriate slices of the burst variables. Un-instantiated variables can be instantiated using instant.

burst2 has the opposite effect of laminate.

PARAMETERS

include_vars

List of variables to burst. If the list is preceded by a minus sign, then all variables except those listed will be burst. Wildcards * and ? are allowed. The default is to burst all input variables.

burst_dim

The number of the dimension along which to burst. 1 indicates the first dimension, etc.

The default is 1.

token

Token specifies the insertion point of the dimension index in the output filename. For example, if the input dataset is named mydata.tdf, and token is specified as ".", then the output datasets will have filenames in the form mydata_#.tdf, where "#" is the burst dimension index of the slice being written.

The default is to append the dimension index at the end of the filename (see EXAMPLES).

link_all

If link_all=yes, then all the variables in the input dataset not specifed in include_vars will also be "copied" to each output dataset as link variables. Optionally, these link variables can be instantiated (see instantiate next).

Valid responses are [yes or no]. The default is no.

instantiate

Indicates that the variable data is to be copied to the output datasets rather than linked.

Valid responses are [yes and no]. The default is no.

EXAMPLES

Suppose we have a dataset temp with dimensions M, N and P, variables x with dimensions MxN, and variable y with dimensions MxP. If x is burst along dimension 2 (i.e. N) into output directory split, then there will be N output datasets created. The datasets will be named split/temp_1, split/temp_2, ..., split/temp_N. If link_all is specified to be yes, then each dataset will have a "slice" of variable x with single dimension M, and variable y with dimensions MxP.

% burst2
in/out files   : char(255) ? temp split
include_vars   : char(255) ? [] x
burst_dim      : int       ? [1] 2
token          : char(1024) ? []
link_all       : char(  3) ? [no] yes
instantiate    : char(  3) ? [no]

SEE ALSO

instant, laminate, subset, datasets, burst, composite.


Last Update: $Date: 1998/05/28 19:45:31 $