Документ взят из кэша поисковой машины. Адрес оригинального документа : http://xmm.vilspa.esa.es/sas/5.4.1/doc/colimplot/node13.html
Дата изменения: Fri Jan 10 22:47:44 2003
Дата индексирования: Sat Dec 22 11:26:57 2007
Кодировка:
Parameters XMM-Newton SAS Home Page
XMM-Newton Science Analysis System


colimplot (colimplot-3.6.1) [xmmsas_20030110_1802-5.4.1]

Masking Home Page Errors Home Index

Meta Index / Home Page

Parameters

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

ParameterMand Type Default Constraints
insetsyesdataset list`'none
List (in order of increasing hardness) of input image sets.
 
withmasknobooleanyesyes/no
If `yes', the task attempts to access or create a mask, depending on the setting of maskstyle. Parameters greylevel and expandtomask are also enabled by this switch.
 
maskstylenostring`self'self|user
If `self', the task attempts to create the mask by using the input images. If `user', the task looks for the name of the mask image set in the parameter maskset.
 
masksetnodataset`'none
The name of the mask set (usually an exposure map).
 
greylevelnoreal0.0 $0.0<\rm {greylevel}<1.0$
The grey level to paint those areas of the output image that fall outside the mask. Where the background level of the image is visible, the default value (= black) is preferable; however, in the case that large areas of the image fall outside the mask (but see also the parameter expandtomask), a value of 1.0 may be better, if only to save ink on printed output.
 
expandtomasknobooleanyesyes/no
When set, that part of the image where the mask is true is expanded until it just fits into the frame. This is to prevent large areas of non-mask and therefore blank image from being displayed.
 
rebinimagenobooleannoyes/no
Rebin the image to the specifications dictated by the parameters dividexby and divideyby or newnxbins and newnybins.
 
rebinstylenostringtonumbertonumber|divideby
This parameter controls the style in which the image rebinning occurs. If `tonumber', the parameters newnxbins and newnybins are read; if `divideby', the parameters dividexby and divideyby are read.
 
dividexbynoreal5.0 $1.0<\rm {dividexby}<50.0$
Divide the number of x pixels by this value, and convert to integer; the result is the number of x pixels in the rebinned image.
 
divideybynoreal5.0 $1.0<\rm {divideyby}<50.0$
Divide the number of y pixels by this value, and convert to integer; the result is the number of y pixels in the rebinned image.
 
newnxbinsnointeger100 $10<\rm {newnxbins}<1000$
The number of x pixels in the rebinned image.
 
newnybinsnointeger100 $10<\rm {newnybins}<1000$
The number of y pixels in the rebinned image.
 
negremovalstylenostringtruncatetruncate|offset
If negative values are detected in any of the input images, the task removes them by whichever of these two methods is specified.
 
refclrstylenostringinternalinternal|bb|none|user
Dictates the style in which the reference multiplet is calculated.
 
refclrnoreal list  
List of 3 RGB weights to use for reference colour.
 
internalrefstylenostringrmsrms|mean
If refclrstyle=`internal', this is read, and controls whether the reference multiplet is calculated from the root mean squared (rms) or the mean of all pixels which have a total flux above the cutoff value (see parameter cutoff).
 
cutoffnoreal0.05 $0.0<cutoff<1.0$
Pixels which have a total flux which is less than cutoff times the maximum total flux 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.
 
bbrefstylenostring`kev'`kev'/`angstroms'/`kelvin'
For refclrstyle=`bb', the value of the reference multiplet is set to the image multiplet that would have been observed from a black-body source with a given temperature. The different values possible to bbrefstyle just allow the user some flexibility in entering the temperature. For bbrefstyle=`kelvin' the temperature is entered directly in millions of degrees kelvin; for bbrefstyle=`kev' the peak of the BB curve is given in keV; whereas for bbrefstyle=`angstroms' the peak is given in angstroms. Note that these peak values refer to the peak of the BB spectrum as a function of energy or frequency, rather than wavelength.
 
whitekevnoreal2.0 $0.01<whitekev<20.0$
Enabled if refclrstyle=`bb' and bbrefstyle=`kev'. It is the energy of a photon at the peak of the reference black body spectrum.
 
whiteangstromsnoreal100.0 $0.01<whiteangstroms<8000.0$
Enabled if refclrstyle=`bb' and bbrefstyle=`angstroms'. It is the wavelength of a photon at the peak of the reference black body spectrum.
 
whitemegakelvinnoreal1.0 $0.01<whitemegakelvin<100.0$
Enabled if refclrstyle=`bb' and bbrefstyle=`kelvin'. It is the temperature of the reference black body spectrum.
 
weirdnessnoreal-0.7 $-1.0<\rm {weirdness}<1.0$
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.
 
heatnoreal0.0 $-1.0<\rm {heat}<1.0$
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.
 
heatspreadnoreal0.0 $-1.0<\rm {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.
 
nhotpixelsnointeger10 $0<\rm {nhotpixels}$
The image brightness is scaled so as to saturate the nhotpixels brightest pixels.
 
gainstylenostring`user'`user'/`auto'
If `user', a value of gain can be entered directly via the parameter gain. If gainstyle=`auto', the task attempts to calculate it such that the background is just bright enough to be visible.
 
gainnoreal8.0 $0.0<=\rm {gain}$
The value by which the net flux values should be multiplied before display.
 
pixelfractionnoreal0.5 $0.0<\rm {pixelfraction}<1.0$
For gainstyle=`auto', the task calculates the gain required to bring the maximum net flux fraction of the dimmest pixelfraction pixels to the value of tofluxfraction.
 
tofluxfractionnoreal0.4 $0.0<\rm {tofluxfraction}<1.0$
For gainstyle=`auto', the task calculates the gain required to bring the maximum net flux fraction of the dimmest pixelfraction pixels to the value of tofluxfraction.
 
rgbsysstylenostring`polar'`cartesian'/`polar'
This parameter controls whether the colour points are described in a RGB basis or in a brightness-saturation-hue basis when an 8-bit colour palette is shared out.
 
pgdevnostring`/cps'none
The pgplot device name.
 
plotfilenostring`test.ps'none
If the pgplot device is one that requires an output file, this gives the name of the file.
 
withframenobooleannoyes/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 file named frame.gif, which can be combined with the output image by colimchain.
 
ParameterMand Type Default Constraints


Masking Home Page Errors Home Index

XMM-Newton SOC/SSC -- 2003-01-10