dmcoords_lst - run dmcoords on a list of objects
dmcoords_lst [options] [input [output] ]
dmcoords_lst reads a list of source positions from an RDB table and runs them through dmcoords, outputting the original RDB table as well as the additional information specified by dmcoords. It requires an event file (passed to dmcoords) which contains WCS information.
By default it reads the input table from standard input, and writes the results to the standard output. Alternative input and output files may be specified either as extra arguments on the command line or via the --input and --output switches. An aspect solution can be specified via the --asolfile switch, in which case FID light corrections will be applied.
The names of the columns containing the coordinates to pass to
dmcoords are specified by the --x and --y options, which use
reasonable defaults. The coordinate system is specified by the
--type option, which defaults to sky. By default all of the
dmcoords output is included in the output file; to specify certain
fields only, see Output Field Specification.
In order to access dmcoords, dmcoords_lst sets up the CIAO
environment. If that environment has already been set up in the shell
from which dmcoords_lst is being invoked, one can avoid the
extra setup hit by specifying the --noinitenv option.
The output specification (the --spec option) is a comma separated list of fields, with a few special ones:
%allreturn all of the fields
%nonereturn none of the fields
polarThis is a shorthand for specifying the theta and phi fields
Fields may be specified in various levels of specificity. For example,
sky returns sky_x and sky_y, while sky_x returns
only sky_x. Other fields may be more complicated. cel returns
cel_deg_dec,
cel_deg_ra,
cel_hms_dec,
and
cel_hms_ra. To get only the celestial coordinates in degrees, use
cel%deg (note the % character used to separate multiple levels
of specificity). To figure out which fields are available, run dmcoords_lst
without any specification.
dmcoords_lst uses long-style options. Options which take values may be separated from the values by whitespace or the `=' character.
Normally, the input data are read from the standard input stream.
This option specifies an alternate source. Note that the input file
may also be specified as the first non-option argument on the command
line. The string stdin may be specified to select the standard
input stream.
Normally, the output data are written to the standard output stream
This option specifies an alternative place to write the output.
Note that the output file may also be specified on the command line
as the last non-option argument, but only if the input file is
specified as the first non-option argument. The string stdout
may be specified to select the standard output stream
This option, which isn't optional, specifies the event file from which dmcoords extracts WCS information.
This is an optional aspect solution (asol1 file), or stack of aspect solutions (filename must be preceded by '@'), to be applied to the call to dmcoords. If asolfile is specified then corrections for the drift of the FID lights will be applied. You may specify the method by which dmcoords determines the FID correction by the --method option below.
This option sets the method by which dmcoords is fed information
about the FID light offsets. It defaults to manual, meaning that the
FID light offsets are calculated and the 'sim/displace' parameter of
dmcoords is set manually. It may also be set to dmcoords, in which
case the aspect file is provided to dmcoords directly. The default
behavior may change, so specify this option to ensure consistency.
This is an optional GTI file which specifies the appropriate time ranges
for determining the FID light offsets. Only works if method is manual.
Note that this does not affect the time interval for which dmcoords
calculates positions.
The name of the column which contains the X coordinate. It defaults
to X.
The name of the column which contains the Y coordinate. It defaults
to Y.
The type of coordinate, i.e. celestial, detector pixel, etc. It may
be one of:
sky,
cel,
chip,
or
det.
tdet doesn't seem to be available in dmcoords interactive mode,
which is used by this program.
The type of celestial coordinates provided. It may be one of:
deg,
hms.
If celfmt is deg, RA and Dec coordinates are in degrees.
If celfmt is hms, RA and Dec coordinates are sexagesimal,
'hh:mm:ss.sss' for RA, '(+/-)dd:mm:ss.sss' for dec.
This specifies which items are to be retrieved from dmcoords. By default, everything is returned. See Output Field Specification for more information.
do not set up the ciaox environment.
Complain when requested fields are not found
output the version and exit
print abbreviated help and exit
print detailed usage instructions and exit
Diab Jerius ( djerius@cfa.harvard.edu )