NAME

nubackscale -- Apply backscale correction to NuSTAR energy spectra

USAGE

nubackscale srcphafile bkgphafile srcoutfile bkgoutfile evtfile attfile mastaspectfile det1reffile [parameter = < value >]

DESCRIPTION

'nubackscale' generates a corrected source and/or background spectrum accounting for the exposure variations within the extraction regions. By default ('inexpomapfile=NONE'), the corrections are calculated using a sky exposure map generated internally by the 'nuexpomap' task. A sky exposure map, not corrected for vignetting, can also be provided in input to the task by setting the input parameter 'inexpomapfile', allowing to reduce the execution time. The task generates output FITS PHA file ('srcoutfile' and/or 'bkgoutfile') with updated values of the 'BACKSCAL' keyword.

The task also adds or updates to the output PHA files the keyword 'NUBACKSC' with value 'T' to specify that the spectrum files has been corrected.

PARAMETERS

srcphafile [file name]
Name of the input source PHA FITS File.

bkgphafile [file name]
Name of the input background PHA FITS File.

srcoutfile [file name]
Name of the output source PHA FITS File or NONE to overwrite the input file.

bkgoutfile [file name]
Name of the output background PHA FITS File or NONE to overwrite the input file.

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

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

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

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

attfile [file name]
Name of FITS attitude file.

(teldef=CALDB) [filename]
Name of teldef calibration file or CALDB.

(instrprobmapfile=CALDB) [filename]
Name of the input Instrument Probability Map File or CALDB.

(inexpomapfile=NONE) [filename]
Name of the input Exposure Map File or NONE for none.

(aberration=no) [boolean]
If set to yes, aberration is included in aspecting.

det1reffile [file name]
Name of the input DET1 Reference Pixel File.

(pixbin = 5) [integer]
Bin size of aspect histogram in pixels (pixel size = 2.46 arcsec).

(percent = 0.02) [real]
Probability threshold for DET1 instrument map generation.

(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.

(srccorrect=yes) [boolean]
If set to yes, the BACKSCAL keyword of source PHA FITS File is corrected.

(bkgcorrect=yes) [boolean]
If set to yes, the BACKSCAL keyword of background PHA FITS File is corrected.

(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. Apply the backscale correction to the input source and background spectra. The corrected spectra are written in the output files 'nu40060001001A01_sr_corr.pha' and 'nu40060001001A01_bk_corr.pha'. 

     
> nubackscale srcphafile=nu40060001001A01_sr.pha bkgphafile=nu40060001001A01_bk.pha evtfile=nu40060001001A01_cl.evt
  srcoutfile=nu40060001001A01_sr_corr.pha bkgoutfile=nu40060001001A01_bk_corr.pha attfile=nu40060001001_att.fits 
  mastaspectfile=nu40060001001_mast.fits det1reffile=nu40060001001A_det1.fits
  2. Same as the above example with a sky exposure map (not corrected for vignetting) provided in input: 

     
> nubackscale srcphafile=nu40060001001A01_sr.pha bkgphafile=nu40060001001A01_bk.pha evtfile=nu40060001001A01_cl.evt
  srcoutfile=nu40060001001A01_sr_corr.pha bkgoutfile=nu40060001001A01_bk_corr.pha attfile=nu40060001001_att.fits 
  mastaspectfile=nu40060001001_mast.fits det1reffile=nu40060001001A_det1.fits inexpomapfile=nu40060001001A01_ex.img

BUGS

SEE ALSO

LAST MODIFIED

April 2014