dataset_info

Source: cli/datasets/dataset_info.pro

 dataset_info
        Return via keywords information about the current dataset.

 Usage:
        dataset_info, <keys>

 Keywords:
        name            string  Return the name of the dataset.
        type            string  Return the dataset type.
        description     string  Return a brief description of the dataset.
        unit            string  Return the energy unit ('keV' or 'MeV').
        is_acquired     byte    Return whether the raw data for the dataset
                                have been read
        is_ready        byte    Return whether the current dataset is ready to
                                plot. 
        is_defined      byte    Return whether the current dataset has
                                all the necessary settings made to
                                allow it to be displayed.
        is_drawn        byte    Return whether the plot displayed on
                                the screen, the current dataset and
                                the internal plot settings all match
                                up.
        jd_start        double  Return the start time (as julian day)
        jd_end          double  Return the end time (as julian day)
        doy_start       float   Return the start time as a DOY array
        doy_end         float   Return the end time as a DOY array
        streams         int     Return the number of streams attached
                                to the current dataset.
        average         float   Return the averaging intervals (this
                                is a 2-element array with averaging
                                time and spacing in seconds).
        error           byte    Return whether error bars are
                                requested for the current dataset.
        archive         struct  Return the LAN archive specifications
                                structure. A 2-element array with the
                                first containing the HISCALE
                                specification and the second the EPAM.
        background      byte    Return whether backgrounds are being
                                subtracted from the current dataset.
        flux            byte    Return whether the dataset is to be
                                displayed as count rates or fluxes.
        n_sectors       int     Return the number of sectors present
                                in the current dataset.
        sectors         int     Return the list of sectors present in
                                the current dataset.
        n_panel         int     Return the number of panels in a
                                hierarchical dataset.
        panel_count     int     Return the number of streams in each
                                panel of a hierarchical dataset.
        valid_streams   string  Return a list of the valid stream
                                types for the current dataset
        spacing         int     Return the spacing setting for a PAD
                                dataset.

 Notes:
        All the keywords output keys which should point to a named
        variable if they are to be recognized. If a keyword is
        specified that is inapplicable to the current dataset, a
        warning is generated and a suitable "Null" value is returned.

 History:
        Original: 6-7/11/00; SJT
        Added spacing: 28/9/01; SJT
        Removed is_locked: 29/4/02; SJT