rate_dataset__define

Source: dataset/rate/rate_dataset__define.pro

 RATE_DATASET
        The dataset specification of a dataset to be displayed by
        PLOT_RATES. 

 Superclasses:
        generic_dataset
        dshelper_average
        dshelper_sector
        dshelper_flux
        dshelper_error
       dshelper_background
       dshelper_lan_archive

 Members:
        ephem_flag      byte    Can the data be plotted against
                                ephemeris quantities.
        h_level         int     Level of tolerance of unit mismatch.
        derived_generated       byte    Have any derived streams been
                                        generated? 
        scaling.Option                  int        Auto/manual scaling
                                                   selection
        scaling.axis                    int        Time/ephem axis selection.
        scaling.Rlow                    float      Min rate
        scaling.Rhigh                   float      Max rate
        scaling.Tlow                    double     Min time
        scaling.Thigh                   double     Max time
        scaling.Llow                    float      Min latitude
        scaling.Lhigh                   float      Max latitude
        scaling.dlow                    float      min distance
        scaling.dhigh                   float      max distance
        scaling.xoffset                 double     Offset between
                                                   notional and actual
                                                   time axis values.
        scaling.logarithmic             byte       Is plot logarithmic
        scaling.fit_exact               byte       Is the time axis
                                                   forced to be exact.
        scaling.rev_neg_lat             byte       Should negative
                                                   latitudes be folded
                                                   onto positive.
        scaling.use_date                byte       Use date rather than
                                                   day or year.
        scaling.dist_logarithmic        byte       Are distance axes
                                                   logarithmic.
        plot_layout.layout              int        How many panels in x
                                                   & y directions.
        plot_layout.offsets             pointer    POinter to an array
                                                   of offsets (or an
                                                   offset factor) for
                                                   each trace.
        plot_layout.n_traces            int        How many traces on
                                                   each panel.
        plot_layout.n_panel             int        How many panels
        plot_layout.in_columns          byte       Ordering of panels.
        plot_layout.use_colour          byte       Use colours to
                                                   differentiate traces.
        plot_layout.use_linestyle       byte       Use linestyles to
                                                   differentiate traces.
        plot_layout.by_sector           byte       DOes each panel
                                                   contain all the
                                                   sectors of one
                                                   stream or one sector
                                                   of all streams.
        plot_layout.add_headers         byte       Add headers to plot?
        plot_layout.lock_columns        byte       Don't change the
                                                   nuber of columns of
                                                   the number of streams
                                                   changes.
        plot_layout.flag                byte       Has the layout been
                                                   checked to ensure
                                                   that it will work
                                                   for the current
                                                   stream list.

 History:
        Original: 16/11/99; SJT
        Add flux & error superclasses: 13/12/99; SJT
        Add layout stuff: 20/1/00; SJT
        Add ephemeris to scaling options: 21/1/00; SJT
        Add handle for offsets: 27/3/00; SJT
        Add xoffset to scaling: 5/6/00; SJT
        Add member documentation: 1/8/01; SJT
        Add dervied_generated flag: 11/4/02; SJT



James Tappin 2005-02-04