Документ взят из кэша поисковой машины. Адрес оригинального документа : http://xmm.vilspa.esa.es/sas/5.4.1/doc/colimchain.ps.gz Дата изменения: Fri Jan 10 23:14:46 2003 Дата индексирования: Tue Oct 2 08:04:20 2012 Кодировка:

XMM-Newton Science Analysis System Page: 1
colimchain
January 10, 2003
Abstract
A script to make (optionally smoothed) image plots, colour coded to represent the
relative intensities in either two or three spectral bands.
1 Instruments/Modes
Instrument Mode
EPIC MOS: IMAGING
EPIC PN: IMAGING
2 Use
pipeline processing yes
interactive analysis yes
3 Description
colimchain is a perl script which is intended to facilitate the production of colour images from pipeline
products. The user supplies colimchain with the location of the products, the instrument and the
sequence of energy bands desired and colimchain does the rest. Smoothing via asmooth can be applied
if the parameter smooth is set. In this case each of the input images is smoothed using the same template
and mask, the smoothed images then being used as input to colimplot. If smoothing is not desired,
colimchain supplies colimplot with the raw images. However, if no smoothing is desired, there is not
much to be gained by using colimchain rather than colimplot directly.
A limited set of parameters from asmooth and colimplot have been provided. These are simply piped
through to the corresponding parameters of the respective tasks. The task documentation for these tasks
should be consulted for further description of the function of these parameters.
It is intended eventually to expand the task to accept OM images but this has not yet been done.
xmmsas 20030110 1802-5.4.1

XMM-Newton Science Analysis System Page: 2
4 Parameters
This section documents the parameters recognized by this task (if any).
Parameter Mand Type Default Constraints
ccfpath no string `'
Can be used to override SAS CCF.
prodsdir no string .
Directory where the input images are to be found.
clobbertemps no boolean no yes|no
'Yes' forces overwrite of colimchain output.
clobberprods no boolean no yes|no
'Yes' forces overwrite of colimchain output.
instrument no string `m1' `m1'|`m2'|`pn'
XMM instrument.
idtype no string `index' `index'|`full'
Species how the user wants to enter the observation and exposure information. If `index', the task looks
for the parameters obsindex and expindex; if `full', the task looks for the parameters obsid and expid.
obsindex no integer 0 obsindex> 0
Read by the task if idtype=`index'. If there is more than 1 observation in the indicated product direc-
tory, colimchain lists them internally in increasing order, and produces output only for that member of
the list indicated by this parameter. Note that the numbers start at 0.
expindex no integer 0 expindex> 0
Read by the task if idtype=`index'. If there is more than 1 exposure for the selected observation, colim-
chain lists them internally in increasing alphanumeric order, and produces output only for that member
of the list indicated by this parameter. Note that the numbers start at 0.
obsid no string
Read by the task if idtype=`full'. This is the 10-digit observation ID number.
expid no string
Read by the task if idtype=`full'. This is the 4-character exposure ID string: either S or U, followed by
a 3-digit number.
bandlist no integer
list
`2 3 4'
List of energy band numbers. These should be in increasing order.
smooth no boolean yes yes|no
'Yes' invokes asmooth to smooth the input images before they are supplied to colimplot.
maxsigma no real 20.0 pixels 0.0 < maxsigma <
20.0 pixels
asmooth parameter. The maximum allowed value of the width  of the smoothing gaussian is specied
xmmsas 20030110 1802-5.4.1

XMM-Newton Science Analysis System Page: 3
via this parameter.
desiredsnr no real 20.0 > 0
asmooth parameter. The maximum desired signal-to-noise ratio of the output image can be specied
via this parameter.
ngauss no integer 20 2 < ngauss < 100
If smoothtype='adaptive' is chosen, the maximum number of gaussian smoothing kernels is specied via
this parameter.
rebinimage no boolean no yes/no
colimplot parameter. Rebin the image to the specications dictated by the parameters dividexby and
divideyby or newnxbins and newnybins.
newnxbins no integer 100 10 < newnxbins <
1000
colimplot parameter. The number of x pixels in the rebinned image.
newnybins no integer 100 10 < newnybins <
1000
colimplot parameter. The number of y pixels in the rebinned image.
weirdness no real -0.85 1:0 < weirdness <
1:0
colimplot parameter. This parameter exerts control over the colour values of the plot. Values of
weirdness that approach -1 give output colours in the so-called `thermal' sequence, ie that are similar
to those acquired by heated black bodies; values that approach 1 give highly non-thermal colours such
as greens and violets.
heat no real 0.0 1:0 < heat < 1:0
colimplot parameter. This parameter exerts control over the colour values of the plot. Smaller values of
heat make all the pixels `cooler' in the thermal sequence of colours (ie redder); larger values in contrast
`heat up' the colour values, ie make them bluer.
heatspread no real 0.0 1:0 < heatspread <
1:0
This parameter exerts control over the colour values of the plot. Smaller values of heatspread pull all
the pixels in towards white, larger values spread them out more along the thermal sequence of colours.
cuto no real 0.05 0:0 < cutoff < 1:0
colimplot parameter. Pixels which have a total ux which is less than cutoff times the maximum total
ux are not included in calculations of the reference multiplet. The purpose of this is to prevent such
calculations being skewed by background values, which usually dominate an image in terms of numbers
of pixels involved.
gainstyle no string `auto' `auto'/`user'
colimplot parameter. If `auto', the gain is calculated such that the median image ux is scaled to about
a third of the output brightness range. If `user', the value given via the parameter gain is used.
gain no real 1.0 0:0 < satatfrac < 1:0
colimplot parameter. The image brightness is multiplied by this constant. Note it is only user-settable
when parameter gainstyle = `user'.
pgdev no string `/cps' none
xmmsas 20030110 1802-5.4.1

