Summary

This new version of ESAS is (almost) totally integrated into SAS and obeys the SAS standards. For example, the standard SAS command line flags such as -c, -h, and -V are now fully implemented for the ESAS tasks. In an effort to become more “SAS-like”, many of the routines that formerly relied on fixed file names for input/output files have been modified to allow user-specified names. Of course this requires more non-default input parameters, but will allow greater flexibility in the application of these routines. In order to help users familiar with the old ESAS convert to the new ESAS, we include a table showing the equivalencies between the old and new file names.

The mixture of base routines and scripts has engendered some confusion about what is required for XMM-ESAS to work, and what is strictly a matter of convenience. To relieve some of this confusion, some of the scripts, such as mos-filter, have been broken into more task specific pieces. The cheese task remains, but we now document how to use its components. Conversely, the mos-spectra and pn-spectra perl scripts have been completely converted to FORTRAN, mosspectra and pnspectra, and have grown in functionality. We note while these routines have, historically, been the slow choke-point for ESAS, we now have used options in the underlying backscal routines for speeding the processing. The mos_back and pn_back routines have been rewritten to become mosback and pnback, with some changes in calling and capability.

This version of ESAS introduces a new task, emanom which should, for the purposes of ESAS, replace emtaglenoise for determining whether a MOS chip is in an anomalous state.

Finally, an almost invisible change is that there is no longer a separate ESAS CCF; (almost) all ESAS calibration files are now within the standard CCF, and are called by standard SAS routines rather than fitsio routines. The remaining ESAS calibration files are now contained within the SAS distribution; we expect to eliminate/replace them in future versions.

Table 1: Change Log

Change Log
SAS	Task	Change
V10.5	pn_back	Additional diagnostic output
$-$	espfilt	Improve the output plotting
$-$	CalDB files	Extensive reformatting of files requiring changes in multiple tasks
$-$	pn_back	New release $-$ still under development
$-$	cheese-bands	New release
$-$	proton_scale	Parameter and input file changes for mode=2
$-$	mos_back	Bug fix affecting Mac users
$-$	proton	Combined CCF flare files
$-$	comb	Updated scale factors for merging data from different filters $-$ assumed
		hardness now selectable
$-$	merge_comp_xmm	Same as comb
$-$	swcx	Cast SWCX background images
V11.0	CalDB	Updated QPB and FWC files $-$ NEW DOWNLOAD REQUIRED
$-$	mos_back	Check for MOS1 CCD#6 status
$-$	mos-spectra	Check for MOS1 CCD#6 status
$-$	proton	Check for MOS1 CCD#6 status
$-$	swcx	Check for MOS1 CCD#6 status
$-$	bin_image	Implement SWCX processing
$-$	bin_image_merge	Implement SWCX processing
$-$	adapt_2000	Implement SWCX processing
$-$	merge_comp_xmm	Implement SWCX processing
$-$	conv-region	Simplify region description for multiple observations
V12.0	CalDB	Updated QPB and FWC files $-$ NEW DOWNLOAD REQUIRED
$-$	$-$	Most critical is the conversion of MOS analysis to 5 eV channels
$-$	comb	Bug fix and correct treatment of multiband exposure maps
$-$	bin_image	Bug fixed
$-$	merge_comp_xmm	Added units and comment line to output images
$-$	mos-filter	Diagnostic output added to check for anomalous states
$-$	mos-spectra	Convert MOS processing to use 5 eV channels
$-$	mos_back	Fix ObsID misidentification in *-spec.qdp
$-$	$-$	Fixes required by changed file format for emask output
$-$	$-$	Changes required to implement 5 eV energy bins
$-$	$-$	Add additional diagnostic information in *-aug.qdp
$-$	$-$	Fixes required for updated QPB files
$-$	$-$	Fixes required for revised version of read_rmf
$-$	pn_back	Fixes required for revised version of read_rmf
$-$	adapt_900	Add smoothing scale image and qdp plot output
$-$	adapt_2000	Add smoothing scale image and qdp plot output
$-$	swcx	Add pulse-height smearing
$-$	$-$	Requires a new command parameter
$-$	read_rmf	Subroutine in subs.f $-$ actually return the response matrix
$-$	cheese	Fixes required by changed file format for emask output
$-$	make_mask_merge	Fixes required by changed file format for emask output
$-$	$-$	Modify so that it will run with just the output from cheese
$-$	esmosaic_prep	New task, companion task to prep_mosaic which adds
$-$	$-$	the correct pointing keywords to the fits headers of the separated
$-$	$-$	observation segments. Not a final solution but works with the
$-$	$-$	correct pixie dust sprinkled liberally.

