uvotimage.py

#uvotimage.py: Script to create sky images from raw images and event files.
#Created on 14-12-2017, updated (to Python 3.6) on 24-10-2018.
#Updated on 10-01-2019 (based on feedback Bob).
#Updated on 12-04-2019 (to include event files).
#Marjorie Decleir

#Import the necessary packages.
import os
import shutil
import subprocess
from astropy.io import fits
import configloader


#Load the configuration file.
config = configloader.load_config()

#Specify the galaxy and the path to the working directory.
galaxy = config['galaxy']
path = config['path']  + galaxy + "/working_dir/"


#Print user information.
print("Creating sky images...")

#Initialize the counter and count the total number of raw images. Initialize the error flag.
i = 0
num = sum(1 for filename in sorted(os.listdir(path)) if filename.endswith("rw.img") or filename.endswith(".evt"))
error = False

#For all files in the working directory:
for filename in sorted(os.listdir(path)):
    
    #If the file is not a raw image or an event file, skip this file and continue with the next file.
    if not filename.endswith("rw.img") and not filename.endswith(".evt"): continue
    
    #Specify the input file, the prefix for the output file, the attitude file and the terminal output file.
    infile = filename
    prefix = filename.split('u')[0] + "_" + filename.split('.')[1] + "_"
    attfile = filename.split('u',1)[0] + "pat.fits"
    terminal_output_file = path + "output_uvotimage_" + filename.split('.')[0] + ".txt"
 
    #Open the file and take the RA, DEC and roll from the header.
    header = fits.open(path+filename)[0].header
    RA = header['RA_PNT']
    DEC = header['DEC_PNT']
    PA = header['PA_PNT'] 

    #Open the terminal output file and run uvotimage with the specified parameters.
	#uvotimage help page: https://heasarc.gsfc.nasa.gov/lheasoft/ftools/headas/uvotimage.html
    with open(terminal_output_file,"w") as terminal:
        subprocess.call("uvotimage infile=" + infile + " prefix=" + prefix + " attfile=" + attfile + " teldeffile=CALDB alignfile=CALDB ra=" + str(RA) + " dec=" + str(DEC) + " roll=" + str(PA) + " mod8corr=yes refattopt='ANGLE_d=5,OFFSET_s=1000'", cwd=path, shell=True, stdout=terminal)
    
    #Check if the sky image was successfully created.
    file = open(terminal_output_file,"r")
    for line in file:
        #If the word "error" is encountered, print an error message.
        if "error" in line:
            print("An error has occured for image " + filename)
            error = True
    
        #If uvotimage skipped an event based image HDU, let the user know.
        if "skipping event based image HDU" in line:
            print(line, " in file " + filename)

    #Print user information.
    i += 1
    print("Sky image created for all (other) frames of " + filename + " (" + str(i) + "/" + str(num) + ")")

#Print user information.  
if error == False:
    print("Sky images were successfully created for all raw images and event files.")