NAME

niphasyserr - apply NICER spectral systematic error vector

USAGE

niphasyserr infile syserrfile

DESCRIPTION

niphasyserr adds the NICER systematic error vector to a NICER spectral file. The systematic error vector contains an estimate of the fractional systematic error in each NICER spectral channel. Normally this information is retrieved from the NICER calibration database (CALDB).

The task handles the differences between type I and type II spectral files transparently.

The parameter "scalefactor" provides users a way to scale the systmatic error vector up or down based on their own conditions. The systematic error vector is multiplied by this factor before being written to the spectrum file.

PARAMETERS

infile [filename]
Input/output spectral file. The file should be an OGIP-standard type I or type II spectral file. The DATE-OBS keyword is used to query the CALDB. The file is modified in place. If necessary, the SYS_ERR column is created, and the SYS_ERR keyword is deleted.

syserrfile [filename]
Name of the systematic error vector file to use. Normally this should be set to "CALDB" so that the current best estimate of the NICER spectral systematic error is used for the date of the given infile.

(syserrfactor=1.0) [real]
Scale factor for systematic error values.

(chatter = 2) [integer, 0 - 5]
Controls the amount of informative text written to standard output.

EXAMPLES

1. Create the SYS_ERR column in a spectral file named myspectrum.pha.

        niphasyserr myspectrum.pha CALDB
The systematic error vector is retrieved from the calibration database.

SEE ALSO

nicerl3-spect

niextspect

niphaquality

LAST MODIFIED

Feb 2024