stream_info

Source: cli/stream/stream_info.pro

 STREAM_INFO
        Return various items of information about a stream via
        keywords.

 Usage:
        stream_info, index, <output keywords>

 Argument:
        index   int     input   The index of the stream, a scalar for
                                RATE datasets, a 2-element array for
                                SPECT or PAD.

 Keywords:
        channel         string  The channel of the stream.
        name            string  The name given to the stream.
        type            string  The type of stream.
        description     string  A description of the stream.
        sectors         int     The number of sectors in the stream
                                data.
        erange          float   The energy range of the stream.
        energy          float   The mid point energy(s) of the stream.
        geometry        float   The geometry factor for the stream.
        sectoring       int     The currently selected sectors.
        hidden          byte    Whether the stream will be displayed
                                or not.

 Notes:
        All the keywords are output keywords that must point to a
        named variable. If a specified key is not applicable to a
        particular stream then a warning is given and a null value
        (empty string or 0) is returned (N.B. sometimes a stream class
        may have a method that returns an empty value in which case
        this is used and no warning will be given). Any number of keys
        may be given in a single call.

 History:
        Original: 23/10/00; SJT
        Add hidden keyword: 10/4/01; SJT