NAME

bcoccult -- Calculate a full-sky map to shows the sky occulted by the earth within a time interval

USAGE

bcoccult orbit_file gti_file outprefix (nside) (scheme)

DESCRIPTION

This task calculates the occultation full-sky map that shows the part of the sky occulted by the earth for a specific time period. The output map is written as a FITS file with an Aitoff projection in the primary header and a HEAPIx representation in the first extension. The pixel values are set either 0 to indicate earth occultation or 1 to indicate no occultation. The task requires as input an orbit file and a good time intervals over which the earth ocultation is evaluated. Both files are in FITS format. For each time of the orbital data file that fall within the input time interval, the task retrives the satellite position and calculates a radius that represents the apparent size of the earth on the sky and sets to 0 pixels in the output image to indicate that the sky is occulted otherwise set the pixels to 1.
The task requires to have the REFDATA environment variable set to get the FITS template header of the output. This task is applicable to BURSTCUBE or to diffent mission that provides the orbit data in the same format.

PARAMETERS

orbit_file [file name]
Input FITS file containing orbital data. The columns read are : TIME, X, Y, and Z.

outprefix [string]
Prefix to be used by all output files by this task.

gti_file [file name]
Input Good time Interval (GTI) FITS file containing time period to create occultation map.

(nside) [int]
Size of HEALPix map to create. Must be power of 2. The default is 16

(scheme='ring') [string]
Ordering scheme for HEALPix map. Either 'ring' or 'nested'

(refdata=REFDATA) [string]
Directory name where the FITS template for the output are located. By default this is set to enviroment variable REFDATA.

(chatter=1) [int]
Level of chatter/verbosity of the task. Allow values are between 0-5 default is 1.

(log=no) [bool]
Flag to allow the log file creation. By default the log file is not created (log=no), if the parameter log is set to 'yes' a log is created with a filename set to taskname_DDMMYYYY_HHMMSS.log.

(clobber=no) [bool]
Flag to overwrite existing output files. By default the file output are not overwrite (clobber=no)

(mode = ql) [string ql|hl|q]
Mode to query the parameter file. Acceptable values include: 'ql' (query and learn/remember), 'hl' (hidden and learn/remember), 'q' (query but don't remember), 'h' (hidden).

EXAMPLES

  1. bcoccult

    2. 



BUGS


SEE ALSO


LAST MODIFIED

Feb 2025