NAME

nucalcpos -- Convert Raw coordinates into Detector coordinates of NuSTAR event files

USAGE

nucalcpos infile outfile mastaspectfile [parameter = < value >]

DESCRIPTION

'nucalcpos' calculates the detector coordinates of NuSTAR event files. This is done through two distinct processing steps. In the first step, for a given Focal Plane Module, the telemetry raw coordinates of the four detectors, stored in the 'RAWX' and 'RAWY' columns of the input event file, are converted into detector coordinates in the Focal Plane Bench Frame (defined as 'DET1').

The DET1 coordinates are calculated using information from ground calibration data which collect the spatial probability distribution for each pixel of the detectors. The probability distribution for event grades from 0 to 26, is stored as a 7x7 grid in the Focal Plane Bench frame. The pixel positional information is stored in the NuSTAR calibration pixel location file which is included in the CALDB.
The task, for each event i) finds in the CALDB pixel position file the corresponding 7x7 probability distribution, ii) assigns a position in the Focal Plane Bench Frame following the probability map and iii) stores the computed values in the 'DET1X' and 'DET1Y' columns of the output event file. The DET1 coordinates pixel size is set to 12.3/5 arcsec.

In the second step, the task converts the detector coordinates in the Focal Plane Bench Frame into detector coordinates in the Optics Bench Frame (defined as 'DET2'). The detector coordinates in the Optics Bench Frame are calculated using the mast aspect solution ('mastaspectfile') and stored in the 'DET2X' and 'DET2Y' columns of the output event file. The DET2 coordinates pixel size is set to 12.3/5 arcsec.

PARAMETERS

infile [file name]
Name of the input FITS Event File.

outfile [file name]
Name of output FITS Event File.

(pixposfile=CALDB) [filename]
Name of the input pixel location file or CALDB.

(saveraw2coord=no) [boolean]
If set to yes, save 'RAW2X' and 'RAW2Y' columns (internal use for debugging only).

(initseed=no) [boolean]
If set to yes, the random number generator uses a frozen seed value. If set to no, different seeds are generated for each run.

(alignfile=CALDB) [filename]
Name of the input alignment file or CALDB.

mastaspectfile [filename]
Name of the input Mast Aspect Solution File.

(clobber=no) [boolean]
If set to yes, overwrite the output file.

(history=yes) [boolean]
If set to yes, write parameter values and other information in HISTORY blocks.

(chatter = 2) [integer]
Chatter Level (min=0, max=5).

EXAMPLES

  1. Convert the RAW coordinates of the input event file 'nu40060001001A_uf.evt' to DET1 and DET2 coordinates using the pixel location file stored in the CALDB. The DET1X,DET1Y and DET2X,DET2Y coordinates are written in the output file 'nu40060001001A_out.evt'. 

    >  nucalcpos infile=nu40060001001A_uf.evt outfile=nu40060001001A_out.evt mastaspectfile=nu40060001001_mast.fits

    BUGS

    SEE ALSO

    LAST MODIFIED

    May 2012