[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

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


rmsflux Source code in rmsflux.pro

rmsflux

Name
          rmsflux
Purpose
          To test the rms-flux correlation (according to Uttley, Ph. and
          McHardy, I.M., MNRAS 2001, 323, L26-L30), rmsflux.pro
          calculates the mean PSD and its error of a number of given
          equally spaced lightcurve segments, that all contain a
          mean flux within a given range (flux bins). The Miyamoto
          normalization is used and the PSD is Poisson noise and
          deadtime corrected.
FEATURES:
          rmsflux.pro can conveniently be called by cygx1_rmsflux.pro in
          the case of Cyg X-1 (IAAT).
Category
          timing tools
Calling Sequence

Input Parameters
          time         : one, usually the first, of the equally
                         segmented time arrays of the lightcurve
                         (needed to calculate the Fourier frequencies)
          rate         : array, containing the rates of the chosen
                         lightcurve segments, e.g.array(nseg,dseg)
Optional Input Parameters

Keyword Parameters
          nseg         : number of lightcurve segments, out of which
                         the mean PSD is to be calculated
          dseg         : the number of time elements contained in a lightcurve
                         segment. The time length of a lightcurve
                         segment with time resolution bt (e.g. bt=2^(-8)
                         s) is then calculated by: dseg * bt,
                         cf. keyword length
          avgback      : in the case of dim sources (NOT Cyg X-1!) it
                         is recommended to use an average background.
                         default: no background
          newfreq      : array with the lower and upper limits of the
                         chosen frequency range. Can contain only one
                         frequency range or a whole bunch number of
                         adjoining ranges, e.g. for
                         [0.1,10.,32.,100.] the rms is calculated for
                         three ranges.
          length       : length of lc segment; length = dseg * bt
          meanflux     : the average rate of the nseg lightcurve
                         segments
          chatty       : controls screen output ;
                         default: no output;
Output Parameters
          rms          : in the Miyamoto normalization, the
                         integrated PSD, i.e., the area under the PSD
                         estimated by the periodogramm in a given
                         frequency range, defines the square of the
                         total rms variability, i.e. the fractional
                         amount by which the lightcurve is
                         sinusoidally modulated in the given
                         frequency range. The given rms is the square
                         root of the integrated PSD, mutiplied by the
                         mean flux of the corresponding lightcurve segments.
          errms        : error of rms, according to propagation of
                         error. The error of the periodogramm is
                         given by errnormpsd.
Optional Output

Common Blocks

Side Effects

Restrictions

Procedures Used
          fourierfreq.pro
          fastftrans.pro
          freqrebin.pro
          psdnorm.pro
          psdcorr_poisson.pro
Example

Revision History
 $Log: rmsflux.pro,v $
 Revision 1.3  2005/09/24 16:17:06  wilms
 white space cleanup
 Revision 1.2  2005/09/24 15:46:49  wilms
 added automatic computation of length
          CVS Version 1.0, 2001/02/21  TG,JW (IAAT)

Last modified by pro2html on 2005 September 25 at 03:10 UTC

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

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