Change Log - continued
SAS	Task	Change
V13.0	General	Conversion of all FORTRAN 77 routines to FORTRAN 90/95
$-$	esprep_mosaic	New task to allow processing of mosaic-mode observations
$-$	esprep_mosaic_time	New task to extract the time intervals for mosaic-mode observations
$-$	esas-mosaic	Driver task to overwrite header keywords for mosaic-mode observations
$-$	comb	Bug fix for scalings using alpha between 1.7 and 2.4
$-$	merge_comp_xmm	Bug fix for scalings using alpha between 1.7 and 2.4
$-$	conv_reg	New task to convert region information from sky coordinates to detector
$-$	$-$	coordinates
$-$	adapt_merge	Renaming of adapt_2000 to adapt_merge
$-$	adapt	Renaming of adapt_900 to adapt
$-$	Various	Inclusion of clobber parameter
V13.0.1	esprep_mosaic_time	Bug fix
V13.0.3	mos-filter	Fix for processing MOS1 CCD#4 data after loss of CCD#3
$-$	espfilt	Fix for processing MOS1 CCD#4 data after loss of CCD#3
$-$	mos-spectra	Fix for processing MOS1 CCD#4 data after loss of CCD#3
$-$	mos_back	Include corner data from CCD#2 and CCD#7 for the calculation of
$-$	$-$	CCD#1 background
$-$	mos_back	Bug fix – MOS background spectra uncertainties were too large
$-$	make_mask_merge	Code improvement
$-$	rot-im-det-sky	Bug fix and addition of modes to allow merging of masks
$-$	rot_det_sky	Addition of modes to allow merging of masks
V15.0	Various	Removal of MOS1 CCD#4 fixes data after loss of CCD#3
$-$	merge_comp_xmm	Bug fix to allow ehigh>9999
$-$	rot_im_det_sky	Removal of MOS1 CCD#4 fixes data after loss of CCD#3
$-$	espfilt	Removal of MOS1 CCD#4 fixes data after loss of CCD#3
$-$	mos-spectra	Removal of MOS1 CCD#4 fixes data after loss of CCD#3
$-$	mos-back	Removal of MOS1 CCD#4 fixes data after loss of CCD#3
$-$	conv_reg	Bug fix
V16.0	adapt	Cosmetic changes to radial plot output
$-$	cheese-bands	Eliminated, capabilities included in cheese
$-$	cheese	Expanded to process one or two bands
$-$	cheese	Converted to be a wrapper around edetect_chain
$-$	cheese	Modified to bring better agreement between DETXY and XY masking
$-$	conv-reg	Bug fixes
$-$	conv-region	Eliminated as no longer needed
$-$	esas-mosaic	Eliminated as no longer needed
$-$	esprep_mosaic	Eliminated as no longer needed
$-$	esprep_mosaic_times	Eliminated as no longer needed
V17.0	Various	Inclusion of CalDB files in the CCF structure
$-$	CalDB	Add MOS canned corner spectra
$-$	$-$	Add pn single-pixel QDP and canned corner spectra
$-$	cheese	Uniform usage of the radiusstyle=contour parameter for source excision
$-$	mos_back	Inclusion of capability to make count background spectra (CSTAT)
$-$	$-$	Inclusion of capability to use canned corner spectra
$-$	pn_back	Inclusion of capability to make count background spectra (CSTAT)
$-$	$-$	Inclusion of capability to use canned corner spectra
$-$	$-$	Add the ability to select either single- or double-pixel events
$-$	pn-spectra	Add the ability to select either single- or double-pixel events

Change Log - continued
SAS	Task	Change
V 21.0	Various and Sundry
$-$	general	change of input/output file name convention, convention for passing CCD information.
$-$	binadaptmerge	Renamed from adapt_merge and combined with bin_merge.
$-$	binadapt	Created to contain the functionality of bin_image and adapt.
$-$	cheese	Converted from perl to FORTRAN, HEASOFT useage eliminated, filenaming convention changed, parameter names changed.
$-$	cheese-bands	Now part of cheese.
$-$	comb	Changed name to combimage. Parameters changed. Functionality unchanged.
$-$	combimage	Changed name from comb. Parameters changed. Functionality unchanged.
$-$	emanom	Introduction of a new task, equivalent functionality removed from mos-filter
$-$	emlfill	Changed name from file_list.
$-$	emlmerge	New version of merge_source_list.
$-$	espfilt	Flags rectified, histogram fit parameters output to header, root name of output files determined from subid in header, more user tuneable parameters added, ability to turn off extra output added, changed some output file names
$-$	file_list	Changed name to emlfill. Parameters changed.
$-$	merge_comp	Changed name to mosaicmerge. Parameters changed.
$-$	merge_source_list	Changed name to emlmerge. Parameters changed.
$-$	mosback	Changed name from mos_back, changed some parameter names and input/output file names.
$-$	mos-filter	Retired task as just a wrapper for espfilt.
$-$	mosaicmerge	Changed name from merge_comp. Parameters changed. Functionality unchanged.
$-$	mosspectra	Converted from the perl script mos-spectra, change of input parameters and input/output file names, accelerated by increasing badpixelresolution parameter passed to backscale, now using SOC provided FWC files
$-$	pnback	Changed name from pn_back, changed some parameter names and input/output file names, now QPB files separated by mode
$-$	pn-filter	Retired task as just a wrapper for espfilt.
$-$	pnspectra	Converted from the perl script pn-spectra, change of input parameters and input/output file names, accelerated by increasing badpixelresolution parameter passed to backscale, now using SOC provided FWC files
$-$	pointsrc	Changed name from point_source. Parameters changed. Functionality unchanged.
$-$	proton	Complete re-write with a change in parameters. Functionality unchanged.
$-$	protonscale	Changed name from proton_scale. Parameters changed.
$-$	rotdet2sky	Converted from the perl task rot-im-det-sky, made more general (no longer needs to know what type of file is input (QPB, SPF, SWCX, etc.), and input/output files explicitly passed as parameters
$-$	rot-im-det-sky	Changed name to rotdet2skyl.
$-$	sppartial	Changed name from sp_partial. Parameters changed. Functionality unchanged.
$-$	swcx	Parameters changed. Functionality not significantly changed.