#! /bin/tcsh 
# NOTE: USER MAY HAVE TO EDIT THIS LINE TO FIND LOCAL tcsh
#
#                UNIVERSITY OF LEICESTER
#              XMM-Newton EPIC Calibration
#
# Jenny Carter
# jac48@star.le.ac.uk
# 2006
#
# PURPOSE:
#               To create exposure maps and reduce an event file
#               to include only those events that fall within a 
#               given separation from a set of coordinates
#
# REQUIREMENTS:
#               The user must have downloaded the MasterList.txt of
#               observation details, and the script BGexpmerge.
#               The user must have an event list from which to select
#               the relevant events in the same directory as the list
#               and script mentioned above.
#
# SOFTWARE USED: 
#                FTOOLS (various) 
#
#
# PROCEDURES CALLED:
#                BGexpmerge
#
#
# WARNINGS AND ERRORS:
#                Error - search radius greater than 90 degrees. 
#                        Too large, select smaller serach radius.
#                Error - no component background information found.
#                        Select a smaller search radius.
#                Error - Files and directories. Merge script and/or
#                        Master table may not be in the correct directory.
#                        Events file may not be in the correct directory.
#                        Adjust locations accordingly. 
#
# VERSION:
#                1.0 200306 - original. 
#                Version for blank sky event files website. JAC
#                1.1 190606 - modification
#                Error message and comments corrected. JAC   
#                1.2 210606 - modification
#                Instead of deleting or directly appending 
#                exposure extensions of evemts files, just append
#                1.3 070806  - modification. JAC
#                Comments adapted                   
#                


set version=1.3

# nice +19

cat <<EOF 

--------------- `echo $0:t | tr '[a-z]' '[A-Z]'` version $version `date +%x` -----------------

EOF

