NAME
ixpecalcfov -- Calculates a map of the nominal sky field of view for each detector
USAGE
ixpecalcfov.py time ra dec outfile [roll] [refframe] [align] [teldef] [badpix1] [badpix2] [badpix3] [exc_graypix] [use_d1] [use_d2] [use_d3] [clobber]
DESCRIPTION
ixpecalcfov is a stand-along mission planning tool that computes the nominal (non-dithered) field of view for a user-selectable sub-set of the three detectors, sky position (ra, dec) and observing time (time). The output is a FITS image file (user selectable with outfile) with 1’s indicating sky pixels within the field of view and 0’s indicating sky pixels outside the field of view. The user can customize the result by specifying a custom roll angle (roll) or position angle of the spacecraft Y-axis, the celestial reference frame (refframe), and the detectors included in the field of view image (selected by setting use_d1, use_d2, and use_d3, where setting the value to True will include the given detector in the field of view calculation).
By default, the alignment quaternions, telescope definition data, and bad pixel lists are obtained from the IXPE CALDB. align is used to designate the name of a custom file of alignment quaternions; teldef is used to designate the name of a custom file of telescope definition data; and badpix1, badpix2, and badpix3 are used to designate the names of custom files for defining pixels of each corresponding detector to exclude from the field of view. The bad pixel files use flags that designate various types of bad pixels as well as “gray” pixels that may be optionally selected for exclusion by setting exc_graypix=True.
PARAMETERS
- time* (str)
- Observation date and time in ISOT format.
- ra* (float)
- Right ascension of target in degrees.
- dec* (float)
- Declination of target in degrees.
- outfile* (str)
- Path name of output FITS image file.
- roll (float)
- Position angle of the spacecraft y-axis. Default is the computed value, which orients the y-axis toward the sun at the observation date and time.
- refframe (str)
- Celestial reference frame of input position. (default: icrs)
- align (str)
- Path to the align CALDB file. (default: -).
- teldef (str)
- Path to the teldef CALDB file. (default: -).
- badpix1 (str)
- Path to the detector 1 bad pixel CALDB. (default: -)
- badpix2 (str)
- Path to the detector 2 bad pixel CALDB. (default: -)
- badpix3 (str)
- Path to the detector 3 bad pixel CALDB. (default: -)
- exc_graypix (bool)
- Exclude "gray" pixels from the field of view? (default: no)
- use_d1 (bool)
- Calculate detector 1 field of view? (default: yes)
- use_d2 (bool)
- Calculate detector 2 field of view? (default: yes)
- use_d3 (bool)
- Calculate detector 3 field of view? (default: yes)
- clobber
- Overwrite existing output file? (default: no)
EXAMPLES
BUGS
SEE ALSO
LAST MODIFIED
Feb 2022