uds_idf_info

Source: cli/idf/uds_idf_info.pro

 uds_idf_info
        Obtain information about the UDS channels available.

 Usage:
        uds_idf_info, [instrument, channel], <output keys>

 Arguments:
        instrument      string  input   The instrument for which the
                                        information is needed
        channel         string  input   The channel for which the
                                        information is needed

 Keywords:
        instrument_list string  output  A named variable to contain a
                                        list of the defined
                                        instruments.  
        channel_list    string  output  A named variable to contain a
                                        list of the channels for the
                                        specified instrument. [Needs
                                        an instrument specification].
        cadence         float   output  A named variable to contain
                                        the nominal data cadence of
                                        the instrument. [Needs
                                        an instrument specification].
        sectors         int     output  A named variable to contain
                                        the number of sectors of the
                                        channel (or of all the
                                        channels of the instrument).
        unit            string  output  A named variable to contain
                                        the unit of the channel.
        energy          float   output  A named variable to contain
                                        the mid-point energy of the
                                        channel (0 is returned for
                                        non-particle channels).
        erange          float   output  A named variable to contain
                                        the energy range of the
                                        channel (0's are returned for
                                        non-particle channels)
        description     string  output  A named variable to contain
                                        a description of the channel.
        full_description string output  A named variable to contain
                                        a longer description of th
        log_plot        byte    output  A named variable to contain
                                        whether it is possible to plot
                                        the channel on a logarithmic
                                        axis. (i.e. is it positive
                                        definite or not).

 Notes:
        For the channel properties, if no channel is given then all
        channels for the instrument are returned.
        All outputs execept the instrument list require an instrument
        to be specified.

 History:
        Original: 2/2/01; SJT



James Tappin 2005-02-04