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.
| switch | key | value | IO | description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| expfile | string | i | di, detector image file. | |||||||||
| rsyfile | string | o | oreconstruction of sky image, .sky | |||||||||
| I | insfile | string | i | overrides the IDF reference in detector image file. | ||||||||
| b | binphase | real | i | detector bin phase. | ||||||||
| p | p_filtr | area | i | 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 | int | i |
| ||||||||
| s | smdist | real | i | the X-raysource to mask distance in mm., LBT (Long Beam Test) event data only. | ||||||||
| - | ofits | int | i | when detector image input is TSPZ(TeleSPaZio format, applicable for QLA only), force FITS output. | ||||||||
| p | debug | int | i | only as first commandline argument: ignore parameterfile, set debuglevel. general | ||||||||
| i | title | string | i | file title, description cq. comments. general | ||||||||
| L | logfile | string | i | 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.