uds_instrument::get_channel_info

Source: idf/uds_idf/uds_instrument/uds_instrument__get_channel_info.pro

 uds_instrument::get_channel_info
        Return channel information for UDS data.

 Usage:
        info = instref -> get_channel_info(index, <keys>)

 Argument:
        index   int     The number of the channel to check.

 Keywords:
        channel string  The name of the channel to check. (cannot be
                        specified at the same time as index).
        names           Return the name of the channel (specifying
                        names and channel is silly but legal).
        description     Return a description of the channel.
        sectors         Return the number of sectors.
        unit            Return the unit for the channel.
        energy          Return the "Central" energy of the channel
        erange          Return the energy bounds of the channel
        full            When combined with the description key return
                        a "full" description.
        log_plot        Return whether the channel can be plotted on a
                        log scale.

 Notes:
        If neither index not channel is given, then the list for all
        channels is returned.

 History:
        Original: 23/6/00; SJT
        Add energy keys: 3/7/00; SJT
        Add log_plot key: 6/7/00; SJT