$Id: correlate.html,v 1.1 1997/01/20 13:42:27 jaaps Exp jaaps $


correlate: reconstruct celestial image form detecor image


correlate - reconstruct a celestial-image from a detector-image by balanced correlation only.


The program can be started with no arguments at all, in which case the parameter values are taken from the parameterfile.
Alternatively, values can be passed via the commandline, the required items as command arguments, the optional ones as valued switches.

The table lists all the parameters used by cdi, the second column lists the paramater key names used in the parameterfile, the first column gives the corresponding switch letter.

correlate parameters

expfile stringi di, detector image file.
rsyfile stringo oreconstruction of sky image, .sky
I insfile stringi overrides the IDF reference in detector image file.
b binphase reali detector bin phase.
p p_filtr areai in(ex)clude section form detector image input. area::= x0-x1:y0-y1 Select the rectangular detector area, lower left corner (x0,y0) and upper right corner (x1,y1). The idea here is to exclude the events from one (or more) strong source(s) in the correlation, thereby nullifying its effects (mask and poissonian noise) on weak(er) sources in the field of view. Alternatively, one should be allowed to enter a source position, this better matches the intended use, but is NOT YET IMPLEMENTED !!!
c cmode inti
1 do not apply normalisation with respect to exposure time, skypixel unit is cts/cm2.
2 do not apply normalisation with respect to triangular response (vignetting), no correction for local mask transparency variations. skypixel unit is cts/sec.
4 NOT IMPLEMENTED !!! correct for rectangular response only, no correction for local mask transparencies. skypixel unit is cts/cm2/sec.
8 do not compute the error data plane in the output celestial image.
s smdist reali the X-raysource to mask distance in mm., LBT (Long Beam Test) event data only.
- ofits inti when detector image input is TSPZ(TeleSPaZio format, applicable for QLA only), force FITS output.
p debug inti only as first commandline argument: ignore parameterfile, set debuglevel. general
i title stringi file title, description cq. comments. general
L logfile stringi redirect diagnostic and informational messages. see general
mode "ql"i has meaning for (some) parameterfile parsers/readers only.


Correlate reads a detector-image, reconstructing the celestial image for each detector plane in the detector-image file. The output image data are normalised with respect to the exposure time (FITS key EXPOSE in di) and the effective detector area, pixel data unit is cts/sec.cm2.

  • binning, celestial pixel size - as defined in the instrument-file(FITS)
  • linearisation, correcting the non-linearities in position and area of detector pixels.



    Back to: