[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

Sand 1, D-72076 Tübingen, Germany
[Uni logo]


qpo_lc Source code in qpo_lc.pro

qpo_lc

Name
         qpo_lc
Purpose
         Simulate lightcurves for computation of period significance
Category
         time series analysis
Calling Sequence

Input Parameters
          obj_time: times when the data in the original light curve
                    were measured
          nsimul: number of simulations
Optional Input Parameters
          bt      : bintime of the lightcurve in seconds, if not
                    given, obj_time[1]-obj_time[0] is used
          model: set to the name of a function which returns the desired
                    PSD shape. The function must obey the calling conventions
                    of mpfitfun, the parameter values of the function are
                    set by the keyword params (see description of IDL
                    routine timmerlc, see also const, rednoise,
                    whitenoise, and poisson keywords)
          sigma:    stddev of the lc
          mean:     mean of the lc
          seed: initialization information for the random number generator
Keyword Parameters
    const: if set, simulate constant lightcurve with countrate given
           by the mean count rate (value of the keyword mean)
    rednoise: if set, simulate f^(-beta) noise. Required keywords
           are: beta: slope, mean: mean countrate, sigma: variance
    whitenoise: if set, simulate white noise. Required keywords
           are: mean and sigma
    poisson: if set, instrumental noise is added to the simulated
           lightcurve using the deadtime_simul procedure
           (deadtime_simul is called with the extra keyword, i.e., it
           is also possible to simulate deadtime this way)
    model : if model is given, then the PSD of the simulated
           lightcurves is computed from an arbitrary shape, which is
           defined by the function given in this string parameter (see
           documentation for timmerlc);  the parameters defining the
           shape of the PSD are taken from the keyword params
    chatty: if set, be chatty
     write: if set: write lightcurves instead of returning them in
            time and rate.
            Enables the following keywords:
              path: directory where the data is to be written to
              files: string-array containing the file names of the
                     files generated in this simulation.
      nogap: if set, simulate lightcurve for duration of whole obj_time,
            but ignore gaps in input lightcurve
      factor: due to the way the lightcurves are generated, they are
            affected by red noise leakage if the duration of the
            simulated lightcurves is only as long as the duration of
            the observation. factor allows to increase the time span
            for which the lightcurves are generated by a factor of
            2^factor. Default: 3
Output Parameters
      The following two outputs are only present if the write-keyword
      has not been set:
         time: arrays containing the simulation times (these can be
               different from obj_time due to roundoff OR if the
               sampling of obj_time is not uniform).
         rate: 2D array containing the simulated lightcurves.
Optional Output

Side Effects
       If the write-keyword is set, then the lightcurves are written
       to files.
Restrictions
       many. and the documentation should be much better than it
       currently is.
Procedure
       to be written
Example
       to be written
Revision History
        Version 1.0, 2002/01/10, Sara Benlloch, IAAT
        Many modifications since then and 2002 September
 DO NOT EDIT THE FOLLOWING LINES. THEY ARE AUTOMATICALLY GENERATED
 $Log: qpo_lc.pro,v $
 Revision 1.1  2002/09/12 09:58:22  wilms
 initial release into aitlib

Last modified by pro2html on 2005 January 04 at 16:48 UTC

[Home Page] [Software, Documentation] [IDL Documentation] [Quick Reference] [Feedback]

Jörn Wilms (wilms@astro.uni-tuebingen.de)
Updated automatically