if ( $#argv != 9 ) then
 cat <<EOF 

Merges exposure map files within a certain angular separation from a
given set of coordinates and also extracts the appropriate event files
from the merged event file. Updates event file livetime keywords.

It is essential that the user has the MasterObsList.txt, an event file
from which to select the events that fall within the angular
separation from the given set of coordinates, and a set of exposure
maps from which to select those that correspond to the observations
that occur within the angular separation from the given set of
coordinates .

In addition it is essential that the script BGexpmerge is also
downloaded, and is located in the same directory as that of the
MasterObsList (as given by the directory argument).

Final exposure map files are given the suffix SelectMerge.FIT for
non-vignetted exposure maps and SelectMergeV.FIT for vignetted
exposure maps.  The final events file resulting from this script is
given the name EventsSelectMerge.FIT'

Naming Conventions:
    
Several short hand codes are used for final file naming etc.


    code    applicable for     meaning
    
    PN      instrument         pn EPIC instrument 
    M1      instrument         MOS1 EPIC instrument 
    M2      instrument         MOS2 EPIC instrument 

    T       filter             thin
    M       filter             medium
    K       filter             thick
    
    FF      mode               full-frame mode
    EF      mode               extended full-frame mode


Arguments:

RA - right ascencion of central position of region to consider 

Dec -declination of central position of region to consider 

maxDist - maximum distance away from this central postion to consider in
arcminutes 

directory - location of the master table of all component observation
details. Also the location of the script BGexpmerge and the
sub-directory of the individual exposure map files. This directory can
be created by downloading the appropriate tar file.

eventlist - event list to be processed and appropriate events selected.

instrument - as PN, M1 or M2. See naming conventions 

filter - as T, M or K. See naming conventions 

mode - as FF or EF. See naming conventions 

refill - as Y or N. Set as Y if using the refilled exposure maps

---------------------------------------------------------------

SelectRADec RA Dec maxDist directory-info eventlist instrument filter mode refill

---------------------------------------------------------------

e.g. SelectRADec 55.2 -16.2 250 /home/BlankSky/ eventlist PN M FF Y

EOF
 exit
endif

# Check on inputs
set ra=$1
set dec=$2
set maxDist=$3

set diri=$4
set events=$5

set instr=$6
set filter=$7
set mode=$8
set refill=$9

set theList=$diri'Mastertable.txt'
set basicstring=$diri'Exposures/'
set mergeScript=$diri"BGexpmerge"

# Checks on parameters

if (! -e $diri) then
    echo "ERROR: Directory " $diri " does not exist  ...exiting"
    echo "Check directory name with '/' e.f. home/"
    exit
endif

if (! -e $basicstring) then
    echo "ERROR: Directory " $basicstring " does not exist  ...exiting"
    exit
endif

if (! -e $events) then
    echo "ERROR: Events file " $events " does not exist  ...exiting"
    exit
endif

if (! -e $theList) then
    echo "ERROR: Master list " $theList " does not exist  ...exiting"
    echo "Check that directory name ends with a '/'"
    exit
endif

if (! -e $mergeScript) then
    echo "ERROR: Merge Script " $mergeScript " does not exist  ...exiting"
    exit
endif

if ($instr != 'PN' && $instr != 'M1' && $instr != 'M2') then
    echo "ERROR: Instrument argument in the wrong format (PN, M1, M2) ...exiting"
    exit
endif

if ($filter != 'T' && $filter != 'M' && $filter != 'K') then
    echo "ERROR: Filter argument in the wrong format (T, M, K)  ...exiting"
    exit
endif

if ($mode != 'FF' && $mode != 'EF') then
    echo "ERROR: Mode argument in the wrong format (FF, EF) ...exiting"
    exit
endif

if ($refill != 'Y' && $refill != 'N' && $refill != 'y' && $refill != 'n') then
    echo "ERROR: Refill argument in the wrong format (Y, N, y, n) ...exiting"
    exit
endif

# Begin calculations

set radian=57.2957795
set pi=3.1415926535897931

set nLines=`wc -l $theList | awk '{print $1}'`

# Input position calculation
set cosra=`echo $ra $pi 180 | awk '{print cos(($1 * $2)/($3))}'`
set sinra=`echo $ra $pi 180 | awk '{print sin(($1 * $2)/($3))}'`
set cosdec=`echo $dec $pi 180 | awk '{print cos(($1 * $2)/($3))}'`
set sindec=`echo $dec $pi 180 | awk '{print sin(($1 * $2)/($3))}'`

# 130306 JAC input now in minutes
# Max dist. away in radians

set maxDistDegs=`echo $maxDist 60 | awk '{print ($1/($2))}'`
set maxDistRads=`echo $maxDistDegs $pi 180 | awk '{print (($1 * $2)/($3))}'`
set cosmaxDistRads=`echo $maxDistRads | awk '{print cos($1)}'`

# Check if maxDist less than 90 degrees/0.5*PI radians
set halfpi=`echo $pi 0.5 | awk '{print ($1 * $2)}'` 
set testDist=`echo $halfpi 1 $maxDistRads | awk '{print (($1+$2)-$3)}'`
set testDist2=`echo $halfpi 1 $maxDistRads | awk '{print int(($1+$2)-$3)}'`
set testNeg=`echo $testDist2 | awk '{print int($1)}'`

#echo $maxDistDegs $maxDistRads $cosmaxDistRads
#echo $testDist $testDist2 $testNeg

if ( $testDist2 == 0 || $testDist == 1  || $testNeg < 1 ) then
    # This occurs when the max separation given by the user is 
    # too large
    echo "ERROR: seperation argument greater than or equal to 90 degrees ...exiting"
    exit
endif

set badCount = 0

# totallivetime values and totalontime counts 130706
set totallivetime = 0
set totalliveti01 = 0
set totalliveti02 = 0
set totalliveti03 = 0
set totalliveti04 = 0
set totalliveti05 = 0
set totalliveti06 = 0
set totalliveti07 = 0
set totalliveti08 = 0
set totalliveti09 = 0
set totalliveti10 = 0
set totalliveti11 = 0
set totalliveti12 = 0
set totalontime = 0
set totalontime01 = 0
set totalontime02 = 0
set totalontime03 = 0
set totalontime04 = 0
set totalontime05 = 0
set totalontime06 = 0
set totalontime07 = 0
set totalontime08 = 0
set totalontime09 = 0
set totalontime10 = 0
set totalontime11 = 0
set totalontime12 = 0

set buildexp="prebuild"

if ( -e tempRDWriteexp ) rm -f tempRDWriteexp
if ( -e tempRDWriteexpV ) rm -f tempRDWriteexpV
if ( -e tempPAIRS ) rm -f tempPAIRS
touch tempRDWriteexp
touch tempRDWriteexpV
touch tempPAIRS

echo "SelectRADec: Checking files for separation"

set coincid = 0
set i=0
while ($i != $nLines)
    @ i = $i + 1
    set thisLine=`cat $theList | head -$i | tail -1`

    #echo $thisLine

    set thisOBS=`echo $thisLine | cut -d " " -f2`
    set thisEXP=`echo $thisLine | cut -d " " -f3`
    set thisRA=`echo $thisLine | cut -d " " -f4`
    set thisDEC=`echo $thisLine | cut -d " " -f5`

    set thisINSTR=`echo $thisLine | cut -d " " -f7`
    set thisMODE=`echo $thisLine | cut -d " " -f8`
    set thisFILTER=`echo $thisLine | cut -d " " -f9`   

    #echo $instr $mode $filter $thisINSTR $thisMODE $thisFILTER

    if ( $thisINSTR == $instr && $thisMODE == $mode && $thisFILTER == $filter ) then

	set thisTLMIN1=`echo $thisLine | cut -d " " -f10`
	set thisTLMAX1=`echo $thisLine | cut -d " " -f11`

	set thisLivetime=`echo $thisLine | cut -d " " -f12`
	set thisLiveti01=`echo $thisLine | cut -d " " -f13`
	set thisLiveti02=`echo $thisLine | cut -d " " -f14`
	set thisLiveti03=`echo $thisLine | cut -d " " -f15`
	set thisLiveti04=`echo $thisLine | cut -d " " -f16`
	set thisLiveti05=`echo $thisLine | cut -d " " -f17`
	set thisLiveti06=`echo $thisLine | cut -d " " -f18`
	set thisLiveti07=`echo $thisLine | cut -d " " -f19`

	if ($instr == EPN || $instr == PN  || $instr == pn ) then
	    set thisLiveti08=`echo $thisLine | cut -d " " -f20`
	    set thisLiveti09=`echo $thisLine | cut -d " " -f21`
	    set thisLiveti10=`echo $thisLine | cut -d " " -f22`
	    set thisLiveti11=`echo $thisLine | cut -d " " -f23`
	    set thisLiveti12=`echo $thisLine | cut -d " " -f24`
	    
	    set thisontime=`echo $thisLine | cut -d " " -f25`
	    set thisontime01=`echo $thisLine | cut -d " " -f26`
	    set thisontime02=`echo $thisLine | cut -d " " -f27`
	    set thisontime03=`echo $thisLine | cut -d " " -f28`
	    set thisontime04=`echo $thisLine | cut -d " " -f29`
	    set thisontime05=`echo $thisLine | cut -d " " -f30`
	    set thisontime06=`echo $thisLine | cut -d " " -f31`
	    set thisontime07=`echo $thisLine | cut -d " " -f32`
	    set thisontime08=`echo $thisLine | cut -d " " -f33`
	    set thisontime09=`echo $thisLine | cut -d " " -f34`
	    set thisontime10=`echo $thisLine | cut -d " " -f35`
	    set thisontime11=`echo $thisLine | cut -d " " -f36`
	    set thisontime12=`echo $thisLine | cut -d " " -f37`
	    
	else     # 130706 adjustment for ontime    
	    
	    set thisontime=`echo $thisLine | cut -d " " -f20`
	    set thisontime01=`echo $thisLine | cut -d " " -f21`
	    set thisontime02=`echo $thisLine | cut -d " " -f22`
	    set thisontime03=`echo $thisLine | cut -d " " -f23`
	    set thisontime04=`echo $thisLine | cut -d " " -f24`
	    set thisontime05=`echo $thisLine | cut -d " " -f25`
	    set thisontime06=`echo $thisLine | cut -d " " -f26`
	    set thisontime07=`echo $thisLine | cut -d " " -f27`

	endif

	#echo "Ontime values: " $thisontime $thisontime01 $thisontime02 $thisontime03 $thisontime04 $thisontime05 $thisontime06 $thisontime07 $thisontime08 $thisontime09 $thisontime10 $thisontime11 $thisontime12

	set thisRARads=`echo $thisRA $pi 180 | awk '{print (($1*$2)/$3)}'`
	set thisDECRads=`echo $thisDEC $pi 180 | awk '{print (($1*$2)/$3)}'`

	set cosra2=`echo $thisRA $pi 180 | awk '{print cos(($1*$2)/$3)}'`
	set sinra2=`echo $thisRA $radian | awk '{print sin($1/$2)}'`
	set cosdec2=`echo $thisDEC $radian | awk '{print cos($1/$2)}'`
	set sindec2=`echo $thisDEC $radian | awk '{print sin($1/$2)}'`

	set t1 = `echo $cosra $cosdec $cosra2 $cosdec2 | awk '{print $1*$2*$3*$4}'`
	set t2 = `echo $sinra $cosdec $sinra2 $cosdec2 | awk '{print $1*$2*$3*$4}'`
	set t3 = `echo $sindec $sindec2 | awk '{print $1*$2}'`

	set cosd = `echo $t1 $t2 $t3 | awk '{print $1+$2+$3}'`
    
	set test = `echo $cosd $cosmaxDistRads | awk ' {print int($2-$1)}'`	
	set testNeg =  `echo $cosd | awk ' {print int($1)}'`
	set testGreaterBasic = `echo $cosd $cosmaxDistRads 1 | awk ' {print (($2 + $3) -$1)}'`	
	set testGreater = `echo $cosd $cosmaxDistRads 1 | awk ' {print int(($2 + $3) -$1)}'`	

	# echo "Test cosd cosmaxDistRads testNeg testGreater: " $cosd $cosmaxDistRads $testNeg $testGreater

	if ( $testNeg >= 0 && $testGreater == 0 ) then 

	    # Within separation then take values and write to file

	    set coincid = `echo $coincid 1 | awk '{print ($1 + $2)}'`
	    # echo "Found exposure within range" $i $cosd $cosmaxDistRads 
	
	    if ($refill == Y || $refill == y) then
		echo $basicstring"P"$thisOBS$instr$thisEXP"BGEXMNR000.FIT" >> tempRDWriteexp # This may change to refer to another of the master obs attributes that refer to an index in the set of files	    
		# For example $dir"file"$index"BGEXMVR000.FIT" >> tempRDWriteexpV
		echo $basicstring"P"$thisOBS$instr$thisEXP"BGEXMVR000.FIT" >> tempRDWriteexpV
	    else
		echo $basicstring"P"$thisOBS$instr$thisEXP"BGEXMNU000.FIT" >> tempRDWriteexp
		echo $basicstring"P"$thisOBS$instr$thisEXP"BGEXMVU000.FIT" >> tempRDWriteexpV 
	    endif
	
	    echo $thisTLMIN1 $thisTLMAX1  >> tempPAIRS

	    # Print out all this information to a subset file to be used to extract events
	    # or/and sum up livetime value and liveti0n values
	
	    set totallivetime = `echo $totallivetime $thisLivetime | awk '{print ($1 + $2)}'`
	    set totalliveti01 = `echo $totalliveti01 $thisLiveti01 | awk '{print ($1 + $2)}'`
	    set totalliveti02 = `echo $totalliveti02 $thisLiveti02 | awk '{print ($1 + $2)}'`
	    set totalliveti03 = `echo $totalliveti03 $thisLiveti03 | awk '{print ($1 + $2)}'`
	    set totalliveti04 = `echo $totalliveti04 $thisLiveti04 | awk '{print ($1 + $2)}'`
	    set totalliveti05 = `echo $totalliveti05 $thisLiveti05 | awk '{print ($1 + $2)}'`
	    set totalliveti06 = `echo $totalliveti06 $thisLiveti06 | awk '{print ($1 + $2)}'`
	    set totalliveti07 = `echo $totalliveti07 $thisLiveti07 | awk '{print ($1 + $2)}'`

	    # 130706 totalontime calculations

	    set totalontime = `echo $totalontime $thisontime | awk '{print ($1 + $2)}'`
	    set totalontime01 = `echo $totalontime $thisontime01 | awk '{print ($1 + $2)}'`	    
	    set totalontime02 = `echo $totalontime $thisontime02 | awk '{print ($1 + $2)}'`
	    set totalontime03 = `echo $totalontime $thisontime03 | awk '{print ($1 + $2)}'`
	    set totalontime04 = `echo $totalontime $thisontime04 | awk '{print ($1 + $2)}'`
	    set totalontime05 = `echo $totalontime $thisontime05 | awk '{print ($1 + $2)}'`
	    set totalontime06 = `echo $totalontime $thisontime06 | awk '{print ($1 + $2)}'`
	    set totalontime07 = `echo $totalontime $thisontime07 | awk '{print ($1 + $2)}'`

	    if ($instr == EPN || $instr == PN  || $instr == pn ) then
		set totalliveti08 = `echo $totalliveti07 $thisLiveti08 | awk '{print ($1 + $2)}'`
		set totalliveti09 = `echo $totalliveti07 $thisLiveti09 | awk '{print ($1 + $2)}'`
		set totalliveti10 = `echo $totalliveti07 $thisLiveti10 | awk '{print ($1 + $2)}'`
		set totalliveti11 = `echo $totalliveti07 $thisLiveti11 | awk '{print ($1 + $2)}'`
		set totalliveti12 = `echo $totalliveti07 $thisLiveti12 | awk '{print ($1 + $2)}'`

		set totalontime08 = `echo $totalontime $thisontime08 | awk '{print ($1 + $2)}'`
		set totalontime09 = `echo $totalontime $thisontime09 | awk '{print ($1 + $2)}'`
		set totalontime10 = `echo $totalontime $thisontime10 | awk '{print ($1 + $2)}'`
		set totalontime11 = `echo $totalontime $thisontime11 | awk '{print ($1 + $2)}'`
		set totalontime12 = `echo $totalontime $thisontime12 | awk '{print ($1 + $2)}'`

	    endif
	else    
	    # Count unsuccessful tests
	    set badCount = `echo $badCount 1 | awk '{print ($1 + $2)}'`
	endif
    endif
end

# Write type file for gti file, create GTI file

if ( -e tempGTI ) rm -f tempGTI
if ( -e tempGTIfits ) rm -f tempGTIfits
touch tempGTI
    echo "START D" >> tempGTI
    echo "STOP D" >> tempGTI
fcreate tempGTI tempPAIRS tempGTIfits
fparkey "J.A. Carter" tempGTIfits CREATOR add=yes 

echo "SelectRADec: Number of coincidence files is: " $coincid " out of: " $nLines

if ($coincid == 0) then
    # Clear up
    rm -f tempPAIRS
    rm -f tempRDWriteexp
    rm -f tempRDWriteexpV
    # Exit out of program if no components to the search area are found
    echo "ERROR: No relevant background areas found for your RA, declination and radius specifications"
    echo "Please widen the search radius, or choose different RA and declination values ...exiting"
    exit
endif

######################### Take these observations and merge exposure maps  ###########################
 
# Non-vignetted exposure maps
if ( -e  ExpIndex ) rm -f ExpIndex
ls `ls tempRDWriteexp` > ExpIndex
set nexL=`wc -l ExpIndex | awk '{print $1}'` 
#echo 'File count, for exposure maps is: ' $nexL

set i=0
while ($i != $nexL)   
    @ i = $i + 1
    #echo 'At file in list, or filename: ' $i
    set thisFile=`cat ExpIndex | head -$i | tail -1`
    #echo 'Filename now is: ' $thisFile
    $mergeScript $thisFile $instr $filter $mode".SelectMerge" 5 # SPECIFIC Script
end

# Vignetted exposure maps
if ( -e  ExpIndexV ) rm -f ExpIndexV
ls `ls tempRDWriteexpV` > ExpIndexV
set nexL=`wc -w ExpIndex | awk '{print $1}'` 
#echo 'File count, for exposure maps is: ' $nexL

set i=0
while ($i != $nexL)   
    @ i = $i + 1
    #echo 'At file in list, or filename: ' $i
    set thisFile=`cat ExpIndexV | head -$i | tail -1`
    #echo 'Filename now is: ' $thisFile
    $mergeScript $thisFile $instr $filter $mode".SelectMergeV" 5 Y # SPECIFIC Script
end

rm -f ExpIndex ExpIndexV
if ( -e tempRDWriteexp ) rm -f tempRDWriteexp
if ( -e tempRDWriteexpV ) rm -f tempRDWriteexpV

##### Event file selection of events ############

echo "SelectRADec: Select appropriate events from event list: " 

if ($instr == EPN || $instr == PN  || $instr == pn ) then    
    # echo "PN evselect on gti"
    # -w 0 -v 0
    evselect table=$events withfilteredset=Y filteredset=tempEvents \
  destruct=Y keepfilteroutput=T \
  expression='#XMMEA_EP && gti(tempGTIfits,TIME) && (PI>150)'
    
else
    # echo "MOS evselect on gti"
evselect table=$events withfilteredset=Y filteredset=tempEvents \
  destruct=Y keepfilteroutput=T \
  expression='#XMMEA_EM && gti(tempGTIfits,TIME) && (PI>150)'
endif

# Save temporary events file to final file as specified by the user

set outevents='EventsSelected.FIT'
mv -f tempEvents $outevents

if ( -e tempPAIRS ) rm -f tempPAIRS
if ( -e tempFIRST ) rm -f tempFIRST
if ( -e tempGTI ) rm -f tempGTI


echo 'SelectRADec task completed'

exit