XMM-Newton Science Analysis System Page: 4
colimplot parameter. The pgplot device name.
expandtomask no boolean no yes/no
colimplot parameter. If a mask set is employed, this parameter can be set so as to expand the output
image until the unmasked part of it just lls the available area. The exposure map is frequently used as
a mask.
plotle no string `test.ps' none
colimplot parameter. If the pgplot device is one that requires an output le, this gives the name of the
le.
withframe no boolean no yes/no
If pgdev=`/ppm' and withframe=`yes', the task constructs a frame plot around the image, containing
various pieces of information such as the name of the observer and the target. This is written to a .gif
le named frame.gif, which can be combined with the output image by colimchain.
5 Errors
This section documents warnings and errors generated by this task (if any). Note that warnings and
errors can also be generated in the SAS infrastructure libraries, in which case they would not be docu-
mented here. Refer to the index of all errors and warnings available in the HTML version of the SAS
documentation.
(error)
There are no image les in the specied products directory for the specied instrument.
(error)
SAS CCF not set.
(error)
The products directory does not exist.
(error)
Not all the specied les could be found in the products directory.
(error)
Can't usefully run asmooth because there is no exposure map.
(warning)
Couldn't run asmooth because the output le exists and clobber not set.
corrective action: Proceeds
(warning)
Couldn't run colimplot because the output le exists and clobber not set.
corrective action: Proceeds
Note: The task does not at present use the error interface, but uses internal message, warning and error
functions. The warning and error labels are therefore not relevant and have been omitted.
xmmsas 20030110 1802-5.4.1

XMM-Newton Science Analysis System Page: 5
6 Input Files
1. 1 or more PCMS-product (uncompressed) ts images, from any of the three EPIC instru-
ments.
2. (Optional) PCMS-product (uncompressed) ts exposure map.
7 Output Files
One of the following:
1. An image in one of the PGPLOT le formats.
2. An image directly written in postscript.
3. An image directly written as a 3-plane FITS image.
4. An image directly written in ppm (Portable Pixel Map) format.
8 Algorithm
Read command-line parameters;
Construct the requisite filenames and check that they exist;
if (smooth) {
make template file;
for each (input file) {
invoke asmooth with the input file, the template file and the
exposure map as a mask file;
}
}
invoke colimplot;
9 Comments

References
xmmsas 20030110 1802-5.4.1