spect_dataset::form_ratio

Source: dataset/spect/spect_dataset__form_ratio.pro

  spect_dataset::form_ratio
        Forms a ratio between two previously plotted streams, and adds
        them as a new stream to the dataset.

 Usage:
        dsref -> form_ratio,index1,index2

 Arguments:
        index1  int     input   The index of the numerator stream in the ratio
        index2  int     input   The index of the denominator stream in
                                the ratio

 Keywords:
        ratio           If set, then form the ratio of the 2 streams (default
                        action).
        difference      If set, then form the difference between the streams.
        product         If set, then form the product of the 2 streams.
        sum             If set, then form the sum of the 2 streams
        inverse         If set, then form the inverse of the first
                        stream (the second stream is ignored).
        power           If set, then raise stream to a power
        operation string The symbolic operation to perform.
        scalar  any     input   If this keyword is present, then the
                                second stream is ignored and the
                                supplied scalar value is used, on the
                                right of the operand.
        panel   int     input   Set the panel on which to place the
                                stream (-1 for a new panel)

 Notes:
        Only one operand keyword may be given. If the inverse or the
        scalar keys are given, then the second argument is ignored (if
        both are given the scalar is ignored as well).

 History:
        Original version,(after rates): 2/5/02; SJT



James Tappin 2005-02-04