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


xcolorcod (xcolorcod-1.30.1) [xmmsas_20211130_0941-20.0.0]

Parameters

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

In determining the actual color of a pixel via the color curves the value range of the scalar column ecolumn is mapped onto the color table's level column ($0\le level\le1$). The choice parameter ecolumnminmax selects one of three possible ways in which the dynamic value range $[min, max]$ of ecolumn is determined:
ParameterMand Type Default Constraints
tableyestable name of existing table
The table that contains the event data - need to at least contain the columns named with the xcolumn, ycolumn, ecolumn parameters.
 
colortablechoicenostringinternalinternal$\mid$external
Choice parameter determining source of the color table that is to be used for the color coding. The value internal signifies that an internal table is to be selected via the colortable parameter. external activates the colortableset parameter.
 
colortablenostringheatname of existing internal color table
If colortablechoice=internal the parameter signifies an internal color table that is the be used in the color-coding of the scalar event attribute. For a complete list of the available color tables invoke the task in dialog mode (xcolorcod -d) and select the choice widget labelled colortable.
 
colortablesetnodata set name of exisiting data set
If colortablechoice=external the name of an external data set representing a color table that is to be used in the color coding of the scalar event attribute. The format must adhere to the specifications above.
 
invertcolortablenobooleanfalsetrue$\mid$false
With this boolean parameter the color curves in the color table can be inverted, i.e., a component that is associated with the scalar value level is associated with 1-level in the inverted case.
 
xcolumnnocolumnXname of existing column in table
The name of the column that specifies the $x$ position of the event; passed to evselect as parameter xcolumn.
 
ycolumnnocolumnYname of existing column in table
The name of the column that specifies the y position of the event; passed to evselect as parameter ycolumn.
 
ecolumnnocolumnPIname of existing column in table
The name of the column that specifies the scalar event attribute that is to be color-coded; passed to evselect as parameter zcolumn.
 
ecolumnminmaxnostringactualminmax 
actualminmax$\mid$legalminmax$\mid$explicitminmax
 
actualminmax : from the data itself
legalminmax : from the minimum/maximum legal values of the column given as column attributes TLMIN/TLMAX
explicitminmax : by explicit parameters min and max
The ecolumn data value range $[min, max]$ will be linerly mapped onto the level range $[0, 1]$. minnoreal   Explicit minimum value of ecolumn column if ecolumnminmax=explicitminmax
  maxnoreal12000  Explicit maximum value of ecolumn column if ecolumnminmax=explicitminmax
  imagebinningnostringimageSizeimageSize$\mid$binSize passed to evselect as parameter imagebinning
  squarepixelsnobooleanfalsetrue$\mid$false passed to evselect as parameter squarepixels
  ximagesizenointeger600$>0$ passed to evselect as parameter ximagesize
  ximagebinsizenoreal1$>0$ passed to evselect as parameter ximagebinsize
  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
  yimagesizenointeger600$>0$ passed to evselect as parameter yimagesize
  yimagebinsizenoreal1$>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
  scalenostringloglog$\mid$lin Whether the intensity should be displayed linearly or logarithmically.
  decadesnoreal4.0$[-10, 20]$ Number of decades to be used if scale=log.
  outputchoicenostringdatasetdataset$\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.
  colorsetnostringcolimg.dsname 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.
  ppmfilenostringstdoutname 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.
  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