add_stream

Source: cli/datasets/add_stream.pro

 add_stream
        Add a stream to the current dataset
 
 Usage:
        add_stream, type[ ,channel[ ,panel]]

 Arguments:
        type    string  input   The stream type to add.
        channel string  input   The name of the channel to add. Not
                                used for MATRIX datasets. This can be
                                an array of channels for a rate dataset.
        panel   int     input   The panel number to which to add the
                                stream. SPECT and PAD datasets only.

 Keywords:
        name    string  A name for the stream.
        new_panel       For PAD and SPECT datasets, add the stream in
                        a new panel.
        replace         For MATRIX datasets, do not give a warning if
                        there is already a stream attached.
        system  int/str For *_MAG streams in RATE datasets, which
                        coordinate system to use.
        instrument str  For UDS streams in RATE datasets, which
                        instrument the stream is from.
        safe            For *_MFSA streams in SPECT datasets, only use
                        those energy bands that are considered
                        reliable.
        limits  int     For *_MFSA streams in SPECT datasets, use the
                        specified range of energy bands
        species string  For *_MFSA streams in RATE and SPECT datasets,
                        select the species to use for the energy bounds.
        file    string  For PAD datasets, a channel list can be saved
                        to a file, setting this to the file  and not
                        passing any arguments allows you to read the
                        channel list from such a file.

 Notes:
        Because of the differences between different datasets and
        stream types, this routine doesn't do much by way of validity
        checking, it mostly has to be done by the dataset add_stream
        methods and the stream constructors.

        I hope I haven't missed any keys.

 Datasets:
        RATE, SPECT, PAD, MATRIX, DYN_SPECT

 History:
        Original: 24/8/00; SJT
        Add dyn_spect: 16/8/01; SJT
        Add PAD channel files: 12/6/02; SJT