Parameter | Mand | Type | Default | Constraints |
srclisttab | yes | dataset list | ||
The list of input (optical) source-list FITS file tables
(in dataset name:table name format).
| ||||
maskset | no | dataset | optloadmask.ds | |
Filename of the output mask image dataset.
| ||||
templateset | yes | dataset | ||
This file should contain an image in the primary extension, which is used to define the pixel dimensions and World Coordinates of the output mask image.
| ||||
temporaryset | no | dataset | eoptloadmask_tmpimage.ds | |
Name of a temporary, internally-accessed dataset to hold the filtered source list. It is only of importance for pcms (or other parallel) calls of eoptloadmask
(or when the current working directory is not writable for the user).
| ||||
radiusstyle | no | string | fixed | fixed|column |
Specify how to give the radius or radii of the masked area for each (optical) source.
| ||||
radius | yes | real | 20 | 0radius |
Radius in arcsecond for masking the area around bright sources.
Mandatory if radiusstyle=fixed.
| ||||
colradius | no | string | RADIUS | |
Column name in the input FITS tables for the radius in arcsecond to mask.
This is only read if radiusstyle=column.
| ||||
colnamestyle | no | string | default | default|user |
If `default', `RA' and `DEC' are assumed to be the column name for the coordinates used in the input FITS tables. If `user', colra and coldec are read. If `file', colnamefile must be given.
| ||||
colra | yes | string list | ||
Column name list for the `RA' (Right Ascension) in the input FITS tables. The unit has to be in degree. The equinox and epoch of the coordinates must match those in the given source list (srclisttab).
| ||||
coldec | yes | string list | ||
Column name list for the `DEC' (Declination) in the input FITS tables. The unit has to be in degree. The equinox and epoch of the coordinates must match those in the given source list (srclisttab).
| ||||
withexpressions | no | boolean | no | |
Whether specify expression or not.
| ||||
expressions | no | string list | ||
A selection expression used to filter the source list. The selection expression should adhere to the selectlib
grammar and should contain as arguments only keywords and column names actually present in the source list table.
The list (as opposed to a single string) is allowed for this parameter, each of element of which corresponds to each input source-list; for that reason, spaces must be used only to separate the expressions among selection-expressions for the different source lists.
| ||||
withexpressions | no | boolean | no | |
Whether specify expression or not.
| ||||
isinverted | no | boolean | yes | yes|no |
If true, the pixels affected with optical-loading in the output mask file are zero, if not, one.
For the later use of the output mask file with dpssflag, isinverted=yes is more convenient (default).
| ||||
Parameter | Mand | Type | Default | Constraints |
XMM-Newton SOC -- 2023-04-16