TSTool / Command / Free
Free command frees (removes) the selected time series from memory.
The time series will therefore not be available for use after that line in the command file.
This command is useful for discarding temporary time series needed for data manipulation
(e.g., so that they are not written in output and are not available for interactive plots).
Freed time series are also removed from any ensembles that reference the time series.
Rather than freeing time series, it may be more appropriate to use the
which can be used in conjunction with some commands to select time series and then operate on the selected time series.
This approach allows selective use of time series and minimizes the need for
Many commands also use a
TSList parameter to indicate which time series should be operated on by a command.
Free command is useful if a block of commands is used with
For because many time series may be created.
The following dialog is used to edit the command and illustrates the command syntax.
Free Command Editor (see also the full-size image)
The command syntax is as follows:
||Indicates the list of time series to be processed, one of:
||The time series identifier or alias for the time series to be processed, using the
||The ensemble to be modified, if processing an ensemble. Can be specified using
||A list of time series positions (1+) in output, separated by commas. Ranges can be specified as
||If a time series is not found to free, indicate the action to take:
||Indicate whether to free the ensemble from which time series were removed, if the ensemble is empty (has no time series remaining after the
See the automated tests.