XMM-Newton Science Analysis System


esas (esas-0.10.5) [xmmsas_20190531_1155-18.0.0]

Parameters

This section documents the parameters recognized by this task (if any).

1. Task adapt parameters:

Task adapt_merge parameters:

Task bin_image parameters:

Task bin_image_merge parameters:

Task cheese parameters:

Task cheese_bands parameters:

Task clean parameters: none

Task comb parameters:

Task conv_reg parameters:

Task espfilt parameters:

Task make_mask parameters:

Task make_mask_merge parameters:

Task merge_comp_xmm parameters:

Task merge_source_list parameters:

Task mos_back parameters:

Task mos-filter parameters: None

Task mos-spectra parameters:

Task pn_back parameters:

Task pn-filter parameters: None

Task pn-spectra parameters:

Task point_source parameters:

Task proton parameters:

Task proton_scale parameters:

Task rot_det_sky parameters:

Task rotimdetsky parameters:

Task sp_partial parameters:

Task swcx parameters:

Parameter	Mand	Type	Default	Constraints
smoothingcounts	yes	int	50
The number of counts to accumulate for the smoothing
thresholdmasking	yes	real	0.02
The scale factor for excluding regions from the smoothing based on a mask image. In the default mode the average exposure is calculated and then any pixel with exposure less than fraction*average value is excluded.
detector	yes	int		0|1
Detector, 1 for a specific instrument and exposure, 0 for the combined image (i.e., the output of comb).
elow	yes	int	400
The low energy for the band in eV
ehigh	yes	int	1250
The high energy for the band in eV
binning	yes	int	1
Binning control with 1 for no binning, and integers greater than 1 for binning that number of pixels in each dimension.
withpartcontrol	yes	bool	yes
Particle background control, "yes" to subtract the model particle background image.
withsoftcontrol	yes	bool	no
Soft proton background control, "yes" to subtract the soft proton background image.
withswcxcontrol	yes	bool	no
Solar wind charge exchange background control, "yes" to subtract the SWCX background image.
withmaskcontrol	yes	bool	no
Control for including an additional masking image.
maskfile	yes	dataset
The file name for an image to provide additional masking if desired. If left blank then there will be no additional masking. The mask images must be the same size and projection as the other images.
prefix	yes	string	1S001
Prefix defining the exposure used, with the esas nomenclature, eg. S003 means PN S003 exposure, while 1S002 and 2S003 mean MOS1 S002 and MOS2 S003 exposures, respectively.
clobber	no	boolean	yes	T/F
Clobber existing files?
smoothingcounts	yes	int	100
The number of counts to accumulate for the smoothing
thresholdmasking	yes	real	0.02
The scale factor for excluding regions from the smoothing based on a mask image. In the default mode the average exposure is calculated and then any pixel with exposure less than fraction*average value is excluded.
elowlist	yes	int	400 750
Low energy for successive bands in eV
ehighlist	yes	int	750 1250
High energy for successive bands in eV
binning	yes	int	1
Binning control, number of pixels (in both dimensions) to be binned.
withpartcontrol	yes	bool	yes
Particle background control, "yes" to subtract the model particle background image.
withsoftcontrol	yes	bool	no
Soft proton background control, "yes" to subtract the soft proton background image.
withswcxcontrol	yes	bool	no
Solar wind charge exchange background control, "yes" to subtract the SWCX background image.
withoffsetbkgcontrol	yes	bool	yes
Offset background control, "yes" to subtract the offset background image. This is a feature currently under development and is not yet functional.
withmaskcontrol	yes	bool	yes
Mask control, "yes" for using a mask image (pixel with 1 in image will be included, pixel with 0 will be excluded).
mask	yes	dataset	mask.fit
Mask image file name.
fill	yes	int	1
Number of passes to fill in empty pixels. If a zero pixel has three or more non-zero neighbors, the pixel will be the average value of those neighbors.
clobber	no	boolean	yes	T/F
Clobber existing files?
thresholdmasking	yes	real	0.02
The scale factor for excluding regions from the smoothing based on a mask image. In the default mode the average exposure is calculated and then any pixel with exposure less than fraction*average value is excluded.
detector	yes	int
Detector selection, 0: combined exposures, 1: MOS, 2: PN.
prefix	yes	string	1S001
Prefix defining the exposure used, with the esas nomenclature, eg. S003 means PN S003 exposure, while 1S002 and 2S003 mean MOS1 S002 and MOS2 S003 exposures, respectively.
elow	yes	int	400
Low energy for band in eV
ehigh	yes	int	1250
High energy for band in eV
binning	yes	int	1
Binning control with 1 for no binning, other integers for binning.
withpartcontrol	yes	bool	yes
Particle background control, "yes" to subtract the model particle background image.
withsoftcontrol	yes	bool	no
Soft proton background control, "yes" to subtract the soft proton background image.
withswcxcontrol	yes	bool	no
Solar wind charge exchange background control, "yes" to subtract the SWCX background image.
withmaskcontrol	yes	bool	no
Solar wind charge exchange background control, "yes" to subtract the SWCX background image.
mask	yes	dataset	mask.fit
Mask image file name (defaults to using exposure mask).
clobber	no	boolean	yes	T/F
Clobber existing files?
thresholdmasking	yes	real	0.02
The scale factor for excluding regions from the smoothing based on a mask image. In the default mode the average exposure is calculated and then any pixel with exposure less than fraction*average value is excluded.
elowlist	yes	int	350 800
Low energy for successive bands in eV
ehighlist	yes	int	800 1300
High energy for successive bands in eV
binning	yes	int	1
Binning control with 1 for no binning, 2,4,8,16,32 for binning by 2, 4,8,16,32.
withpartcontrol	yes	bool	yes
Particle background control, "yes" to subtract the model particle background image.
withsoftcontrol	yes	bool	yes
Soft proton background control, "yes" to subtract the soft proton background image.
withswcxcontrol	yes	bool	yes
Solar wind charge exchange background control, "yes" to subtract the swcx background image.
withmaskcontrol	yes	bool	yes
For masking with an additional image.
mask	yes	dataset	mask.fit
Mask image file name.
clobber	no	boolean	yes	T/F
Clobber existing files?
prefixm	yes	string
Detector and exposure identifiers (eg. "1S001 2S002") for the MOS exposures (in the example MOS1 S001 and MOS2 S002) to be processed.
prefixp	yes	string
Detector and exposure identifiers (eg. "S003") for the PN exposures (in the example PN S003) to be processed.
verb	yes	int	4
SAS verbosity level.
scale	yes	real	0.5
Energy fraction, which sets the exclusion radius of point sources.
rate	yes	real	1.0
Flux threshold (in units of $1.0E-14 cgs$ for the exclusion of point sources.
dist	yes	real
Minimum separation in arc seconds between masked sources.
elow	yes	int	400
The low energy for the band in eV
ehigh	yes	int	1250
The high energy for the band in eV
clobber	no	boolean	yes	T/F
Clobber existing files?
prefixm	yes	string
Detector and exposure identifiers (eg. "1S001 2S002") for the MOS exposures (in the example MOS1 S001 and MOS2 S002) to be processed.
prefixp	yes	string
Detector and exposure identifiers (eg. "S003") for the PN exposures (in the example PN S003) to be processed.
verb	yes	int	4
SAS verbosity level.
scale	yes	real	0.5
Energy fraction, which sets the exclusion radius of point sources.
ratet	no	real	1.0
Total flux threshold for exclusion of pt srcs
rates	no	real	1.0
Soft flux threshold for exclusion of pt srcs
rateh	no	real	1.0
Hard flux threshold for exclusion of pt srcs
dist	no	real
Minimum separation in arc seconds between masked sources
elowlist	yes	int	400 2000
Lower energy limit list for the energy bands in eV
ehighlist	yes	int	1300 7200
Higher energy limit list for the energy bands in eV
clobber	no	boolean	yes	T/F
Clobber existing files?
caldb	yes	string
Directory containing all the ESAS specific calibration files
withpartcontrol	yes	boolean	true
Particle background flag, 'true' to include it.
withsoftcontrol	yes	boolean	true
Soft proton background flag, 'true' to include it.
withswcxcontrol	yes	boolean	true
SWCX background flag, 'true' to include it.
alpha	yes	real	1.7
Assumed spectral index for the filter correction scaling.
elowlist	yes	int	400 750
Energy low limit(s) (in eV) for the different bands.
ehighlist	yes	int	750 1250
Energy high limit(s) (in eV) for the different bands.
mask	yes	int
Masking control. 0: No additional masking, 1: uses the mask produced by the cheese task, 2: uses the normal mask images produced by eexpmap, and 3: uses the normal mask images produced by eexpmap modified by make-mask.
prefixlist	yes	string	1S001 2S002 S003
Exposure identifiers (eg. "1S001 2S002 S003") for the exposures (in the example MOS1 S001, MOS2 2S002, and PN S003) to be processed.
clobber	no	boolean	yes	T/F
Clobber existing files?
detector	yes	string
The instrument identifier (EMOS1, EMOS2, or PN).
mode	yes	int
conv_reg operational mode: mode=1 - region fits files are both input and output mode=2 - ascii files with region parameters are both input and output mode=3 - command line input of individual region parameters and screen output
imagefile	yes	string
Filename image in sky coordinates - used to extract observation position angle.
ra	no	real		none
mode=3 RA input
dec	no	real		none
mode=3 Dec input
shape	no	real		none
mode=3 region shape input, only circle and ellipse at this time (either all upper or all lower case, along with their “nots”, e.g., “!ELLIPSE”)
radius	no	real		none
mode=3 radius for circular region input
semimajor	no	real		none
mode=3 semimajor axis (in arc minutes) for elliptical region input
semiminor	no	real		none
mode=3 semiminor axis (in arc minutes) for elliptical region input
rotangle	no	real		none
mode=3 rotation angle (in degrees) for elliptical region input
inputfile	no	string
mode=1,2 input file name
outputfile	no	string
mode=1,2 input file name
eventset	no	string		none
list of event files
method	no	string		corner
which method to use.
withsmoothing	no	boolean	N	Y/N
Smooth data?
smooth	no	integer	50	$>$ 1
Smoothing factor in seconds
withbinning	no	boolean	N	Y/N
Bin data?
binning	no	integer	50	$>$ 1
Bin width in seconds
withspecranges	no	boolean	N	Y/N
Use upper/lower spec chans?
specchanmin	no	integer	2500	$>$ 1 ev, $<$ 32766
Low Spectral Channel
specchanmax	no	integer	12000	$>$ 2 ev, $<$ 32767
High Spectral Channel
ratio	no	real	1.2	$>$ 0.01, $<$ 10.0
Flaring ratio of annulus_cnts corn_area corn_cnst annu_area
clobber	no	boolean	yes	T/F
Clobber existing files?
inimage	no	string	inimage.fit
Event image for the exposure
inmask	no	string	inmask.fit
Exposure mask
outmask	no	string	outmask.fit
The output file name for the cheese mask
reglist	no	string	reglist.fit
The filtered source region list.
clobber	no	boolean	yes	T/F
Clobber existing files?
srclist	yes	string	merged-source-list.fits
Merged source list from merge_source_list
prefix	yes	string	1S001
Exposure identfier.
inmask	yes	string	mos1S001-mask-im-750-1250.fits
Input mask file name.
flimtot	yes	real
Combined band source flux threshold ($10^{-14}$ cgs).
flimsoft	yes	real
Soft band source flux threshold ($10^{-14}$ cgs).
flimhard	yes	real
Hard band source flux threshold ($10^{-14}$ cgs).
scale	yes	real
Scale factor for W90 radius.
seper	yes	real
Minimum allowed source separation in arc second.
maxlikelim	yes	real
Minimum accepted value for the maximum likelihood detetion parameter.
clobber	no	boolean	yes	T/F
Clobber existing files?
caldb	yes	string
Directory containing all the ESAS specific calibration files
dirfile	yes	string	mydir
File containing the list of exposures, including the directory string, for data to be merged. For instance, if the merging processing is being done in the directory /DATA/merge and the individual observations are located in the parallel directories /DATA/obs1/proc and /DATA/obs2/proc, the file dirlist could have entries such as: /DATA/obs1/proc/mos1S001 /DATA/obs1/proc/mos2S002 /DATA/obs1/proc/pnS003 /DATA/obs2/proc/mos1S001 /DATA/obs2/proc/mos2S002 /DATA/obs2/proc/pnS003
coord	yes	int	1
Selects which coordinate system should be used, 1: ecliptic, 2: equatorial, 3: galactic.
crvaln1	yes	real
Central longitude of the projection.
crvaln2	yes	real
Central latitude of the projection.
pixelsize	yes	real
Pixel size of the projection in decimal degrees.
component	yes	int	1
Component to be cast, 1: count image, 2: exposure, 3: QPB counts, 4: SP counts..
alpha	yes	real	1.7
Assumed spectral index for the filter correction scaling.
elow	yes	int	400
Energy low limit (in eV) for the band.
ehigh	yes	int	1250
Energy high limit (in eV) for the band.
maskcontrol	yes	int	1
Mask control, 0: no masking, 1: point source masking using the output from cheese, 2: good area masking using the masks produced by mos-spectra, 3: mask from merged source list output from make_mask_merge.
xdim	yes	int	2000
X dimension of the output image
ydim	yes	int	2000
Y dimension of the output image
clobber	no	boolean	yes	T/F
Clobber existing files?
dirfile	yes	string	mydir
File containing the list of ObsID directory strings for source lists to be merged. For instance, if the merging processing is being done in the directory /DATA/merge and the individual observations are located in the parallel directories /DATA/obs1/proc and /DATA/obs2/proc, the file dirlist could have entries such as: /DATA/obs1/proc/ /DATA/obs2/proc/
maxlikelim	yes	real
Minimum accepted value for the maximum likelihood detetion parameter.
clobber	no	boolean	yes	T/F
Clobber existing files?
prefix	yes	string	S003
Detector and exposure identifier,(e.g., 1S001 for MOS1 S001 exposure).
caldb	yes	string
Directory containing all the ESAS specific calibration files
diag	yes	int	1
Controls the amount of diagnostic output (0 low, 1 medium, 2 high)
elow	yes	int	400
Energy low limit (in eV) for the band.
ehigh	yes	int	1250
Energy high limit (in eV) for the band.
ccd[1-7]	yes	int	1
Selects which ccd's should be included.
clobber	no	boolean	yes	T/F
Clobber existing files?
prefix	yes	string	1S001
Detector and exposure identifier (eg. "1S001") for MOS1 S001 exposure to be processed.
caldb	yes	string
Directory containing all the ESAS specific calibration files
region	yes	int	reg.txt
the selection expression for the desired region for the generation of the model background spectrum. If no file with the input name exists, or if the file is empty, then the default is to model the data from the entire field of view. If a specific region is desired, the region expression must be in detector coordinates. For example, a file containing &&((DETX,DETY) IN circle(201,-219,3600)) would extract the central $3'$ of the cluster Abell 1795. Note that the leading “&&” are required as the selection expression is added to other constraints.
mask	yes	int
Flag to mask out point sources. 0 selects no masking while 1 will cause mos-spectra to use the output filtered source region file from cheese or cheese-bands.
elow	yes	int	400
Energy low limit (in eV) for the band. If elow and ehigh are set to 0, the image processing will be eliminated and only spectral files will be produced.
ehigh	yes	int	1250
Energy high limit (in eV) for the band. If elow and ehigh are set to 0, the image processing will be eliminated and only spectral files will be produced.
ccd1-7	yes	int	1
Flag to include individual CCDs. 1 to include, 0 to not.
prefix	yes	string	S003
Detector and exposure identifier,(e.g., S003 exposure).
caldb	yes	string
Directory containing all the ESAS specific calibration files
diag	yes	int	1
Controls the amount of diagnostic output (0 low, 1 medium, 2 high)
elow	yes	int	400
Energy low limit (in eV) for the band.
ehigh	yes	int	1250
Energy high limit (in eV) for the band.
quad[1-4]	yes	int	1
Selects which PN quadrants should be included.
clobber	no	boolean	yes	T/F
Clobber existing files?
prefix	yes	string	1S001
Detector and exposure identifier (eg. "S001") for the PN S001 exposure to be processed.
caldb	yes	string
Directory containing all the ESAS specific calibration files
region	yes	int	reg.txt
the selection expression for the desired region for the generation of the model background spectrum. If no file with the input name exists, or if the file is empty, then the default is to model the data from the entire field of view. If a specific region is desired, the region expression must be in detector coordinates. For example, a file containing &&((DETX,DETY) IN circle(201,-219,3600)) would extract the central $3'$ of the cluster Abell 1795. Note that the leading “&&” are required as the selection expression is added to other constraints.
mask	yes	int
Flag to mask out point sources. 0 selects no masking while 1 will cause pn-spectra to use the output filtered source region file from cheese-bands.
elow	yes	int	2000
Energy low limit (in eV) for the band. If elow and ehigh are set to 0, the image processing will be eliminated and only spectral files will be produced.
ehigh	yes	int	7200
Energy high limit (in eV) for the band. If elow and ehigh are set to 0, the image processing will be eliminated and only spectral files will be produced.
quad1-4	yes	int	1
Flag to include individual quadrants.
func	yes	string	mateos
Name of logN-logS function. hms (Hasinger, Miyaji, & Schmidt 2005) mushotzky (REF TBD) cappelluti (Cappelluti et al. 2008) mateos (Mateos et al. 2008)
min_src_flux	yes	real	1.0e-14
Source flux cutoff in erg/cm2/s.
cxrb_norm	yes	real	10.6
Normalization of the cosmic X-ray background.
index	yes	real	1.46
Photon power law index.
prefix	yes	string
Detector and exposure identifiers (eg. "1S001") for the MOS exposure S001) to be processed.
caldb	yes	string
Directory containing all the ESAS specific calibration files
ccd[1-7]	yes	string	1
Flag to include (1) or not (0) a CCD.
elow	yes	int	400
The low energy for the band in eV
ehigh	yes	int	1250
The high energy for the band in eV
spectrumcontrol	yes	int	1
1 for a power law model, 2 for a broken power law
pindex	no	unknown
Fitted power law index, only if spectrumcontrol=1
pnorm	no	unknown
Scale factor for power law index, only if spectrumcontrol=1
binds	no	unknown
Fitted soft broken power law index, only if spectrumcontrol=2
bbreak	no	unknown
Break energy for broken power law model, only if spectrumcontrol=2
bindh	no	unknown
Fitted hard broken power law index, only if spectrumcontrol=2
bnorm	no	unknown
Normalization for broken power law, only if spectrumcontrol=2
clobber	no	boolean	yes	T/F
Clobber existing files?
caldb	yes	string
Directory containing all the ESAS specific calibration files
mode	yes	int	1
mode - 1: do a single region, 2: do multiple regions with the required input provided in a text file (parameter spfile).
det	yes	int	1	1|2|3
FOR MODE=1 - Detector, 1 for MOS1, 2 for MOS2, and3 for PN
maskfile	yes	string	region
FOR MODE=1 - File name for the mask file. This is the mosprefix-obj-im-sp-det.fits file produced for the region by mos-spectra.
specfile	yes	string	specfile
FOR MODE=1 - File name for the spectral file for the region.
spfile	yes	string
FOR MODE=2 - ASCII text file with the input for multiple regions. The file should contain, on separate lines, the detector number (det), mask file name (mask), and spectral file name (spec) for each region.
mode	yes	int	1
Selection on particle (1), soft proton (2), SWCX (3) backgrounds, (4) MASK, (5) MASKIT.
prefix	yes	string	1S001
Detector and exposure identifiers (eg. "1S001") for the MOS exposure S001) to be processed.
elow	yes	int	350
The low energy for the band in eV
ehigh	yes	int	800
The high energy for the band in eV
detx	yes	int
The DETX reference pixel location
dety	yes	int
The DETY reference pixel location
skyx	yes	int
The X location of the reference pixel
skyy	yes	int
The Y location of the reference pixel location
maskfile	yes	string
The file name for an image to provide additional masking if desired. If left blank then there will be no additional masking. The mask images must be the same size and projection of the other images.
clobber	no	boolean	yes	T/F
Clobber existing files?
prefix	yes	string	1S001
Detector and exposure identifiers (eg. "1S001") for the MOS exposure S001) to be processed.
mask	yes	string	none
The file name for an image to provide additional masking if desired. If left blank then there will be no additional masking. The mask images must be the same size and projection of the other images.
elow	yes	int	400
The low energy for the band in eV
ehigh	yes	int	1250
The high energy for the band in eV
mode	yes	int	1
Selection on particle (1), soft proton (2), SWCX (3) backgrounds, (4) MASK, (5) MASKIT.
clobber	no	boolean	yes	T/F
Clobber existing files?
caldb	yes	string	1S001
Directory containing the ESAS calibration files.
detector	yes	int	1
Detector to be processed 1-MOS1, 2-MOS2, and 3-PN.
fullimage	yes	string	mos1S001-sp-ps.fits
Image from the full field of view.
fullspec	yes	string	mos1S001-obj-ps.pi
Spectrum from the full field of view.
regionimage	yes	string	mos1S001-sp-nps.fits
Image from the selected region.
regionspec	yes	string	mos1S001-obj-nps.pi
Spectrum from the selected region.
rnorm	yes	real	0.05
Xspec normalization of the SP component.
prefix	yes	string
Detector and exposure identifiers (eg. "1S001") for the MOS exposure S001) to be processed.
caldb	yes	string
Directory containing all the ESAS specific calibration files
ccd[1-7]	yes	string	1
Flag to include (1) or not (0) a CCD.
elow	yes	int	400
The low energy for the band in eV
ehigh	yes	int	1300
The high energy for the band in eV
elinelist	yes	unknown	1 2
Energies of SWCX lines to be included
gnormlist	yes	unknown	0.1 0.03
Gaussian normalizations from Xspec
objrmf	yes	string
RMF for the region
objarf	yes	string
ARF for the region
objspec	yes	string
Spectrum for the region
clobber	no	boolean	yes	T/F
Clobber existing files?
Parameter	Mand	Type	Default	Constraints