burst - Separates a variable along one dimension

SYNOPSIS

burst  [ parameter=value ... ]  [ inputfile outputfile ]
burst  [ parameter=value ... ]  [ inputfile ... directory ]

Parameters are: include_varsburst_elevburst_dim,   instantiate.

DESCRIPTION

For each variable in an input dataset, burst creates a link variable in the corresponding output dataset, pointing back to the input. And, for each specified variable, burst creates link variables in the output corresponding to each index of a user-specified dimension. These links will point back to the appropriate slices of the burst variable.

For example, if a variable temp has dimensions m x n, and is burst along its second dimension, then the output dataset will contain variables temp_1, temp_2, ..., temp_n in addition to temp.

If the burst dimension has a variable dimvar[1..n] associated with it, then the output variables will be named temp_'dimvar[i]' instead of temp_'i', where i = 1...n.

burst has the opposite effect of laminate. See laminate.

If parameter instantiate=yes, burst eliminates all links back to the input datasets. For each given output dataset, input variable data is actually copied to the output. Then, link variables corresponding to burst variable slices are changed so that they point inside the output dataset.

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_elev

OPTIONAL. If burst_elev = yes, then each variable is burst along its dimension that corresponds to elevation. A dimension corresponds to elevation if it is not an earth surface dimension, and either if its coordinate is Z, or if it corresponds to a variable with units equivalent to distance or pressure. The default is burst_elev = no.

burst_dim

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

This parameter is used only if burst_elev = no.

If burst_dim=0, then burst_elev is reset to yes. If burst_dim<0, then if a given variable has N dimensions, then it is burst along dimension N + burst_dim +1. For
example, if burst_dim=-1, then each variable is burst along its last dimension.

instantiate

OPTIONAL. Indicates whether or not input variable data is actually copied to the corresponding output dataset. If instantiate=yes, output datsets do not contain any links back to the corresponding input datasets. Valid responses are [yes, no]. The default is yes.

EXAMPLES

Separate all variables in the second dimension.

%burst
in/out files   : char(255) ? pass1.dat pass1.bst
include_vars   : char(255) ? [] *
burst_dim      : int       ? [2] 2

SEE ALSO

burst2, instant, laminate, subset, datasets


Last Update: $Date: 1998/08/28 23:00:13 $