| Parameter | Mand | Type | Default | Constraints |
| withtable | yes | boolean | true | Whether to convert table in a dataset |
should be set to true if a table containing events to correct
has been specified and to false otherwise.
|
| table | yes | string | | name of existing table |
a specifier which must point to a table in
a data set.
It must be in either of the two forms setname:, or setname:tableid
where setname must be the name of an existing
data set and
tableid an identifier of a table in that data set.
If the first form, setname:, is used, the table data are sought in the
first block of the named data set.
|
| timecolumn | no | string | TIME | name of existing column |
the name of an existing column of type real64 in the table given via
the parameter table. The values in the column
are interpreted as XMM MET tags and corrected for earthbarycentric
propagation delays. Please note: This process is irreversible -
if the original time column is to be kept a copy of the data set
should be made a priori.
|
| withsrccoordinates | no | boolean | false | true|false |
The earthbarycentric correction algorithms needs the coordinates of the
celestial source. This boolean parameter determines from where these
are obtained. If set to false, the coordinates are attempted to
be read from the attributes RA_OBJ/DEC_OBJ in the table or the
associates set. If this fails, the attributes RA_NOM/DEC_NOM
are read instead. If this fails as well a fatal error condition is
raised. If withsrccoordinates is set to true, the user has to
provide the coordinates through the parameters srcra/srcdec.
|
| srcra/srcdec | no | string | | source coordinates |
If withsrccoordinates is set to true the coordinates of the celestial
source have to be specified through these parameters in the
equatorial, earth-centered J2000 reference frame. Recognized formats
are for srcra (Right Ascension)
- 123.45678 (decimal degrees)
and for srcdec (Declination)
- 123.45678 (decimal degrees)
|
| processgtis | no | boolean | true | true|false |
Boolean switch determining whether any present GTI tables should be
corrected as well or not. The parameter has no effect if the set does not
contain any GTI tables.
|
| processexposutables | no | boolean | true | true|false |
Boolean switch determining whether any present EXPOSU tables should be
corrected as well or not. The parameter has no effect if the set does not
contain any GTI tables.
|
| basetime | no | real | | |
Base time for MET frame
|
| time | no | real | | |
A single time tag in MET frame
on which to perform the earthbarycentric correction.
Only used if withtable is false.
|
| obslong | no | real | | |
The longitude (East positive) of earth-bound observer
|
| obslat | no | real | | |
Geodetic latitude of earth-bound observer
|
| obsalt | no | real | | |
Altitude above NN of earth-bound observer [m]
|
| ephemeris | no | string | DE200 | DE200|DE405 |
Name of an ASCII earth ephemeris file extension in the JPL format to be used
in lieu of a standard one. This file contains earthbarycentric vectors
needed by the TDB conversion algorithm.
|
| Parameter | Mand | Type | Default | Constraints |
