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


eimageget (eimageget-0.8.1) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
evtfileyesstring  
Input event list from which the images will be created.
 
ootfilenostring  
Input out-of-time event list (only for EPIC-pn) from which the out-of-time images will be created.
 
fwcfilenostring  
Input filter-wheel-closed event list from which the filter-wheel-closed images will be created. Needed if withfwcimages is set to “yes” (default)
 
attfilenostring  
Input attitude file, needed if withexposure is set to “yes” (default) or if withattcalc is set to “yes”.
 
gtifilenostring  
Input good-time-interval file, if time selection will be done.
 
withemtaglenoisenobooleantruetrue$\mid$false
boolean to choose whether or not noisy EPIC-MOS CCDs will be identified by emtaglenoise and removed from the output images.
 
withbadpixupdatenobooleantruetrue$\mid$false
boolean to choose whether or not the bad-pixel extensions of all input event files will be conformed to each other.
 
withfwcimagesnobooleantruetrue$\mid$false
boolean to choose whether or not filter-wheel-closed images will be created.
 
withwindowmodenobooleanfalsetrue$\mid$false
This parameter allows to include data of CCDs operated in large/small window mode. Note that in this case no filter-wheel-closed images are created for the CCDs that are in window mode!
 
piminnointeger list'200 500 1000 2000 4500'0,20000
Lower energy boundary in PI channels
 
pimaxnointeger list'500 1000 2000 4500 12000'0,20000
Upper energy boundary in PI channels
 
patminnointeger list 0,12
Lower boundary for PATTERN selection
 
patmaxnointeger list 0,12
Upper boundary for PATTERN selection
 
flagnostring  
Flag to be used for the selection of the final images according to selectlib
 
flagoutnostring  
Flag to be used for the selection of events in the shielded detector areas according to selectlib
 
ximageminnoreal1 
evselect: If set, the lower limit of $x$ coordinate for image extraction.
 
ximagemaxnoreal640 
evselect: If set, the upper limit of $x$ coordinate for image extraction.
 
yimageminnoreal1 
evselect: If set, the lower limit of $y$ coordinate for image extraction.
 
yimagemaxnoreal640 
evselect: If set, the upper limit of $y$ coordinate for image extraction.
 
imagebinningnostring“imageSize”“imageSize”$\mid$“binSize”
evselect: Parameter to choose to use either bin size or total image size to determine the binning factor for image extraction. If set to “binSize”, values are taken from ximagebinsize and yimagebinsize. If set to “imageSize”, values are taken from ximagesize and yimagesize.
 
ximagebinsizenoreal1$>0$
evselect: If set, the binning factor for $x$ axis in image creation
 
yimagebinsizenoreal1$>0$
evselect: If set, the binning factor for $y$ axis in image creation
 
ximagesizenointeger600$>0$
evselect: If set, the size of the image (i.e. number of image pixels) along the $x$ axis; for extraction using integer valued columns, the extracted image size may be somewhat smaller than the requested image size.
 
yimagesizenointeger600$>0$
evselect: If set, the size of the image (i.e. number of image pixels) along the $y$ axis; for extraction using integer valued columns, the extracted image size may be somewhat smaller than the requested image size.
 
withxrangesnobooleanfalsetrue$\mid$false
evselect: boolean to choose whether or not to use the ximagemin and ximagemax values for the $x$ coordinate ranges for image extraction - if true, the parameter ranges are used; if false, the ranges are determined from the data
 
withyrangesnobooleanfalsetrue$\mid$false
evselect: boolean to choose whether or not to use the yimagemin and yimagemax values for the $y$ coordinate ranges for image extraction - if true, the parameter ranges are used; if false, the ranges are determined from the data
 
squarepixelsnobooleanfalsetrue$\mid$false
evselect: When ximagesize and yimagesize are set, forces the $x$ and $y$ bin sizes to be the same. The larger of the two bin sizes is used.
 
raimagecenternoreal  
evselect: If set, right ascension for the center of the output image, in decimal degrees.
 
decimagecenternoreal  
evselect: If set, declination for the center of the output image, in decimal degrees.
 
withcelestialcenternobooleanfalsetrue$\mid$false
evselect: Boolean to determine if the image is shifted so that it is centered on the sky position specified by raimagecenter and decimagecenter.
 
withattcalcnobooleanno 
boolean to choose whether or not to new image coordinates will be calculated according to nominalra, nominaldec, and imagesize
 
nominalranoreal0.00$-$360
attcalc: Celestial RA coordinate of central reference point (If withattcalc = yes)
 
nominaldecnoreal0.0-90$-$+90
attcalc: Celestial Dec coordinate of central reference point (If withattcalc = yes)
 
imagesizenoreal0.36 
attcalc: Half-size of final image (in degrees) (If withattcalc = yes)
 
withexposurenobooleantruetrue$\mid$false
boolean to choose whether or not exposure maps will be created with eexpmap.
 
withmasknobooleantruetrue$\mid$false
boolean to choose whether or not a mask will be created. (If withexposure = yes).
 
threshold1nofloat0.01 [0.0$<$param$<$1.0]
emask: Threshold parameter 1: fraction of maximum exposure. (If withmask = yes).
 
threshold2nofloat0.5 [0.0$<$param$<$10.0]
emask: Threshold parameter 2: threshold for gradient of exposure. (If withmask = yes).
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30