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


etruecolor (xcolorcod-1.30.1) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
tablelistyestable name of existing table
List of tables that contains the event data - need to at least contain the columns named with the xcolumn, ycolumn, ecolumn parameters.
 
colortablenostringRGB_Schemename of predefined color table
The energy bands for the pre-defined color table are explained in the text.
 
minnoreal300 
Explicit minimum value of ecolumn column. This value is used for filtering.
 
maxnoreal7000 
Explicit maximum value of ecolumn column. This value is used for filtering.
 
ximagebinsizenoreal80$>0$
passed to evselect as parameter ximagebinsize
 
withfiltertransmissionnobooleanyesyes/no
factor the filter's transmission into vignetting weight
 
withxrangesnobooleanfalsetrue$\mid$false
passed to evselect as parameter withxranges
 
ximageminnoreal1$>0$
passed to evselect as parameter ximagemin
 
ximagemaxnoreal600$>0$
passed to evselect as parameter ximagemax
 
yimagebinsizenoreal80$>0$
passed to evselect as parameter yimagebinsize
 
withyrangesnobooleanfalsetrue$\mid$false
passed to evselect as parameter withyranges
 
yimageminnoreal1$>0$
passed to evselect as parameter yimagemin
 
yimagemaxnoreal600$>0$
passed to evselect as parameter yimagemax
 
scalminnoreal2.25 
Min value for log scaling (counts/ks/arcmin$^2$).
 
scalmaxnoreal675 
Max value for log scaling (counts/ks/arcmin$^2$)
 
filesetnostringdefaultname of output data set
The name of the data set the color images as count rates. This file is a RGB cube ready to be displayed with Ds9. Leaving the default value, etruecolor task creates the following file name: PppppppooeeEPX000RGBIMA0000.FIT, where ppppppooee is the extended observation Id.
 
outputchoicenostringppmfiledataset$\mid$ppmfile
If set to dataset image is written to a data set whose name is given via parameter colorset. Otherwise, image is written in PPM format to standard file named via ppmfile.
 
colorsetnostringdefaultname of data set
The name of the data set the color image shall be written to if outputchoice=dataset. Depending on the value of ascube the data will either be written to three separate arrays corresponding to the red, green, and blue components or three slices of a 3-D data cube in the primary array, respectively. The data set can be read and the contents displayed with Ds9. Leaving the default value, etruecolor task creates the following file name: PppppppooeeEPX000RGBCOL0000.FIT, where ppppppooee is the extended observation Id.
 
ppmfilenostringdefaultname of file
If outputchoice=ppmfile the name of a PPM data file that the color image shall be written to. If ppmfile=stdout the data shall be written to standard output. Leaving the default value, etruecolor task creates the following file name: PppppppooeeEPX000RGBIMA0000.PPM, where ppppppooee is the extended observation Id.
 
ascubenobooleanfalsefalse$\mid$true
Boolean parameter determining whether the red, green, and blue component images are to be written as three separate array extensions to the data set designated with colorset or as three slices of a single 3-dimensional data cube in the primary array.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30