XMM-Newton SAS Home Page
XMM-Newton Science Analysis System


esas (esas-0.11.4) [xmmsas_20211130_0941-20.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:
  • ParameterMand Type Default Constraints
    smoothingcountsyesint50 
    The number of counts to accumulate for the smoothing
     
    thresholdmaskingyesreal0.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.
     
    detectoryesint 0|1
    Detector, 1 for a specific instrument and exposure, 0 for the combined image (i.e., the output of comb).
     
    elowyesint400 
    The low energy for the band in eV
     
    ehighyesint1250 
    The high energy for the band in eV
     
    binningyesint1 
    Binning control with 1 for no binning, and integers greater than 1 for binning that number of pixels in each dimension.
     
    withpartcontrolyesboolyes 
    Particle background control, "yes" to subtract the model particle background image.
     
    withsoftcontrolyesboolno 
    Soft proton background control, "yes" to subtract the soft proton background image.
     
    withswcxcontrolyesboolno 
    Solar wind charge exchange background control, "yes" to subtract the SWCX background image.
     
    withmaskcontrolyesboolno 
    Control for including an additional masking image.
     
    maskfileyesdataset  
    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.
     
    prefixyesstring1S001 
    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.
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    smoothingcountsyesint100 
    The number of counts to accumulate for the smoothing
     
    thresholdmaskingyesreal0.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.
     
    elowlistyesint400 750 
    Low energy for successive bands in eV
     
    ehighlistyesint750 1250 
    High energy for successive bands in eV
     
    binningyesint1 
    Binning control, number of pixels (in both dimensions) to be binned.
     
    withpartcontrolyesboolyes 
    Particle background control, "yes" to subtract the model particle background image.
     
    withsoftcontrolyesboolno 
    Soft proton background control, "yes" to subtract the soft proton background image.
     
    withswcxcontrolyesboolno 
    Solar wind charge exchange background control, "yes" to subtract the SWCX background image.
     
    withoffsetbkgcontrolyesboolyes 
    Offset background control, "yes" to subtract the offset background image. This is a feature currently under development and is not yet functional.
     
    withmaskcontrolyesboolyes 
    Mask control, "yes" for using a mask image (pixel with 1 in image will be included, pixel with 0 will be excluded).
     
    maskyesdatasetmask.fit 
    Mask image file name.
     
    fillyesint1 
    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.
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    thresholdmaskingyesreal0.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.
     
    detectoryesint  
    Detector selection, 0: combined exposures, 1: MOS, 2: PN.
     
    prefixyesstring1S001 
    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.
     
    elowyesint400 
    Low energy for band in eV
     
    ehighyesint1250 
    High energy for band in eV
     
    binningyesint1 
    Binning control with 1 for no binning, other integers for binning.
     
    withpartcontrolyesboolyes 
    Particle background control, "yes" to subtract the model particle background image.
     
    withsoftcontrolyesboolno 
    Soft proton background control, "yes" to subtract the soft proton background image.
     
    withswcxcontrolyesboolno 
    Solar wind charge exchange background control, "yes" to subtract the SWCX background image.
     
    withmaskcontrolyesboolno 
    Solar wind charge exchange background control, "yes" to subtract the SWCX background image.
     
    maskyesdatasetmask.fit 
    Mask image file name (defaults to using exposure mask).
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    thresholdmaskingyesreal0.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.
     
    elowlistyesint350 800 
    Low energy for successive bands in eV
     
    ehighlistyesint800 1300 
    High energy for successive bands in eV
     
    binningyesint1 
    Binning control with 1 for no binning, 2,4,8,16,32 for binning by 2, 4,8,16,32.
     
    withpartcontrolyesboolyes 
    Particle background control, "yes" to subtract the model particle background image.
     
    withsoftcontrolyesboolyes 
    Soft proton background control, "yes" to subtract the soft proton background image.
     
    withswcxcontrolyesboolyes 
    Solar wind charge exchange background control, "yes" to subtract the swcx background image.
     
    withmaskcontrolyesboolyes 
    For masking with an additional image.
     
    maskyesdatasetmask.fit 
    Mask image file name.
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    prefixmyesstring  
    Detector and exposure identifiers (eg. "1S001 2S002") for the MOS exposures (in the example MOS1 S001 and MOS2 S002) to be processed.
     
    prefixpyesstring  
    Detector and exposure identifiers (eg. "S003") for the PN exposures (in the example PN S003) to be processed.
     
    verbyesint4 
    SAS verbosity level.
     
    scaleyesreal0.5 
    Energy fraction, which sets the exclusion radius of point sources.
     
    rateyesreal1.0 
    Flux threshold (in units of $1.0E-14 cgs$ for the exclusion of point sources.
     
    distyesreal  
    Minimum separation in arc seconds between masked sources.
     
    elowyesint400 
    The low energy for the band in eV
     
    ehighyesint1250 
    The high energy for the band in eV
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    prefixmyesstring  
    Detector and exposure identifiers (eg. "1S001 2S002") for the MOS exposures (in the example MOS1 S001 and MOS2 S002) to be processed.
     
    prefixpyesstring  
    Detector and exposure identifiers (eg. "S003") for the PN exposures (in the example PN S003) to be processed.
     
    verbyesint4 
    SAS verbosity level.
     
    scaleyesreal0.5 
    Energy fraction, which sets the exclusion radius of point sources.
     
    ratetnoreal1.0 
    Total flux threshold for exclusion of pt srcs
     
    ratesnoreal1.0 
    Soft flux threshold for exclusion of pt srcs
     
    ratehnoreal1.0 
    Hard flux threshold for exclusion of pt srcs
     
    distnoreal  
    Minimum separation in arc seconds between masked sources
     
    elowlistyesint400 2000 
    Lower energy limit list for the energy bands in eV
     
    ehighlistyesint1300 7200 
    Higher energy limit list for the energy bands in eV
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    caldbyesstring  
    Directory containing all the ESAS specific calibration files
     
    withpartcontrolyesbooleantrue 
    Particle background flag, 'true' to include it.
     
    withsoftcontrolyesbooleantrue 
    Soft proton background flag, 'true' to include it.
     
    withswcxcontrolyesbooleantrue 
    SWCX background flag, 'true' to include it.
     
    alphayesreal1.7 
    Assumed spectral index for the filter correction scaling.
     
    elowlistyesint400 750 
    Energy low limit(s) (in eV) for the different bands.
     
    ehighlistyesint750 1250 
    Energy high limit(s) (in eV) for the different bands.
     
    maskyesint  
    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.
     
    prefixlistyesstring1S001 2S002 S003 
    Exposure identifiers (eg. "1S001 2S002 S003") for the exposures (in the example MOS1 S001, MOS2 2S002, and PN S003) to be processed.
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    detectoryesstring  
    The instrument identifier (EMOS1, EMOS2, or PN).
     
    modeyesint  
    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
     
    imagefileyesstring  
    Filename image in sky coordinates – used to extract observation position angle.
     
    ranoreal none
    mode=3 RA input
     
    decnoreal none
    mode=3 Dec input
     
    shapenoreal 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”)
     
    radiusnoreal none
    mode=3 radius for circular region input
     
    semimajornoreal none
    mode=3 semimajor axis (in arc minutes) for elliptical region input
     
    semiminornoreal none
    mode=3 semiminor axis (in arc minutes) for elliptical region input
     
    rotanglenoreal none
    mode=3 rotation angle (in degrees) for elliptical region input
     
    inputfilenostring  
    mode=1,2 input file name
     
    outputfilenostring  
    mode=1,2 input file name
     
    eventsetnostring none
    list of event files
     
    methodnostring corner
    which method to use.
     
    withsmoothingnobooleanNY/N
    Smooth data?
     
    smoothnointeger50$>$ 1
    Smoothing factor in seconds
     
    withbinningnobooleanNY/N
    Bin data?
     
    binningnointeger50$>$ 1
    Bin width in seconds
     
    withspecrangesnobooleanNY/N
    Use upper/lower spec chans?
     
    specchanminnointeger2500$>$ 1 ev, $<$ 32766
    Low Spectral Channel
     
    specchanmaxnointeger12000$>$ 2 ev, $<$ 32767
    High Spectral Channel
     
    rationoreal1.2$>$ 0.01, $<$ 10.0
    Flaring ratio of annulus_cnts corn_area corn_cnst annu_area
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    inimagenostringinimage.fit 
    Event image for the exposure
     
    inmasknostringinmask.fit 
    Exposure mask
     
    outmasknostringoutmask.fit 
    The output file name for the cheese mask
     
    reglistnostringreglist.fit 
    The filtered source region list.
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    srclistyesstringmerged-source-list.fits 
    Merged source list from merge_source_list
     
    prefixyesstring1S001 
    Exposure identfier.
     
    inmaskyesstringmos1S001-mask-im-750-1250.fits 
    Input mask file name.
     
    flimtotyesreal  
    Combined band source flux threshold ($10^{-14}$ cgs).
     
    flimsoftyesreal  
    Soft band source flux threshold ($10^{-14}$ cgs).
     
    flimhardyesreal  
    Hard band source flux threshold ($10^{-14}$ cgs).
     
    scaleyesreal  
    Scale factor for W90 radius.
     
    seperyesreal  
    Minimum allowed source separation in arc second.
     
    maxlikelimyesreal  
    Minimum accepted value for the maximum likelihood detetion parameter.
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    caldbyesstring  
    Directory containing all the ESAS specific calibration files
     
    dirfileyesstringmydir 
    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

     
    coordyesint1 
    Selects which coordinate system should be used, 1: ecliptic, 2: equatorial, 3: galactic.
     
    crvaln1yesreal  
    Central longitude of the projection.
     
    crvaln2yesreal  
    Central latitude of the projection.
     
    pixelsizeyesreal  
    Pixel size of the projection in decimal degrees.
     
    componentyesint1 
    Component to be cast, 1: count image, 2: exposure, 3: QPB counts, 4: SP counts..
     
    alphayesreal1.7 
    Assumed spectral index for the filter correction scaling.
     
    elowyesint400 
    Energy low limit (in eV) for the band.
     
    ehighyesint1250 
    Energy high limit (in eV) for the band.
     
    maskcontrolyesint1 
    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.
     
    xdimyesint2000 
    X dimension of the output image
     
    ydimyesint2000 
    Y dimension of the output image
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    dirfileyesstringmydir 
    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/

     
    maxlikelimyesreal  
    Minimum accepted value for the maximum likelihood detetion parameter.
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    prefixyesstringS003 
    Detector and exposure identifier,(e.g., 1S001 for MOS1 S001 exposure).
     
    caldbyesstring  
    Directory containing all the ESAS specific calibration files
     
    diagyesint1 
    Controls the amount of diagnostic output (0 low, 1 medium, 2 high)
     
    elowyesint400 
    Energy low limit (in eV) for the band.
     
    ehighyesint1250 
    Energy high limit (in eV) for the band.
     
    ccd[1-7]yesint1 
    Selects which ccd's should be included.
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    prefixyesstring1S001 
    Detector and exposure identifier (eg. "1S001") for MOS1 S001 exposure to be processed.
     
    caldbyesstring  
    Directory containing all the ESAS specific calibration files
     
    regionyesintreg.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.
     
    maskyesint  
    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.
     
    elowyesint400 
    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.
     
    ehighyesint1250 
    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-7yesint1 
    Flag to include individual CCDs. 1 to include, 0 to not.
     
    prefixyesstringS003 
    Detector and exposure identifier,(e.g., S003 exposure).
     
    caldbyesstring  
    Directory containing all the ESAS specific calibration files
     
    diagyesint1 
    Controls the amount of diagnostic output (0 low, 1 medium, 2 high)
     
    elowyesint400 
    Energy low limit (in eV) for the band.
     
    ehighyesint1250 
    Energy high limit (in eV) for the band.
     
    quad[1-4]yesint1 
    Selects which PN quadrants should be included.
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    prefixyesstring1S001 
    Detector and exposure identifier (eg. "S001") for the PN S001 exposure to be processed.
     
    caldbyesstring  
    Directory containing all the ESAS specific calibration files
     
    regionyesintreg.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.
     
    maskyesint  
    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.
     
    elowyesint2000 
    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.
     
    ehighyesint7200 
    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-4yesint1 
    Flag to include individual quadrants.
     
    funcyesstringmateos 
    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_fluxyesreal1.0e-14 
    Source flux cutoff in erg/cm2/s.
     
    cxrb_normyesreal10.6 
    Normalization of the cosmic X-ray background.
     
    indexyesreal1.46 
    Photon power law index.
     
    prefixyesstring  
    Detector and exposure identifiers (eg. "1S001") for the MOS exposure S001) to be processed.
     
    caldbyesstring  
    Directory containing all the ESAS specific calibration files
     
    ccd[1-7]yesstring1 
    Flag to include (1) or not (0) a CCD.
     
    elowyesint400 
    The low energy for the band in eV
     
    ehighyesint1250 
    The high energy for the band in eV
     
    spectrumcontrolyesint1 
    1 for a power law model, 2 for a broken power law
     
    pindexnounknown  
    Fitted power law index, only if spectrumcontrol=1
     
    pnormnounknown  
    Scale factor for power law index, only if spectrumcontrol=1
     
    bindsnounknown  
    Fitted soft broken power law index, only if spectrumcontrol=2
     
    bbreaknounknown  
    Break energy for broken power law model, only if spectrumcontrol=2
     
    bindhnounknown  
    Fitted hard broken power law index, only if spectrumcontrol=2
     
    bnormnounknown  
    Normalization for broken power law, only if spectrumcontrol=2
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    caldbyesstring  
    Directory containing all the ESAS specific calibration files
     
    modeyesint1 
    mode – 1: do a single region, 2: do multiple regions with the required input provided in a text file (parameter spfile).
     
    detyesint11|2|3
    FOR MODE=1 - Detector, 1 for MOS1, 2 for MOS2, and3 for PN
     
    maskfileyesstringregion 
    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.
     
    specfileyesstringspecfile 
    FOR MODE=1 - File name for the spectral file for the region.
     
    spfileyesstring  
    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.
     
    modeyesint1 
    Selection on particle (1), soft proton (2), SWCX (3) backgrounds, (4) MASK, (5) MASKIT.
     
    prefixyesstring1S001 
    Detector and exposure identifiers (eg. "1S001") for the MOS exposure S001) to be processed.
     
    elowyesint350 
    The low energy for the band in eV
     
    ehighyesint800 
    The high energy for the band in eV
     
    detxyesint  
    The DETX reference pixel location
     
    detyyesint  
    The DETY reference pixel location
     
    skyxyesint  
    The X location of the reference pixel
     
    skyyyesint  
    The Y location of the reference pixel location
     
    maskfileyesstring  
    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.
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    prefixyesstring1S001 
    Detector and exposure identifiers (eg. "1S001") for the MOS exposure S001) to be processed.
     
    maskyesstringnone 
    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.
     
    elowyesint400 
    The low energy for the band in eV
     
    ehighyesint1250 
    The high energy for the band in eV
     
    modeyesint1 
    Selection on particle (1), soft proton (2), SWCX (3) backgrounds, (4) MASK, (5) MASKIT.
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    caldbyesstring1S001 
    Directory containing the ESAS calibration files.
     
    detectoryesint1 
    Detector to be processed 1-MOS1, 2-MOS2, and 3-PN.
     
    fullimageyesstringmos1S001-sp-ps.fits 
    Image from the full field of view.
     
    fullspecyesstringmos1S001-obj-ps.pi 
    Spectrum from the full field of view.
     
    regionimageyesstringmos1S001-sp-nps.fits 
    Image from the selected region.
     
    regionspecyesstringmos1S001-obj-nps.pi 
    Spectrum from the selected region.
     
    rnormyesreal0.05 
    Xspec normalization of the SP component.
     
    prefixyesstring  
    Detector and exposure identifiers (eg. "1S001") for the MOS exposure S001) to be processed.
     
    caldbyesstring  
    Directory containing all the ESAS specific calibration files
     
    ccd[1-7]yesstring1 
    Flag to include (1) or not (0) a CCD.
     
    elowyesint400 
    The low energy for the band in eV
     
    ehighyesint1300 
    The high energy for the band in eV
     
    elinelistyesunknown1 2 
    Energies of SWCX lines to be included
     
    gnormlistyesunknown0.1 0.03 
    Gaussian normalizations from Xspec
     
    objrmfyesstring  
    RMF for the region
     
    objarfyesstring  
    ARF for the region
     
    objspecyesstring  
    Spectrum for the region
     
    clobbernobooleanyesT/F
    Clobber existing files?
     
    ParameterMand Type Default Constraints

    XMM-Newton SOC -- 2021-11-30